openapi: 3.0.1
info:
  title: Getty Images
  version: "3"
  x-apisguru-categories:
    - media
  x-logo:
    url: http://developers.gettyimages.com/images/getty-api-logo.jpg
  x-origin:
    - format: openapi
      url: https://api.gettyimages.com/swagger/v3/swagger.json
      version: "3.0"
  x-providerName: gettyimages.com
security:
  - Api-Key: []
  - OAuth2: []
paths:
  /v3/affiliates/search/images:
    get:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Search images using a search phrase.
          in: query
          name: phrase
          schema:
            description: Search images using a search phrase.
            nullable: true
            type: string
        - description: Filter based on graphical style of the image.
          in: query
          name: style
          schema:
            $ref: "#/components/schemas/AffiliateSearchStyle"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AffiliateImageSearchResponse"
          description: Success
      summary: ""
      tags:
        - AffiliateSearch
  /v3/affiliates/search/videos:
    get:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - in: query
          name: phrase
          schema:
            nullable: true
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AffiliateVideoSearchResponse"
          description: Success
      tags:
        - AffiliateSearch
  /v3/artists/images:
    get:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Name of artist for desired images
          in: query
          name: artist_name
          schema:
            description: Name of artist for desired images
            nullable: true
            type: string
        - description: Comma separated list of fields. Allows restricting which fields are returned. If no fields are selected, the summary_set of fields are returned.
          explode: false
          in: query
          name: fields
          schema:
            description: Comma separated list of fields. Allows restricting which fields are returned. If no fields are selected, the summary_set of fields are returned.
            items:
              $ref: "#/components/schemas/ArtistsImageSearchFieldValues"
            nullable: true
            type: array
          style: form
        - description: Identifies page to return. Default page is 1.
          in: query
          name: page
          schema:
            default: 1
            description: Identifies page to return. Default page is 1.
            format: int32
            type: integer
        - description: Specifies page size. Default page_size is 10, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 10
            description: Specifies page size. Default page_size is 10, maximum page_size is 100.
            format: int32
            type: integer
      responses:
        "200":
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: Unauthorized
      summary: Search for images by a photographer
      tags:
        - Artists
  /v3/artists/videos:
    get:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Name of artist for desired images
          in: query
          name: artist_name
          schema:
            description: Name of artist for desired images
            nullable: true
            type: string
        - description: Comma separated list of fields. Allows restricting which fields are returned. If no fields are selected, the summary_set of fields are returned.
          explode: false
          in: query
          name: fields
          schema:
            description: Comma separated list of fields. Allows restricting which fields are returned. If no fields are selected, the summary_set of fields are returned.
            items:
              $ref: "#/components/schemas/ArtistsVideoSearchFieldValues"
            nullable: true
            type: array
          style: form
        - description: Identifies page to return. Default page is 1.
          in: query
          name: page
          schema:
            default: 1
            description: Identifies page to return. Default page is 1.
            format: int32
            type: integer
        - description: Specifies page size. Default page_size is 10, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 10
            description: Specifies page size. Default page_size is 10, maximum page_size is 100.
            format: int32
            type: integer
      responses:
        "200":
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: Unauthorized
      summary: Search for videos by a photographer
      tags:
        - Artists
  /v3/asset-changes/change-sets:
    put:
      description: |
        # Asset Changes

        Get notifications about new, updated or deleted assets for a specific channel.

        ##  Quickstart

        You'll need an API key and an access token to use this resource. 

        Maximum batch size is 2200.

        Change-sets must be confirmed before a new batch of notifications can be retrieved from this endpoint. Use the DELETE asset-changes/change-sets/{change-set-id} endpoint to confirm reciept of these notifications.

        Values returned for asset_type include Image, Film, and null. Values returned for asset_lifecycle include New, Update, and Delete.

        Delete notifications may be provided for asset ids that have not previously been received as New or Update notifications. Delete notifications may return null for the asset_type.

        If there are no notifications in the channel an empty response body will be returned.

        Notifications older than 60 days will be removed from partner channels.
      parameters:
        - description: Specifies the id of the channel for the asset data. Valid channel ids can be found in the results of the Get Partner Channel query.
          in: query
          name: channel_id
          schema:
            description: Specifies the id of the channel for the asset data. Valid channel ids can be found in the results of the Get Partner Channel query.
            format: int32
            type: integer
        - description: Specifies the number of assets to return. The default is 2200; maximum is 2200.
          in: query
          name: batch_size
          schema:
            description: Specifies the number of assets to return. The default is 2200; maximum is 2200.
            format: int32
            nullable: true
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AssetChanges"
          description: Success - Channel contains unconfirmed asset change notifications
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AssetChanges"
          description: Created
        "400":
          description: InvalidChannelIdException
        "403":
          description: Your access token does not authorize access to this resource
        "404":
          description: The channel you specified does not exist
      summary: Get asset change notifications.
      tags:
        - AssetChanges
  "/v3/asset-changes/change-sets/{change-set-id}":
    delete:
      description: |
        # Delete Asset Changes

        Confirm asset changes acknowledges receipt of asset changes (from the PUT asset-changes endpoint).

        ##  Quickstart

        You'll need an API key and an access token to use this resource.

        Use the change_set_id from the PUT asset-changes/change-sets endpoint to confirm receipt of notifications.
      parameters:
        - description: Specify the change-set-id associated with a transaction resource whose receipt you want to confirm.
          in: path
          name: change-set-id
          required: true
          schema:
            description: Specify the change-set-id associated with a transaction resource whose receipt you want to confirm.
            format: int64
            type: integer
      responses:
        "200":
          description: Success
        "400":
          description: InvalidChangeSetId
        "403":
          description: Your access token does not authorize access to this resource
        "404":
          description: Transaction was not found
      summary: Confirm asset change notifications.
      tags:
        - AssetChanges
  /v3/asset-changes/channels:
    get:
      description: |+
        # Get Partner Channels

        Retrieves the channel data for the partner. This data can be used to populate the channel_id parameter in the Put Asset Changes query.

        ##  Quickstart

        You'll need an API key and an access token to use this resource.

        Partners who have a channel that has been removed should contact their sales representative to be set up again.

      responses:
        "200":
          content:
            application/json:
              schema:
                items:
                  $ref: "#/components/schemas/Channel"
                type: array
          description: Success
        "403":
          description: UnauthorizedToAccessResource
        "404":
          description: ChannelsNotFound
      summary: Get a list of asset change notification channels.
      tags:
        - AssetChanges
  "/v3/asset-licensing/{assetId}":
    post:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Getty Images assetId - examples 520621493, 112301284
          in: path
          name: assetId
          required: true
          schema:
            description: Getty Images assetId - examples 520621493, 112301284
            nullable: true
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AcquireAssetLicensesRequest"
        description: "Structure that specifies an array of LicenseTypes (multiseat, unlimited, resale, indemnification) to acquire,\r

          \            and whether or not to use Team Credits. Authenticated User must have access to Team Credits if UseTeamCredits is set to \"true\"."
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AssetLicensingResponse"
          description: Success
        "400":
          description: InvalidRequestParameters
        "401":
          description: AuthorizationTokenRequired
        "402":
          description: NotEnoughCreditsForPurchase
        "404":
          description: StandardLicenseNotFound
      summary: Endpoint for acquiring extended licenses with iStock credits for an asset.
      tags:
        - AssetLicensing
  /v3/asset-management/assets/send-events:
    get:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: "Specifies a date/time (with timezone information) for continuing retrieval of events.\r

            Events occuring _after_ the `last_offset` value provided will be returned."
          in: query
          name: last_offset
          schema:
            description: "Specifies a date/time (with timezone information) for continuing retrieval of events.\r

              Events occuring _after_ the `last_offset` value provided will be returned."
            format: date-time
            nullable: true
            type: string
        - description: Specifies the number of events to return. Default is 50, maximum value is 100.
          in: query
          name: event_count
          schema:
            description: Specifies the number of events to return. Default is 50, maximum value is 100.
            format: int32
            nullable: true
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetSendEventsResponse"
            text/json:
              schema:
                $ref: "#/components/schemas/GetSendEventsResponse"
            text/plain:
              schema:
                $ref: "#/components/schemas/GetSendEventsResponse"
          description: Success
        "400":
          description: EventCountOutOfRange
      tags:
        - AssetManagement
  /v3/boards:
    get:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Request results starting at a page number (default is 1).
          in: query
          name: page
          schema:
            default: 1
            description: Request results starting at a page number (default is 1).
            format: int32
            type: integer
        - description: Search for boards the user owns or has been invited to as an editor.
          in: query
          name: board_relationship
          schema:
            $ref: "#/components/schemas/BoardRelationship"
        - description: Sort the list of boards by last update date or name. Defaults to date_last_updated_descending.
          in: query
          name: sort_order
          schema:
            $ref: "#/components/schemas/BoardSortOrder"
        - description: Request number of boards to return in each page. (default is 30).
          in: query
          name: pageSize
          schema:
            default: 30
            description: Request number of boards to return in each page. (default is 30).
            format: int32
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BoardList"
          description: Success
        "400":
          description: InvalidParameterValue
        "401":
          description: Unauthorized
      summary: Get all boards that the user participates in
      tags:
        - Boards
    post:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BoardInfo"
        description: Specify a name and description of the board to create (name is required).
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BoardCreated"
          description: Created
        "400":
          description: InvalidParameterValue
        "401":
          description: Unauthorized
      summary: Create a new board
      tags:
        - Boards
  "/v3/boards/{board_id}":
    delete:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Specify the board to delete.
          in: path
          name: board_id
          required: true
          schema:
            description: Specify the board to delete.
            nullable: true
            type: string
      responses:
        "200":
          description: Success
        "204":
          description: ""
        "400":
          description: InvalidParameterValue
        "401":
          description: Unauthorized
        "403":
          description: InsufficientAccess
        "404":
          description: BoardNotFound
      summary: Delete a board
      tags:
        - Boards
    get:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Retrieve details for a specific board.
          in: path
          name: board_id
          required: true
          schema:
            description: Retrieve details for a specific board.
            nullable: true
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BoardDetail"
          description: Success
        "400":
          description: InvalidParameterValue
        "401":
          description: Unauthorized
        "404":
          description: BoardNotFound
      summary: Get assets and metadata for a specific board
      tags:
        - Boards
    put:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Specify the board to update.
          in: path
          name: board_id
          required: true
          schema:
            description: Specify the board to update.
            nullable: true
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BoardInfo"
        description: Specify a new name and description for the board (name is required).
      responses:
        "200":
          description: Success
        "204":
          description: Updated
        "400":
          description: InvalidParameterValue
        "401":
          description: Unauthorized
        "403":
          description: InsufficientAccess
        "404":
          description: BoardNotFound
      summary: Update a board
      tags:
        - Boards
  "/v3/boards/{board_id}/assets":
    delete:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Specify the board to remove assets from.
          in: path
          name: board_id
          required: true
          schema:
            description: Specify the board to remove assets from.
            nullable: true
            type: string
        - description: List the assets to be removed from the board.
          in: query
          name: asset_ids
          schema:
            description: List the assets to be removed from the board.
            items:
              type: string
            nullable: true
            type: array
      responses:
        "200":
          description: Success
        "400":
          description: InvalidParameterValue
        "401":
          description: Unauthorized
        "403":
          description: InsufficientAccess
        "404":
          description: BoardNotFound
      summary: Remove assets from a board
      tags:
        - Boards
    put:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Specify the board to add assets to.
          in: path
          name: board_id
          required: true
          schema:
            description: Specify the board to add assets to.
            nullable: true
            type: string
      requestBody:
        content:
          application/json:
            schema:
              description: List assets to add to the board.
              items:
                $ref: "#/components/schemas/BoardAsset"
              nullable: true
              type: array
        description: List assets to add to the board.
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AddBoardAssetsResult"
          description: Created
        "400":
          description: InvalidParameterValue
        "401":
          description: Unauthorized
        "403":
          description: InsufficientAccess
        "404":
          description: BoardNotFound
      summary: Add assets to a board
      tags:
        - Boards
  "/v3/boards/{board_id}/assets/{asset_id}":
    delete:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Specify the board to remove an asset from.
          in: path
          name: board_id
          required: true
          schema:
            description: Specify the board to remove an asset from.
            nullable: true
            type: string
        - description: Specify the asset to remove from the board.
          in: path
          name: asset_id
          required: true
          schema:
            description: Specify the asset to remove from the board.
            nullable: true
            type: string
      responses:
        "200":
          description: Success
        "400":
          description: InvalidParameterValue
        "401":
          description: Unauthorized
        "403":
          description: InsufficientAccess
        "404":
          description: BoardNotFound
      summary: Remove an asset from a board
      tags:
        - Boards
    put:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Specify the board to add an asset to.
          in: path
          name: board_id
          required: true
          schema:
            description: Specify the board to add an asset to.
            nullable: true
            type: string
        - description: Specify the asset to add to the board. If it is already in the board's asset collection, no action is taken.
          in: path
          name: asset_id
          required: true
          schema:
            description: Specify the asset to add to the board. If it is already in the board's asset collection, no action is taken.
            nullable: true
            type: string
      responses:
        "201":
          description: Created
        "400":
          description: InvalidParameterValue
        "401":
          description: Unauthorized
        "403":
          description: AssetNotFound
        "404":
          description: BoardNotFound
      summary: Add an asset to a board
      tags:
        - Boards
  "/v3/boards/{board_id}/comments":
    get:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Specify the board to retrieve comments from.
          in: path
          name: board_id
          required: true
          schema:
            description: Specify the board to retrieve comments from.
            nullable: true
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommentsList"
          description: Success
        "400":
          description: InvalidParameterValue
        "401":
          description: Unauthorized
        "404":
          description: BoardNotFound
      summary: Get comments from a board
      tags:
        - Boards
    post:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Specify the board to add a comment to.
          in: path
          name: board_id
          required: true
          schema:
            description: Specify the board to add a comment to.
            nullable: true
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CommentRequest"
        description: Comment to be added to the board.
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CommentCreated"
          description: Created
        "400":
          description: InvalidParameterValue
        "401":
          description: Unauthorized
        "403":
          description: InsufficientAccess
        "404":
          description: BoardNotFound
      summary: Add a comment to a board
      tags:
        - Boards
  "/v3/boards/{board_id}/comments/{comment_id}":
    delete:
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Specify the board containing the comment to delete.
          in: path
          name: board_id
          required: true
          schema:
            description: Specify the board containing the comment to delete.
            nullable: true
            type: string
        - description: Specify the comment to delete.
          in: path
          name: comment_id
          required: true
          schema:
            description: Specify the comment to delete.
            nullable: true
            type: string
      responses:
        "200":
          description: Success
        "204":
          description: CommentDeleted
        "400":
          description: InvalidParameterValue
        "401":
          description: Unauthorized
        "403":
          description: InsufficientAccess
        "404":
          description: BoardNotFound
      summary: Delete a comment from a board
      tags:
        - Boards
  /v3/collections:
    get:
      description: |
        Use this endpoint to retrieve collections associated with your Getty Images account. To browse available collections see our [Image collections page]( http://www.gettyimages.com/creative-images/collections).

        You'll need an API key and access token to use this resource.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CollectionsList"
          description: OK
        "401":
          description: Unauthorized
      summary: Gets collections applicable for the customer.
      tags:
        - Collections
  /v3/countries:
    get:
      description: |
        Returns a list of country objects that contains country name, two letter ISO abbreviation and three letter ISO abbreviation.

        You'll need an API key and access token to use this resource.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CountriesList"
          description: OK
        "401":
          description: Unauthorized
      summary: Gets countries codes and names.
      tags:
        - Countries
  /v3/customers/current:
    get:
      description: |
        Returns the first, middle and last name of the authenticated user.

        You'll need an API key and access token to use this resource.
        	
        Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CustomerInfoResponse"
          description: OK
        "400":
          description: InvalidRequestParameters
        "401":
          description: Unauthorized
        "503":
          description: ServiceUnavailable
      summary: Returns information about the current user.
      tags:
        - Customers
  /v3/downloads:
    get:
      description: |
        Returns information about a customer's previously downloaded assets.

        You'll need an API key and access token to use this resource.
         
        	
        This endpoint requires being a Getty Images customer to limit your results to only assets that you have a license to use, 
        you need to also include an authorization token in the header of your request. 
        Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: "If specified, selects assets downloaded on or after this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD). \r

            Any hour, minute, second values in the request are not used, unless useTimePart parameter is included.\r

            Date/times in the response are UTC. Default is 30 days prior to date_to"
          in: query
          name: date_from
          schema:
            description: "If specified, selects assets downloaded on or after this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD). \r

              Any hour, minute, second values in the request are not used, unless useTimePart parameter is included.\r

              Date/times in the response are UTC. Default is 30 days prior to date_to"
            format: date-time
            nullable: true
            type: string
        - description: "If specified, selects assets downloaded on or before this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD)\r

            Any hour, minute, second values in the request are not used, unless useTimePart parameter is included.\r

            Date/times in the response are UTC. Default is current date or 30 days after specified start date, whichever one is earlier."
          in: query
          name: date_to
          schema:
            description: "If specified, selects assets downloaded on or before this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD)\r

              Any hour, minute, second values in the request are not used, unless useTimePart parameter is included.\r

              Date/times in the response are UTC. Default is current date or 30 days after specified start date, whichever one is earlier."
            format: date-time
            nullable: true
            type: string
        - description: "If specified, time values provided with date_to or date_from will be used. Time values should be appended to the date value in ISO 8601 format\r

            i.e.: 2019-09-19T19:30:37 or 2019-09-19 19:30:37.  Time zone can be specified as optional.\r

            Default value is false"
          in: query
          name: use_time
          schema:
            default: false
            description: "If specified, time values provided with date_to or date_from will be used. Time values should be appended to the date value in ISO 8601 format\r

              i.e.: 2019-09-19T19:30:37 or 2019-09-19 19:30:37.  Time zone can be specified as optional.\r

              Default value is false"
            type: boolean
        - description: Identifies page to return. Default is 1.
          in: query
          name: page
          schema:
            default: 1
            description: Identifies page to return. Default is 1.
            format: int32
            type: integer
        - description: Specifies page size. Default is 30, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 30
            description: Specifies page size. Default is 30, maximum page_size is 100.
            format: int32
            type: integer
        - description: Specifies product type to be included in the previous download results. Product types easyaccess, editorialsubscription, imagepack, and premiumaccess are for GettyImages API keys. Product types royaltyfreesubscription and creditpack are for iStock API keys. To get previous iStockPhoto credit downloads, creditpack must be selected.
          in: query
          name: product_type
          schema:
            $ref: "#/components/schemas/ProductTypeForDownloads"
        - description: If specified, returns the list of previously downloaded images for all users in your company. Your account must be enabled for this functionality. Contact your Getty Images account rep for more information. Default is false.
          in: query
          name: company_downloads
          schema:
            default: false
            description: If specified, returns the list of previously downloaded images for all users in your company. Your account must be enabled for this functionality. Contact your Getty Images account rep for more information. Default is false.
            type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/GetDownloadsResponse"
          description: OK
        "400":
          description: Bad request
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: Forbidden
      summary: Returns information about a customer's downloaded assets.
      tags:
        - Downloads
  "/v3/downloads/images/{id}":
    post:
      description: |
        Use this endpoint to generate download URLs and related data for images you are authorized to download.

        Most product offerings have enforced periodic download limits such as monthly, weekly, and daily. When this operation executes, the count of allowed downloads is decremented by one for the product offering. Once the download limit is reached for a given product offering, no further downloads may be requested for that product offering until the next download period.

        The download limit for a given download period is covered in your product agreement established with Getty Images.

        You'll need an API key and a [Resource Owner Grant or Implicit Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource.

        ## Auto Downloads
        The `auto_download` request query parameter specifies whether to automatically download the image.

        If the `auto_download` request query parameter is set to _true_, the API will return an HTTP status code 303 *See Other*. Your client code will need to process this response and redirect to the URI specified in the *Location* header to enable you to automatically download the file. The redirection workflow follows the [HTTP 1.1 protocol](https://tools.ietf.org/html/rfc7231#section-6.4.4).

        Client Request:

        ```
        https://api.gettyimages.com/v3/downloads/images/[asset_id]?auto_download=true
        ```

        Server Response:

        Your client code should follow redirect (3xx) status codes returned from the URI in the response Location header. More information here: [HTTP 1.1 protocol](https://tools.ietf.org/html/rfc7231#section-6.4).

        ```
        HTTP/1.1 303 See Other
        Location: https://delivery.gettyimages.com/...
        ```

        If the `auto_download` request query parameter is set to false, the API will return a HTTP status code 200, along with the URI in the response body which can be used to download the image. 

        Client Request:

        ```
        https://api.gettyimages.com/v3/downloads/images/[asset_id]?auto_download=false
        ```

        Server Response:

        ```
        HTTP/1.1 200 OK
        {
        	"uri": "https://delivery.gettyimages.com/..."
        }
        ```
        ## Downloading Via the Returned URI

        Your client code should follow redirect (3xx) status codes returned from the URI in the response. More information here: [HTTP 1.1 protocol](https://tools.ietf.org/html/rfc7231#section-6.4).

        The URI returned by this call should be considered opaque and the format could change at any time.
        In order to get the filename, length or file type, the response headers must be inspected. An example
        response follows:

        ```
        content-length: 33959979
        content-type: image/jpeg
        content-disposition: attachment; filename=GettyImages-1167612765.jpg
        ```

        The `content-disposition` header must be parsed to get a usable filename.

        ## Download URI expiration

        Download URIs are _**only valid for 24 hours**_, starting from the moment they are returned from this call.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: "<remarks>\r

            \                    Id of image to download.\r

            \                </remarks>"
          in: path
          name: id
          required: true
          schema:
            description: "<remarks>\r

              \                    Id of image to download.\r

              \                </remarks>"
            nullable: true
            type: string
        - description: "<remarks>\r

            \                    Specifies whether to auto-download the image. If true is specified, a 303 SeeOther status is returned with a\r

            \                    Location header set to the location of the image.\r

            \                    If false is specified, the download URI will be returned in the response message. Default is true.\r

            \                </remarks>"
          in: query
          name: auto_download
          schema:
            default: true
            description: "<remarks>\r

              \                    Specifies whether to auto-download the image. If true is specified, a 303 SeeOther status is returned with a\r

              \                    Location header set to the location of the image.\r

              \                    If false is specified, the download URI will be returned in the response message. Default is true.\r

              \                </remarks>"
            type: boolean
        - description: "<remarks>\r

            \                    File Type expressed with three character file extension.\r

            \                </remarks>"
          in: query
          name: file_type
          schema:
            $ref: "#/components/schemas/DownloadFileType"
        - description: "<remarks>\r

            \                    Specifies the pixel height of the particular image to download.\r

            \                    Available heights can be found in the images/{ids} response for the specific image.\r

            \                    If left blank, it will return the largest available size.\r

            \                </remarks>"
          in: query
          name: height
          schema:
            description: "<remarks>\r

              \                    Specifies the pixel height of the particular image to download.\r

              \                    Available heights can be found in the images/{ids} response for the specific image.\r

              \                    If left blank, it will return the largest available size.\r

              \                </remarks>"
            nullable: true
            type: string
        - description: "<remarks>\r

            \                    Identifier of the instance for the selected product offering type.\r

            \                </remarks>"
          in: query
          name: product_id
          schema:
            description: "<remarks>\r

              \                    Identifier of the instance for the selected product offering type.\r

              \                </remarks>"
            format: int32
            nullable: true
            type: integer
        - description: "<remarks>\r

            \                    Product types easyaccess, editorialsubscription, imagepack, and premiumaccess are for GettyImages API keys. Product types royaltyfreesubscription and creditpack are for iStock API keys. Default product type for iStock API keys is creditpack.\r

            \                </remarks>"
          in: query
          name: product_type
          schema:
            $ref: "#/components/schemas/ProductTypeForDownloads"
        - description: Specifies whether to download the image with iStock Team Credits. Only applicable to iStock API keys authenticated with a user that has Team Credits. Blank is the same as False.
          in: query
          name: use_team_credits
          schema:
            default: false
            description: Specifies whether to download the image with iStock Team Credits. Only applicable to iStock API keys authenticated with a user that has Team Credits. Blank is the same as False.
            nullable: true
            type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PremiumAccessDownloadData"
        description: "<remarks>\r

          \                    Additional information required from specific customers when downloading. \r

          \                    Only users who have been set up with a project code by Getty Images Sales need to use this field.\r

          \                </remarks>"
      responses:
        "200":
          description: OK
        "303":
          description: See Other
        "400":
          description: MissingRequiredQueryParameters
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: OverageLimitReached
        "404":
          description: ImageNotFound
      summary: Download an image
      tags:
        - Downloads
  "/v3/downloads/videos/{id}":
    post:
      description: |
        Use this endpoint to generate download URLs and related data for videos you are authorized to download.

        Most product offerings have enforced periodic download limits such as monthly, weekly, and daily. When this operation executes, the count of allowed downloads is decremented by one for the product offering. Once the download limit is reached for a given product offering, no further downloads may be requested for that product offering until the next download period.

        The download limit for a given download period is covered in your product agreement established with Getty Images.

        You'll need an API key and a [Resource Owner Grant or Implicit Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource.

        ## Auto Downloads
        The `auto_download` request query parameter specifies whether to automatically download the video.

        If the `auto_download` request query parameter is set to _true_, the API will return an HTTP status code 303 *See Other*. Your client code will need to process this response and redirect to the URI specified in the *Location* header to enable you to automatically download the file. The redirection workflow follows the [HTTP 1.1 protocol](https://tools.ietf.org/html/rfc7231#section-6.4.4).

        Client Request:

        ```
        https://api.gettyimages.com/v3/downloads/videos/[asset_id]?auto_download=true
        ```

        Server Response:

        Your client code should follow redirect (3xx) status codes returned from the URI in the response Location header. More information here: [HTTP 1.1 protocol](https://tools.ietf.org/html/rfc7231#section-6.4).

        ```
        HTTP/1.1 303 See Other
        Location: https://delivery.gettyimages.com/...
        ```

        If the `auto_download` request query parameter is set to false, the API will return a HTTP status code 200, along with the URI in the response body which can be used to download the video. 

        Client Request:

        ```
        https://api.gettyimages.com/v3/downloads/videos/[asset_id]?auto_download=false
        ```

        Server Response:

        ```
        HTTP/1.1 200 OK
        {
        	"uri": "https://delivery.gettyimages.com/..."
        }
        ```

        ## Downloading Via the Returned URI

        Your client code should follow redirect (3xx) status codes returned from the URI in the response. More information here: [HTTP 1.1 protocol](https://tools.ietf.org/html/rfc7231#section-6.4).

        The URI returned by this call should be considered opaque and the format could change at any time.
        In order to get the filename, length or file type, the response headers must be inspected. An example
        response follows:

        ```
        content-length: 283925783
        content-type: video/quicktime
        content-disposition: attachment; filename=GettyImages-690773579.mov
        ```

        The `content-disposition` header must be parsed to get a usable filename.

        ## Download URI expiration

        Download URIs are _**only valid for 24 hours**_, starting from the moment they are returned from this call.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: "<remarks>\r

            \                    Id of video to download.\r

            \                </remarks>"
          in: path
          name: id
          required: true
          schema:
            description: "<remarks>\r

              \                    Id of video to download.\r

              \                </remarks>"
            nullable: true
            type: string
        - description: "<remarks>\r

            \                    Specifies whether to auto-download the video. If true is specified, a 303 SeeOther status is returned with a\r

            \                    Location header set to the location of the video.\r

            \                    If false is specified, the download URI will be returned in the response message. Default is false.\r

            \                </remarks>"
          in: query
          name: auto_download
          schema:
            default: false
            description: "<remarks>\r

              \                    Specifies whether to auto-download the video. If true is specified, a 303 SeeOther status is returned with a\r

              \                    Location header set to the location of the video.\r

              \                    If false is specified, the download URI will be returned in the response message. Default is false.\r

              \                </remarks>"
            type: boolean
        - description: Specifies the size to be downloaded.
          in: query
          name: size
          schema:
            description: Specifies the size to be downloaded.
            nullable: true
            type: string
        - description: "<remarks>\r

            \                    Identifier of the instance for the selected product offering type.\r

            \                </remarks>"
          in: query
          name: product_id
          schema:
            description: "<remarks>\r

              \                    Identifier of the instance for the selected product offering type.\r

              \                </remarks>"
            format: int32
            nullable: true
            type: integer
        - description: "<remarks>\r

            \                    Product types easyaccess, editorialsubscription, imagepack, and premiumaccess are for GettyImages API keys. Product types royaltyfreesubscription and creditpack are for iStock API keys. Default product type for iStock API keys is creditpack.\r

            \                </remarks>"
          in: query
          name: product_type
          schema:
            $ref: "#/components/schemas/ProductTypeForDownloads"
        - description: Specifies whether to download the image with iStock Team Credits. Only applicable to iStock API keys authenticated with a user that has Team Credits. Blank is the same as False.
          in: query
          name: use_team_credits
          schema:
            description: Specifies whether to download the image with iStock Team Credits. Only applicable to iStock API keys authenticated with a user that has Team Credits. Blank is the same as False.
            nullable: true
            type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PremiumAccessDownloadData"
        description: "<remarks>\r

          \                    Additional information required from specific customers when downloading. \r

          \                    Only users who have been set up with a project code by Getty Images Sales need to use this field.\r

          \                </remarks>"
      responses:
        "200":
          description: OK
        "303":
          description: See Other
        "400":
          description: MissingRequiredQueryParameters
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: OverageLimitReached
        "404":
          description: VideoNotFound
      summary: Download a video
      tags:
        - Downloads
  /v3/events:
    get:
      description: |
        This endpoint returns the detailed event metadata for all specified events. Getty Images news, sports and entertainment photographers and
        videographers cover editorially relevant events occurring around the world.  All images or video clips produced in association with 
        an event, are assigned the same EventID. EventIDs are part of the meta-data returned in SearchForImages Results. Only content 
        produced under a Getty Images brand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) 
        will be consistently assigned an EventID. The Event framework may also be used to group similar content, such as 
        "Hats from the Royal Wedding" or "Odd-ballOffbeat images of the week". 

        You'll need an API key and access token to use this resource.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: A comma separated list of event ids.
          explode: false
          in: query
          name: ids
          schema:
            description: A comma separated list of event ids.
            items:
              format: int32
              type: integer
            nullable: true
            type: array
          style: form
        - description: A comma separated list of fields to return in the response.
          explode: false
          in: query
          name: fields
          schema:
            description: A comma separated list of fields to return in the response.
            items:
              $ref: "#/components/schemas/EventDetailFieldValues"
            nullable: true
            type: array
          style: form
      responses:
        "200":
          description: OK
        "400":
          description: InvalidRequestParameters
        "401":
          description: Unauthorized
        "404":
          description: EventNotFound
      summary: Get metadata for multiple events
      tags:
        - Events
  "/v3/events/{id}":
    get:
      description: |
        This endpoint returns the detailed event metadata for a specified event. Getty Images news, sports and entertainment 
        photographers and videographers cover editorially relevant events occurring around the world.  
        All images or video clips produced in association with an event, are assigned the same EventID. 
        EventIDs are part of the meta-data returned in SearchForImages Results. Only content produced under a Getty Images 
        brand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) will be 
        consistently assigned an EventID. The Event framework may also be used to group similar content, such as 
        "Hats from the Royal Wedding" or "Odd-ballOffbeat images of the week". 

        You'll need an API key and access token to use this resource.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: An event id.
          in: path
          name: id
          required: true
          schema:
            description: An event id.
            format: int32
            type: integer
        - description: A comma separated list of fields to return in the response.
          explode: false
          in: query
          name: fields
          schema:
            description: A comma separated list of fields to return in the response.
            items:
              $ref: "#/components/schemas/EventDetailFieldValues"
            nullable: true
            type: array
          style: form
      responses:
        "200":
          description: OK
        "400":
          description: InvalidRequestParameters
        "401":
          description: Unauthorized
        "404":
          description: EventNotFound
      summary: Get metadata for a single event
      tags:
        - Events
  /v3/images:
    get:
      description: |
        This endpoint returns the detailed image metadata for all specified images.

        You'll need an API key and access token to use this resource.

        ## Working with Fields Sets

        Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:

        #### Summary Fields Set

        The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build 
        search response results. The following fields are provided for every image in your result set when you include **summary_set** in your request.

        ```
        {
            "images":
            [
                "artist",
                "asset_family",
                "caption",
                "collection_code",
                "collection_id",
                "collection_name",
                "license_model",
                "max_dimensions",
                "title"
            ]
        }
        ```

        #### Detail Fields Set

        The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a 
        detailed view of images. The following fields are provided for every image in your result set when you include **detail_set** in your request.

        ```
        {
            "images":
            [
                "allowed_use",
                "artist", 
                "artist_title", 
                "asset_family",
                "call_for_image",
                "caption", 
                "city",
                "collection_code",
                "collection_id", 
                "collection_name",
                "color_type", 
                "copyright", 
                "country", 
                "credit_line", 
                "date_created", 
                "date_submitted",
                "download_sizes", 
                "editorial_segments",
                "event_ids",
                "graphical_style",
                "license_model",
                "max_dimensions",
                "orientation",
                "product_types",
                "quality_rank",
                "referral_destinations",
                "state_province", 
                "title"
            ]
        }
        ```

        #### Display Fields Set

        The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution
        files that are most frequently used to build a UI displaying search results. The following fields are provided for every image 
        in your result set when you include **display_set** in your request.

        The URI provided is subject to change at any time and must be used as-is with no modification.

        ```
        {
            "images":
            [
                "display_sizes": 
                [
                    {
                        "is_watermarked": <boolean>,
                        "name": "comp",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "preview",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "thumb",
                        "uri": "<link>"
                    }
                ]
            ]
        }
        ```

        ## Request Usage Considerations

        - Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Specifies one or more image ids to return. Use comma delimiter when requesting multiple ids.  Maximum of 100 ids.
          explode: false
          in: query
          name: ids
          schema:
            description: Specifies one or more image ids to return. Use comma delimiter when requesting multiple ids.  Maximum of 100 ids.
            items:
              type: string
            nullable: true
            type: array
          style: form
        - description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
          explode: false
          in: query
          name: fields
          schema:
            description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
            items:
              $ref: "#/components/schemas/ImageDetailFieldValues"
            nullable: true
            type: array
          style: form
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ImagesDetailResults"
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
        "404":
          description: ImageNotFound
        "500":
          description: InvalidIStockCollection
      summary: Get metadata for multiple images by supplying multiple image ids
      tags:
        - Images
  "/v3/images/{id}":
    get:
      description: |-
        This endpoint returns the detailed image metadata for a specified image.

        You'll need an API key and access token to use this resource. 
         
        ## Working with Fields Sets

        Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:

        #### Summary Fields Set

        The **summary_set** query string parameter fields value represents a small batch of metadata fields that
        are often used to build search response results. The following fields are provided for every image in your
        result set when you include **summary_set** in your request.

        ```
        {
            "images":
            [
                "artist",
                "asset_family",
                "caption",
                "collection_code",
                "collection_id",
                "collection_name",
                "license_model",
                "max_dimensions",
                "title"
            ]
        }
        ```

        #### Detail Fields Set

        The **detail_set** query string parameter fields value represents a large batch of metadata fields that are 
        often used to build a detailed view of images. The following fields are provided for every image in your 
        result set when you include **detail_set** in your request.

        ```
        {
            "images":
            [
                "allowed_use",
                "artist", 
                "artist_title", 
                "asset_family",
                "call_for_image",
                "caption", 
                "city",
                "collection_code",
                "collection_id", 
                "collection_name",
                "color_type", 
                "copyright", 
                "country", 
                "credit_line", 
                "date_created", 
                "date_submitted",
                "download_sizes", 
                "editorial_segments",
                "event_ids",
                "graphical_style",
                "license_model",
                "max_dimensions",
                "orientation",
                "product_types",
                "quality_rank",
                "referral_destinations",
                "state_province", 
                "title"
            ]
        }
        ```

        #### Display Fields Set

        The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low
        resolution files that are most frequently used to build a UI displaying search results. The following fields are provided
        for every image in your result set when you include **display_set** in your request.

        The URI provided is subject to change at any time and must be used as-is with no modification.

        ```
        {
            "images":
            [
                "display_sizes": 
                [
                    {
                        "is_watermarked": <boolean>,
                        "name": "comp",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "preview",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "thumb",
                        "uri": "<link>"
                    }
                ]
            ]
        }
        ```

        ## Request Usage Considerations

        - Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.



                  "name": "string",
                  "uri": "string"
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: An image id. For more than one image please use the /v3/images endpoint.
          in: path
          name: id
          required: true
          schema:
            description: An image id. For more than one image please use the /v3/images endpoint.
            nullable: true
            type: string
        - description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
          explode: false
          in: query
          name: fields
          schema:
            description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
            items:
              $ref: "#/components/schemas/ImageDetailFieldValues"
            nullable: true
            type: array
          style: form
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ImagesDetailResults"
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
        "404":
          description: ImageNotFound
        "500":
          description: InvalidIStockCollection
      summary: Get metadata for a single image by supplying one image id
      tags:
        - Images
  "/v3/images/{id}/downloadhistory":
    get:
      description: ""
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: An image id.
          in: path
          name: id
          required: true
          schema:
            description: An image id.
            nullable: true
            type: string
        - description: "If specified, returns the list of previously downloaded images for all users in your company.\r

            \            Your account must be enabled for this functionality. Contact your Getty Images account rep for more information. Default is false."
          in: query
          name: company_downloads
          schema:
            description: "If specified, returns the list of previously downloaded images for all users in your company.\r

              \            Your account must be enabled for this functionality. Contact your Getty Images account rep for more information. Default is false."
            type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AssetDownloadHistoryResults"
          description: OK
        "400":
          description: Bad request
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
        "404":
          description: ImageNotFound
        "500":
          description: InvalidIStockCollection
      summary: Returns information about a customer's download history for a specific asset
      tags:
        - Images
  "/v3/images/{id}/same-series":
    get:
      description: |
        This endpoint will provide the list of images, if any exist, from the same series as the specified creative asset id. These images are typically from the same photo shoot. This functionality will not work for editorial assets.

        You'll need an API key and access token to use this resource.

        ## Working with Fields Sets

        Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:

        #### Summary Fields Set

        The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build
        search response results. The following fields are provided for every image in your result set when you include **summary_set** in your request.

        ```
        {
            "images":
            [
                "asset_family",
                "caption",
                "collection_code",
                "collection_id",
                "collection_name",
                "display_sizes": 
                [
                    {
                        "name": "thumb"
                    }
                ]
                "license_model",
                "max_dimensions",
                "title"
            ]
        }
        ```

        #### Detail Fields Set

        The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a 
        detailed view of images. The following fields are provided for every image in your result set when you include **detail_set** in your request.

        ```
        {
            "images":
            [
                "allowed_use",
                "artist",
                "asset_family",
                "call_for_image",
                "caption",
                "collection_code",
                "collection_id",
                "collection_name",
                "copyright",
                "date_created",
                "display_sizes": 
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "editorial_segments",
                "event_ids",
                "graphical_style",
                "license_model",
                "max_dimensions",
                "orientation",
                "product_types",
                "quality_rank",
                "referral_destinations",
                "title"
            ]
        }
        ```

        #### Display Fields Set

        The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files 
        that are most frequently used to build a UI displaying search results. The following fields are provided for every image in your result
        set when you include **display_set** in your request.

        The URI provided is subject to change at any time and must be used as-is with no modification.

        ```
        {
            "images":
            [
                "display_sizes": 
                [
                    {
                        "is_watermarked": <boolean>,
                        "name": "comp",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "preview",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "thumb",
                        "uri": "<link>"
                    }
                ]
            ]
        }
        ```
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Identifies an existing image
          in: path
          name: id
          required: true
          schema:
            description: Identifies an existing image
            nullable: true
            type: string
        - description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
          explode: false
          in: query
          name: fields
          schema:
            description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
            items:
              $ref: "#/components/schemas/ImagesFieldValues"
            nullable: true
            type: array
          style: form
        - description: Identifies page to return. Default is 1.
          in: query
          name: page
          schema:
            default: 1
            description: Identifies page to return. Default is 1.
            format: int32
            type: integer
        - description: Specifies page size. Default is 30, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 30
            description: Specifies page size. Default is 30, maximum page_size is 100.
            format: int32
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ImageSearchItemSearchResults"
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
        "404":
          description: ImageNotFound
        "500":
          description: InvalidIStockCollection
      summary: Retrieve creative images from the same series
      tags:
        - Images
  "/v3/images/{id}/similar":
    get:
      description: |
        This endpoint will provide a list of images that are similar to the specified asset id.

        You'll need an API key and access token to use this resource.

        ## Working with Fields Sets

        Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:

        #### Summary Fields Set

        The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build
        search response results. The following fields are provided for every image in your result set when you include **summary_set** in your request.

        ```
        {
            "images":
            [
                "asset_family",
                "caption",
                "collection_code",
                "collection_id",
                "collection_name",
                "display_sizes": 
                [
                    {
                        "name": "thumb"
                    }
                ]
                "license_model",
                "max_dimensions",
                "title"
            ]
        }
        ```

        #### Detail Fields Set

        The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a 
        detailed view of images. The following fields are provided for every image in your result set when you include **detail_set** in your request.

        ```
        {
            "images":
            [
                "allowed_use",
                "artist",
                "asset_family",
                "call_for_image",
                "caption",
                "collection_code",
                "collection_id",
                "collection_name",
                "copyright",
                "date_created",
                "display_sizes": 
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "editorial_segments",
                "event_ids",
                "graphical_style",
                "license_model",
                "max_dimensions",
                "orientation",
                "product_types",
                "quality_rank",
                "referral_destinations",
                "title"
            ]
        }
        ```

        #### Display Fields Set

        The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files 
        that are most frequently used to build a UI displaying search results. The following fields are provided for every image in your result
        set when you include **display_set** in your request.


        The URI provided is subject to change at any time and must be used as-is with no modification.

        ```
        {
            "images":
            [
                "display_sizes": 
                [
                    {
                        "is_watermarked": <boolean>,
                        "name": "comp",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "preview",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "thumb",
                        "uri": "<link>"
                    }
                ]
            ]
        }
        ```
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Identifies an existing image
          in: path
          name: id
          required: true
          schema:
            description: Identifies an existing image
            nullable: true
            type: string
        - description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
          explode: false
          in: query
          name: fields
          schema:
            description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
            items:
              $ref: "#/components/schemas/ImagesFieldValues"
            nullable: true
            type: array
          style: form
        - description: Identifies page to return. Default is 1.
          in: query
          name: page
          schema:
            default: 1
            description: Identifies page to return. Default is 1.
            format: int32
            type: integer
        - description: Specifies page size. Default is 30, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 30
            description: Specifies page size. Default is 30, maximum page_size is 100.
            format: int32
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ImageSearchItemSearchResults"
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
        "404":
          description: ImageNotFound
        "500":
          description: InvalidIStockCollection
      summary: Retrieve similar images
      tags:
        - Images
  "/v3/orders/{id}":
    get:
      description: |-
        This endpoint returns detailed order metadata for a specified order.
        Use of this endpoint requires configuration changes to your API key. 

        You'll need an API key and access token to use this resource.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: An order id.
          in: path
          name: id
          required: true
          schema:
            description: An order id.
            format: int32
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/OrderDetail"
          description: OK
        "401":
          description: Unauthorized
        "403":
          description: NoAccessToOrderMetadata
        "404":
          description: OrderNotFound
      summary: Get order metadata
      tags:
        - Orders
  /v3/products:
    get:
      description: |
        This endpoint returns all products available to the username used during authentication. As such, this endpoint requires the use of
        a fully authorized access_token. The product data can then be used as search filters, restricting results to images from a specific product.

        You'll need an API key and access token to use this resource.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Comma separated list of fields. Allows product download requirements to be returned.
          explode: false
          in: query
          name: fields
          schema:
            description: Comma separated list of fields. Allows product download requirements to be returned.
            items:
              $ref: "#/components/schemas/ProductFieldValues"
            nullable: true
            type: array
          style: form
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ProductsResult"
          description: OK
        "400":
          description: InvalidRequestParameters
        "401":
          description: Unauthorized
        "500":
          description: CreditPack
      summary: Get Products
      tags:
        - Products
  /v3/purchased-assets:
    get:
      description: |
        This endpoint returns a list of all assets purchased on gettyimages.com by the username used for authentication. 
        Use of this endpoint requires configuration changes to your API key. Please contact your sales representative
        to learn more.

        You'll need an API key and access token to use this resource.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: If specified, retrieves previous purchases on or before this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD).
          in: query
          name: date_to
          schema:
            description: If specified, retrieves previous purchases on or before this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD).
            format: date-time
            nullable: true
            type: string
        - description: Identifies page to return. Default is 1.
          in: query
          name: page
          schema:
            default: 1
            description: Identifies page to return. Default is 1.
            format: int32
            type: integer
        - description: Specifies page size. Default is 75, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 75
            description: Specifies page size. Default is 75, maximum page_size is 100.
            format: int32
            type: integer
        - description: If specified, retrieves previous purchases on or after this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD).
          in: query
          name: date_from
          schema:
            description: If specified, retrieves previous purchases on or after this date. Dates should be submitted in ISO 8601 format (i.e., YYYY-MM-DD).
            format: date-time
            nullable: true
            type: string
        - description: If specified, returns the list of previously purchased assets for all users in your company. Your account must be enabled for this functionality. Contact your Getty Images account rep for more information. Default is false.
          in: query
          name: company_purchases
          schema:
            default: false
            description: If specified, returns the list of previously purchased assets for all users in your company. Your account must be enabled for this functionality. Contact your Getty Images account rep for more information. Default is false.
            type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/PreviousAssetPurchases"
          description: OK
        "400":
          description: PageNumberLessThanOne
        "401":
          description: Unauthorized
        "403":
          description: InsufficientPermissions
      summary: Get Previously Purchased Images and Video
      tags:
        - Purchases
  "/v3/search/by-image/uploads/{file-name}":
    put:
      parameters:
        - description: ""
          in: path
          name: file-name
          required: true
          schema:
            description: ""
            nullable: true
            type: string
      requestBody:
        content:
          image/jpeg:
            schema:
              description: ""
              format: byte
              nullable: true
              type: string
          image/png:
            schema:
              description: ""
              format: byte
              nullable: true
              type: string
        description: ""
      responses:
        "200":
          description: Success
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
      summary: Upload image for use by the search creative images/videos operations
      tags:
        - Search
  /v3/search/events:
    get:
      description: |
        Use this endpoint to search Getty Images news, sports and entertainment events. Getty Images photographers and videographers cover editorially relevant events occurring around the world.  All images or video clips produced in association with an event, are assigned the same EventID. EventIDs are part of the meta-data returned in Search Results. Only content produced under a Getty Images brand name (Getty Images News, Getty Images Sports, Getty Images Entertainment, Film Magic, Wire Image) will be consistently assigned an EventID. The Event framework may also be used to group similar content, such as "Hats from the Royal Wedding" or "Odd-ballOffbeat images of the week".   

        You'll need an API key and access token to use this resource.


        You can show different information in the response by specifying values on the "fields" parameter (see details below).
        You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search).  If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request.  Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes.
          in: header
          name: GI-Country-Code
          schema:
            description: Use of this parameter requires configuration changes to your API key. Please contact your sales representative to learn more.
            type: string
        - description: Filters to events with a matching editorial segment.
          in: query
          name: editorial_segment
          schema:
            $ref: "#/components/schemas/EditorialSegmentContract"
        - description: Filters to events that start on or after this date. Use ISO 8601 format (e.g., 1999-12-31). Defaults to UTC unless otherwise specified.
          in: query
          name: date_from
          schema:
            description: Filters to events that start on or after this date. Use ISO 8601 format (e.g., 1999-12-31). Defaults to UTC unless otherwise specified.
            format: date-time
            nullable: true
            type: string
        - description: Filters to events that start on or before this date. Use ISO 8601 format (e.g., 1999-12-31). Defaults to UTC unless otherwise specified.
          in: query
          name: date_to
          schema:
            description: Filters to events that start on or before this date. Use ISO 8601 format (e.g., 1999-12-31). Defaults to UTC unless otherwise specified.
            format: date-time
            nullable: true
            type: string
        - description: Specifies fields to return. Default set is 'id','name','start_date'.
          explode: false
          in: query
          name: fields
          schema:
            description: Specifies fields to return. Default set is 'id','name','start_date'.
            items:
              $ref: "#/components/schemas/EventFieldValues"
            nullable: true
            type: array
          style: form
        - description: Request results starting at a page number (default is 1, maximum is 50).
          in: query
          name: page
          schema:
            default: 1
            description: Request results starting at a page number (default is 1, maximum is 50).
            format: int32
            type: integer
        - description: Request number of events to return in each page. Default is 30, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 30
            description: Request number of events to return in each page. Default is 30, maximum page_size is 100.
            format: int32
            type: integer
        - description: Filters to events related to this phrase
          in: query
          name: phrase
          schema:
            default: ""
            description: Filters to events related to this phrase
            nullable: true
            type: string
        - description: Specifies the order in which to sort the results. Default is `newest`.
          in: query
          name: sort_order
          schema:
            $ref: "#/components/schemas/EventSearchSortOrder"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EventsSearchResult"
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
      summary: Search for events
      tags:
        - Search
  /v3/search/images:
    get:
      description: |
        ## _This endpoint draws from such a large diversity of content, the results will not be as relevant as when the more specific Creative or Editorial endpoints are used. Additionally, the response time for this endpoint is slower compared to that for Creative and Editorial-specific endpoints. For these reasons,_ _**it is highly recommended that those endpoints are used instead of this blended endpoint.**_



        You'll need an API key and access token to use this resource.

        You can show different information in the response by specifying values on the "fields" parameter (see details below).
        You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search).  If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request.  Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token.<br>
        To include your API token in the search request, add it to the headers as a Bearer token (example in curl):

        	-H "Authorization: Bearer <your-token>"

        Search requests without a phrase parameter are not supported and may not always work.

        ## Working with Fields Sets

        Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:

        #### Summary Fields Set

        The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every image in your result set when you include **summary_set** in your request.

        ```
        {
            "images": 
            [
                "asset_family",
                "caption",
                "collection_code",
                "collection_id",
                "collection_name",
                "display_sizes": 
                [
                    {
                        "name": "thumb"
                    }
                ],
                "license_model",
                "max_dimensions",
                "title"
            ]
        }
        ```

        #### Detail Fields Set

        The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of images. 
        The following fields are provided for every image in your result set when you include **detail_set** in your request.

        ```
        {
            "images": 
            [
                "allowed_use",
                "artist",
                "asset_family",
                "call_for_image",
                "caption",
                "collection_code",
                "collection_id",
                "collection_name",
                "copyright",
                "date_created",
                "display_sizes": 
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "editorial_segments",
                "event_ids",
                "graphical_style",
                "license_model",
                "max_dimensions",
                "orientation",
                "product_types",
                "quality_rank",
                "referral_destinations",
                "title"
            ]
        ]
        ```

        #### Display Fields Set

        The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most 
        frequently used to build a UI displaying search results. The following fields are provided for every image in your result set when you include **display_set**
        in your request.

        The URI provided is subject to change at any time and must be used as-is with no modification.

        ```
        {
            "images":
            [
                "display_sizes": 
                [
                    {
                        "is_watermarked": <boolean>,
                        "name": "comp",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "preview",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "thumb",
                        "uri": "<link>"
                    }
                ]
            ]
        }
        ```

        ## Request Usage Considerations

        - Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes.
          in: header
          name: GI-Country-Code
          schema:
            description: Use of this parameter requires configuration changes to your API key. Please contact your sales representative to learn more.
            type: string
        - description: Filter based on the age of individuals in an image.
          explode: false
          in: query
          name: age_of_people
          schema:
            description: Filter based on the age of individuals in an image.
            items:
              $ref: "#/components/schemas/AgeOfPeopleFilterType"
            nullable: true
            type: array
          style: form
        - description: Search for images by specific artists (free-text, comma-separated list of artists).
          in: query
          name: artists
          schema:
            description: Search for images by specific artists (free-text, comma-separated list of artists).
            nullable: true
            type: string
        - description: Filter by collection codes (comma-separated list). Include or exclude based on collections_filter_type.
          explode: false
          in: query
          name: collection_codes
          schema:
            description: Filter by collection codes (comma-separated list). Include or exclude based on collections_filter_type.
            items:
              type: string
            nullable: true
            type: array
          style: form
        - description: Provides searching based on specified collection(s). The default is Include
          in: query
          name: collections_filter_type
          schema:
            $ref: "#/components/schemas/CollectionsFilterType"
        - description: "Filter based on predominant color in an image. Use 6 character hexidecimal format (e.g., #002244). Note: when specified, results will not contain editorial images."
          in: query
          name: color
          schema:
            description: "Filter based on predominant color in an image. Use 6 character hexidecimal format (e.g., #002244). Note: when specified, results will not contain editorial images."
            nullable: true
            type: string
        - description: Filter based on image composition.
          explode: false
          in: query
          name: compositions
          schema:
            description: Filter based on image composition.
            items:
              $ref: "#/components/schemas/CompositionsFilterType"
            nullable: true
            type: array
          style: form
        - description: "Filters based on which product the asset will download against.\r

            \                    Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription.\r

            \                    If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. \r

            \                    For example, some users may have more than one premiumaccess product, so the download_product value would be premiumaccess:1234. \r

            \                    Product ID can be obtained from the GET /products response."
          in: query
          name: download_product
          schema:
            description: "Filters based on which product the asset will download against.\r

              \                    Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription.\r

              \                    If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. \r

              \                    For example, some users may have more than one premiumaccess product, so the download_product value would be premiumaccess:1234. \r

              \                    Product ID can be obtained from the GET /products response."
            nullable: true
            type: string
        - description: Restrict search results to embeddable images. The default is false.
          in: query
          name: embed_content_only
          schema:
            default: false
            description: Restrict search results to embeddable images. The default is false.
            type: boolean
        - description: Filter based on specific events
          explode: false
          in: query
          name: event_ids
          schema:
            description: Filter based on specific events
            items:
              format: int32
              type: integer
            nullable: true
            type: array
          style: form
        - description: Filter search results based on the ethnicity of individuals in an image.
          explode: false
          in: query
          name: ethnicity
          schema:
            description: Filter search results based on the ethnicity of individuals in an image.
            items:
              $ref: "#/components/schemas/EthnicityFilterType"
            nullable: true
            type: array
          style: form
        - description: Excludes images containing nudity. The default is false.
          in: query
          name: exclude_nudity
          schema:
            default: false
            description: Excludes images containing nudity. The default is false.
            type: boolean
        - description: Specifies fields to return. Defaults to 'summary_set'.
          explode: false
          in: query
          name: fields
          schema:
            description: Specifies fields to return. Defaults to 'summary_set'.
            items:
              $ref: "#/components/schemas/ImagesFieldValues"
            nullable: true
            type: array
          style: form
        - description: Return only images having a specific file type.
          explode: false
          in: query
          name: file_types
          schema:
            description: Return only images having a specific file type.
            items:
              $ref: "#/components/schemas/SearchFileType"
            nullable: true
            type: array
          style: form
        - description: Filter based on graphical style of the image.
          explode: false
          in: query
          name: graphical_styles
          schema:
            description: Filter based on graphical style of the image.
            items:
              $ref: "#/components/schemas/GraphicalStyle"
            nullable: true
            type: array
          style: form
        - description: Provides searching based on specified graphical style(s). The default is Include
          in: query
          name: graphical_styles_filter_type
          schema:
            $ref: "#/components/schemas/GraphicalStylesFilterType"
        - description: Specifies whether or not to include related searches in the response. The default is false.
          in: query
          name: include_related_searches
          schema:
            default: false
            description: Specifies whether or not to include related searches in the response. The default is false.
            type: boolean
        - description: Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned.
          explode: false
          in: query
          name: keyword_ids
          schema:
            description: Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned.
            items:
              format: int32
              type: integer
            nullable: true
            type: array
          style: form
        - description: Filter based on minimum size requested. The default is x-small
          in: query
          name: minimum_size
          schema:
            $ref: "#/components/schemas/TeeShirtSize"
        - description: Filter based on the number of people in the image.
          explode: false
          in: query
          name: number_of_people
          schema:
            description: Filter based on the number of people in the image.
            items:
              $ref: "#/components/schemas/NumberOfPeopleFilterType"
            nullable: true
            type: array
          style: form
        - description: Return only images with selected aspect ratios.
          explode: false
          in: query
          name: orientations
          schema:
            description: Return only images with selected aspect ratios.
            items:
              $ref: "#/components/schemas/ImageOrientationRequest"
            nullable: true
            type: array
          style: form
        - description: Request results starting at a page number (default is 1).
          in: query
          name: page
          schema:
            default: 1
            description: Request results starting at a page number (default is 1).
            format: int32
            type: integer
        - description: Request number of images to return in each page. Default is 30, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 30
            description: Request number of images to return in each page. Default is 30, maximum page_size is 100.
            format: int32
            type: integer
        - description: Search images using a search phrase.
          in: query
          name: phrase
          schema:
            description: Search images using a search phrase.
            nullable: true
            type: string
        - description: Select sort order of results.  The default is best_match
          in: query
          name: sort_order
          schema:
            $ref: "#/components/schemas/BlendedImageSortOrder"
        - description: Return only images associated with specific people (using a comma-delimited list).
          explode: false
          in: query
          name: specific_people
          schema:
            description: Return only images associated with specific people (using a comma-delimited list).
            items:
              type: string
            nullable: true
            type: array
          style: form
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ImageSearchItemSearchResults"
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
      summary: Search for both creative and editorial images - *** DEPRECATED ***
      tags:
        - Search
  /v3/search/images/creative:
    get:
      description: |-
        Use this endpoint to search our contemporary stock photos, illustrations and archival images.

        You'll need an API key and access token to use this resource.
         
        You can show different information in the response by specifying values on the "fields" parameter (see details below).
        You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search).  If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request.  Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token.

        Search requests without a phrase parameter are not supported and may not always work.

        ## Working with Fields Sets

        Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:

        #### Summary Fields Set

        The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to 
        build search response results. The following fields are provided for every image in your result set when you include **summary_set** in your request.

        ```
        {
            "images": 
            [
                "asset_family",
                "caption",
                "collection_code",
                "collection_id",
                "collection_name",
                "display_sizes": 
                [
                    {
                        "name": "thumb"
                    }
                ],
                "license_model",
                "max_dimensions",
                "title"
            ]
        }
        ```

        #### Detail Fields Set

        The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to 
        build a detailed view of images. The following fields are provided for every image in your result set when you include **detail_set** in your request.

        ```
        {
            "images": 
            [
                "allowed_use",
                "artist",
                "asset_family",
                "call_for_image",
                "caption",
                "collection_code",
                "collection_id",
                "collection_name",
                "copyright",
                "date_created",
                "display_sizes": 
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "editorial_segments",
                "event_ids",
                "graphical_style",
                "license_model",
                "max_dimensions",
                "orientation",
                "product_types",
                "quality_rank",
                "referral_destinations",
                "title"
            ]
        ]
        ```

        #### Display Fields Set

        The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution
        files that are most frequently used to build a UI displaying search results. The following fields are provided for every image 
        in your result set when you include **display_set** in your request.

        The URI provided is subject to change at any time and must be used as-is with no modification.

        ```
        {
            "images":
            [
                "display_sizes": 
                [
                    {
                        "is_watermarked": <boolean>,
                        "name": "comp",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "preview",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "thumb",
                        "uri": "<link>"
                    }
                ]
            ]
        }
        ```
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes.
          in: header
          name: GI-Country-Code
          schema:
            description: Use of this parameter requires configuration changes to your API key. Please contact your sales representative to learn more.
            type: string
        - description: Filter based on the age of individuals in an image.
          explode: false
          in: query
          name: age_of_people
          schema:
            description: Filter based on the age of individuals in an image.
            items:
              $ref: "#/components/schemas/AgeOfPeopleFilterType"
            nullable: true
            type: array
          style: form
        - description: Search for images by specific artists (free-text, comma-separated list of artists).
          in: query
          name: artists
          schema:
            description: Search for images by specific artists (free-text, comma-separated list of artists).
            nullable: true
            type: string
        - description: Filter by collection codes (comma-separated list). Include or exclude based on collections_filter_type.
          explode: false
          in: query
          name: collection_codes
          schema:
            description: Filter by collection codes (comma-separated list). Include or exclude based on collections_filter_type.
            items:
              type: string
            nullable: true
            type: array
          style: form
        - description: Use to include or exclude collections from search. The default is include
          in: query
          name: collections_filter_type
          schema:
            $ref: "#/components/schemas/CollectionsFilterType"
        - description: "Filter based on predominant color in an image. Use 6 character hexadecimal format (e.g., #002244)."
          in: query
          name: color
          schema:
            description: "Filter based on predominant color in an image. Use 6 character hexadecimal format (e.g., #002244)."
            nullable: true
            type: string
        - description: Filter based on image composition.
          explode: false
          in: query
          name: compositions
          schema:
            description: Filter based on image composition.
            items:
              $ref: "#/components/schemas/CompositionsFilterType"
            nullable: true
            type: array
          style: form
        - description: "Filters based on which product the asset will download against.\r

            \                    Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription.\r

            \                    If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. \r

            \                    For example, some users may have more than one premiumaccess product, so the download_product value would be premiumaccess:1234. \r

            \                    Product ID can be obtained from the GET /products response."
          in: query
          name: download_product
          schema:
            description: "Filters based on which product the asset will download against.\r

              \                    Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription.\r

              \                    If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. \r

              \                    For example, some users may have more than one premiumaccess product, so the download_product value would be premiumaccess:1234. \r

              \                    Product ID can be obtained from the GET /products response."
            nullable: true
            type: string
        - description: Restrict search results to embeddable images. The default is false.
          in: query
          name: embed_content_only
          schema:
            default: false
            description: Restrict search results to embeddable images. The default is false.
            type: boolean
        - description: Filter search results based on the ethnicity of individuals in an image.
          explode: false
          in: query
          name: ethnicity
          schema:
            description: Filter search results based on the ethnicity of individuals in an image.
            items:
              $ref: "#/components/schemas/EthnicityFilterType"
            nullable: true
            type: array
          style: form
        - description: Return only images not tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also do not contain the requested keyword(s) are returned.
          explode: false
          in: query
          name: exclude_keyword_ids
          schema:
            description: Return only images not tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also do not contain the requested keyword(s) are returned.
            items:
              format: int32
              type: integer
            nullable: true
            type: array
          style: form
        - description: Excludes images containing nudity. The default is false.
          in: query
          name: exclude_nudity
          schema:
            default: false
            description: Excludes images containing nudity. The default is false.
            type: boolean
        - description: Exclude images that are only available for editorial (non-commercial) use. Default value is false.
          in: query
          name: exclude_editorial_use_only
          schema:
            description: Exclude images that are only available for editorial (non-commercial) use. Default value is false.
            nullable: true
            type: boolean
        - description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
          explode: false
          in: query
          name: fields
          schema:
            description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
            items:
              $ref: "#/components/schemas/CreativeImagesFieldValues"
            nullable: true
            type: array
          style: form
        - description: Return only images having a specific file type.
          explode: false
          in: query
          name: file_types
          schema:
            description: Return only images having a specific file type.
            items:
              $ref: "#/components/schemas/SearchFileType"
            nullable: true
            type: array
          style: form
        - description: Filter based on graphical style of the image.
          explode: false
          in: query
          name: graphical_styles
          schema:
            description: Filter based on graphical style of the image.
            items:
              $ref: "#/components/schemas/GraphicalStyle"
            nullable: true
            type: array
          style: form
        - description: Provides searching based on specified graphical style(s). The default is include.
          in: query
          name: graphical_styles_filter_type
          schema:
            $ref: "#/components/schemas/GraphicalStylesFilterType"
        - description: Specifies whether or not to include related searches in the response. The default is false.
          in: query
          name: include_related_searches
          schema:
            default: false
            description: Specifies whether or not to include related searches in the response. The default is false.
            type: boolean
        - description: Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned.
          explode: false
          in: query
          name: keyword_ids
          schema:
            description: Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned.
            items:
              format: int32
              type: integer
            nullable: true
            type: array
          style: form
        - description: Filter based on minimum size requested. The default is x-small.
          in: query
          name: minimum_size
          schema:
            $ref: "#/components/schemas/TeeShirtSize"
        - description: Filter based on the number of people in the image.
          explode: false
          in: query
          name: number_of_people
          schema:
            description: Filter based on the number of people in the image.
            items:
              $ref: "#/components/schemas/NumberOfPeopleFilterType"
            nullable: true
            type: array
          style: form
        - description: Return only images with selected aspect ratios.
          explode: false
          in: query
          name: orientations
          schema:
            description: Return only images with selected aspect ratios.
            items:
              $ref: "#/components/schemas/ImageOrientationRequest"
            nullable: true
            type: array
          style: form
        - description: Request results starting at a page number (default is 1).
          in: query
          name: page
          schema:
            default: 1
            description: Request results starting at a page number (default is 1).
            format: int32
            type: integer
        - description: Request number of images to return in each page. Default is 30, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 30
            description: Request number of images to return in each page. Default is 30, maximum page_size is 100.
            format: int32
            type: integer
        - description: Search images using a search phrase.
          in: query
          name: phrase
          schema:
            default: ""
            description: Search images using a search phrase.
            nullable: true
            type: string
        - description: Setting safe_search to "true" excludes images containing nudity, death, profanity, drugs and alcohol, suggestive content, and graphic content from the result set. The default is false. Because this is a keyword-based filter, it's possible that a small number of unsafe images may not be caught by the filter. Please direct feedback to your Getty Images Account or API support representative.
          in: query
          name: safe_search
          schema:
            default: false
            description: Setting safe_search to "true" excludes images containing nudity, death, profanity, drugs and alcohol, suggestive content, and graphic content from the result set. The default is false. Because this is a keyword-based filter, it's possible that a small number of unsafe images may not be caught by the filter. Please direct feedback to your Getty Images Account or API support representative.
            type: boolean
        - description: Select sort order of results.  The default is best_match
          in: query
          name: sort_order
          schema:
            $ref: "#/components/schemas/CreativeImageSortOrder"
        - description: "Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.\r

            \                   The include_facets parameter must be set to \"true\" for facets to be returned."
          explode: false
          in: query
          name: facet_fields
          schema:
            description: "Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.\r

              \                   The include_facets parameter must be set to \"true\" for facets to be returned."
            items:
              $ref: "#/components/schemas/CreateImageSearchFacetsFields"
            nullable: true
            type: array
          style: form
        - description: Specifies whether or not to include facets in the result set. Default is "false".
          in: query
          name: include_facets
          schema:
            description: Specifies whether or not to include facets in the result set. Default is "false".
            nullable: true
            type: boolean
        - description: Specifies the maximum number of facets to return per type. Default is 300.
          in: query
          name: facet_max_count
          schema:
            default: 300
            description: Specifies the maximum number of facets to return per type. Default is 300.
            format: int32
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreativeImageSearchResults"
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
        "500":
          description: InvalidIStockCollection
      summary: Search for creative images only
      tags:
        - Search
  /v3/search/images/creative/by-image:
    get:
      description: |
        Search for **similar creative images** by passing an `image_url` to an uploaded image OR an `asset_id` of an asset in our catalog.  All responses will have the `exclude_nudity` filter automatically applied.

        ## Searching by URL

        Before calling the search by image endpoint, an image in JPEG format must be uploaded to `https://api.gettyimages.com/v3/search/by-image/uploads/{CLIENT_IMAGE.jpg}`, where the client defines the `{CLIENT_IMAGE.jpg}` portion of the URL.

        For example, using cURL:

        ``` sh
        curl -i -X PUT https://api.gettyimages.com/v3/search/by-image/uploads/my-test-image.jpg -H 'Content-Type: image/jpeg' -H 'Api-Key: API_KEY' --data-binary "@testimage.jpg"
        ```

        Once the image has been uploaded, use the full URL in the `image_url` parameter, e.g. `image_url=https://api.gettyimages.com/v3/search/by-image/uploads/my-test-image.jpg`.

        - Uploaded files must be 10MB or smaller.
        - Uploads to the same URL will overwrite each other, so ensure that the client application is handling naming uniqueness appropriately.
        - Uploads expire after 24 hours.
        - Uploads and searches must be performed using the _same_ API Key.

        ## Searching by asset id

        When searching by `asset_id`, any image or video asset id in the Getty/iStock catalog can be used as the source for similar images.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes.
          in: header
          name: GI-Country-Code
          schema:
            description: Use of this parameter requires configuration changes to your API key. Please contact your sales representative to learn more.
            type: string
        - description: Specifies the Getty image id to use in the search.
          in: query
          name: asset_id
          schema:
            description: Specifies the Getty image id to use in the search.
            nullable: true
            type: string
        - description: Exclude images that are only available for editorial (non-commercial) use. Default value is false.
          in: query
          name: exclude_editorial_use_only
          schema:
            description: Exclude images that are only available for editorial (non-commercial) use. Default value is false.
            nullable: true
            type: boolean
        - description: "Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.\r

            \                    The include_facets parameter must be set to \"true\" for facets to be returned."
          explode: false
          in: query
          name: facet_fields
          schema:
            description: "Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.\r

              \                    The include_facets parameter must be set to \"true\" for facets to be returned."
            items:
              $ref: "#/components/schemas/CreateImageSearchFacetsFields"
            nullable: true
            type: array
          style: form
        - description: Specifies the maximum number of facets to return per type. Default is 300.
          in: query
          name: facet_max_count
          schema:
            default: 300
            description: Specifies the maximum number of facets to return per type. Default is 300.
            format: int32
            type: integer
        - description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
          explode: false
          in: query
          name: fields
          schema:
            description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
            items:
              $ref: "#/components/schemas/CreativeImagesFieldValues"
            nullable: true
            type: array
          style: form
        - description: Specifies the location of the image to use in the search.
          in: query
          name: image_url
          schema:
            description: Specifies the location of the image to use in the search.
            nullable: true
            type: string
        - description: Specifies whether or not to include facets in the result set. Default is "false".
          in: query
          name: include_facets
          schema:
            description: Specifies whether or not to include facets in the result set. Default is "false".
            nullable: true
            type: boolean
        - description: Request results starting at a page number (default is 1).
          in: query
          name: page
          schema:
            default: 1
            description: Request results starting at a page number (default is 1).
            format: int32
            type: integer
        - description: Request number of images to return in each page. Default is 30, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 30
            description: Request number of images to return in each page. Default is 30, maximum page_size is 100.
            format: int32
            type: integer
        - description: "Filter images to those from one of your product types. \r

            \                    Allowed values are easyaccess, imagepack, premiumaccess and royaltyfreesubscription. \r

            \                    If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. \r

            \                    For example, some users may have more than one premiumaccess product, so the product_types value would be premiumaccess:1234. \r

            \                    Product ID can be obtained from the GET /products response."
          explode: false
          in: query
          name: product_types
          schema:
            description: "Filter images to those from one of your product types. \r

              \                    Allowed values are easyaccess, imagepack, premiumaccess and royaltyfreesubscription. \r

              \                    If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. \r

              \                    For example, some users may have more than one premiumaccess product, so the product_types value would be premiumaccess:1234. \r

              \                    Product ID can be obtained from the GET /products response."
            items:
              type: string
            nullable: true
            type: array
          style: form
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SearchByImageResourceResults"
          description: Success
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
        "404":
          description: AssetNotFound
        "500":
          description: InvalidIStockCollection
      summary: Search for creative images based on url
      tags:
        - Search
  /v3/search/images/editorial:
    get:
      description: |-
        Use this endpoint to search our editorial stock photos, illustrations and archival images.  Editorial images represent newsworthy events or illustrate matters of general interest, such as news, sport and entertainment and are generally intended for editorial use.

        You'll need an API key and access token to use this resource.

        You can show different information in the response by specifying values on the "fields" parameter (see details below).
        You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search).  If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request.  Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token.
        To include your API token in the search request, add it to the headers as a Bearer token (example in curl):

        	-H "Authorization: Bearer <your-token>"

        Search requests without a phrase parameter are not supported and may not always work.

        ## Working with Fields Sets

        Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:

        #### Summary Fields Set

        The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every image in your result set when you include **summary_set** in your request.

        ```
        {
            "images": 
            [
                "asset_family",
                "caption",
                "collection_code",
                "collection_id",
                "collection_name",
                "display_sizes": 
                [
                    {
                        "name": "thumb"
                    }
                ],
                "license_model",
                "max_dimensions",
                "title"
            ]
        }
        ```

        #### Detail Fields Set

        The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of images. The following fields are provided for every image in your result set when you include **detail_set** in your request.

        ```
        {
            "images": 
            [
                "allowed_use",
                "artist",
                "asset_family",
                "call_for_image",
                "caption",
                "collection_code",
                "collection_id",
                "collection_name",
                "copyright",
                "date_created",
                "display_sizes": 
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "editorial_segments",
                "event_ids",
                "graphical_style",
                "license_model",
                "max_dimensions",
                "orientation",
                "product_types",
                "quality_rank",
                "referral_destinations",
                "title"
            ]
        ]
        ```

        #### Display Fields Set

        The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every image in your result set when you include **display_set** in your request.

        The URI provided is subject to change at any time and must be used as-is with no modification.

        ```
        {
            "images":
            [
                "display_sizes": 
                [
                    {
                        "is_watermarked": <boolean>,
                        "name": "comp",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "preview",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "thumb",
                        "uri": "<link>"
                    }
                ]
            ]
        }
        ```
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes.
          in: header
          name: GI-Country-Code
          schema:
            description: Use of this parameter requires configuration changes to your API key. Please contact your sales representative to learn more.
            type: string
        - description: Filter based on the age of individuals in an image.
          explode: false
          in: query
          name: age_of_people
          schema:
            description: Filter based on the age of individuals in an image.
            items:
              $ref: "#/components/schemas/AgeOfPeopleFilterType"
            nullable: true
            type: array
          style: form
        - description: Search for images by specific artists (free-text, comma-separated list of artists).
          in: query
          name: artists
          schema:
            description: Search for images by specific artists (free-text, comma-separated list of artists).
            nullable: true
            type: string
        - description: Filter by collections (comma-separated list of collection codes). Include or exclude based on collections_filter_type.
          explode: false
          in: query
          name: collection_codes
          schema:
            description: Filter by collections (comma-separated list of collection codes). Include or exclude based on collections_filter_type.
            items:
              type: string
            nullable: true
            type: array
          style: form
        - description: Use to include or exclude collections from search. The default is include
          in: query
          name: collections_filter_type
          schema:
            $ref: "#/components/schemas/CollectionsFilterType"
        - description: Filter based on image composition.
          explode: false
          in: query
          name: compositions
          schema:
            description: Filter based on image composition.
            items:
              $ref: "#/components/schemas/CompositionsFilterType"
            nullable: true
            type: array
          style: form
        - description: Return only images that are created on or after this date. Use ISO 8601 format (e.g., 1999-12-31).
          in: query
          name: date_from
          schema:
            description: Return only images that are created on or after this date. Use ISO 8601 format (e.g., 1999-12-31).
            format: date-time
            nullable: true
            type: string
        - description: Return only images that are created on or before this date. Use ISO 8601 format (e.g., 1999-12-31).
          in: query
          name: date_to
          schema:
            description: Return only images that are created on or before this date. Use ISO 8601 format (e.g., 1999-12-31).
            format: date-time
            nullable: true
            type: string
        - description: "Filters based on which product the asset will download against.\r

            \                    Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription.\r

            \                    If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. \r

            \                    For example, some users may have more than one premiumaccess product, so the download_product value would be premiumaccess:1234. \r

            \                    Product ID can be obtained from the GET /products response."
          in: query
          name: download_product
          schema:
            description: "Filters based on which product the asset will download against.\r

              \                    Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription.\r

              \                    If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. \r

              \                    For example, some users may have more than one premiumaccess product, so the download_product value would be premiumaccess:1234. \r

              \                    Product ID can be obtained from the GET /products response."
            nullable: true
            type: string
        - description: Return only events with a matching editorial segment.
          explode: false
          in: query
          name: editorial_segments
          schema:
            description: Return only events with a matching editorial segment.
            items:
              $ref: "#/components/schemas/EditorialSegmentContract"
            nullable: true
            type: array
          style: form
        - description: Restrict search results to embeddable images. The default is false.
          in: query
          name: embed_content_only
          schema:
            default: false
            description: Restrict search results to embeddable images. The default is false.
            type: boolean
        - description: Filter search results based on the ethnicity of individuals in an image.
          explode: false
          in: query
          name: ethnicity
          schema:
            description: Filter search results based on the ethnicity of individuals in an image.
            items:
              $ref: "#/components/schemas/EthnicityFilterType"
            nullable: true
            type: array
          style: form
        - description: Filter based on specific events
          explode: false
          in: query
          name: event_ids
          schema:
            description: Filter based on specific events
            items:
              format: int32
              type: integer
            nullable: true
            type: array
          style: form
        - description: Return only images not tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also do not contain the requested keyword(s) are returned.
          explode: false
          in: query
          name: exclude_keyword_ids
          schema:
            description: Return only images not tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also do not contain the requested keyword(s) are returned.
            items:
              format: int32
              type: integer
            nullable: true
            type: array
          style: form
        - description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
          explode: false
          in: query
          name: fields
          schema:
            description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes, height, and width returned by 'download_sizes' field are estimates."
            items:
              $ref: "#/components/schemas/EditorialImagesFieldValues"
            nullable: true
            type: array
          style: form
        - description: Return only images having a specific file type.
          explode: false
          in: query
          name: file_types
          schema:
            description: Return only images having a specific file type.
            items:
              $ref: "#/components/schemas/SearchFileType"
            nullable: true
            type: array
          style: form
        - description: Filter based on graphical style of the image.
          explode: false
          in: query
          name: graphical_styles
          schema:
            description: Filter based on graphical style of the image.
            items:
              $ref: "#/components/schemas/EditorialGraphicalStyle"
            nullable: true
            type: array
          style: form
        - description: Provides searching based on specified graphical style(s). The default is include.
          in: query
          name: graphical_styles_filter_type
          schema:
            $ref: "#/components/schemas/GraphicalStylesFilterType"
        - description: Specifies whether or not to include related searches in the response. The default is false.
          in: query
          name: include_related_searches
          schema:
            default: false
            description: Specifies whether or not to include related searches in the response. The default is false.
            type: boolean
        - description: Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned.
          explode: false
          in: query
          name: keyword_ids
          schema:
            description: Return only images tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those images matching the query phrase which also contain the requested keyword(s) are returned.
            items:
              format: int32
              type: integer
            nullable: true
            type: array
          style: form
        - description: Filter based on minimum size requested. The default is x-small.
          in: query
          name: minimum_size
          schema:
            $ref: "#/components/schemas/TeeShirtSize"
        - description: Filter based on the number of people in the image.
          explode: false
          in: query
          name: number_of_people
          schema:
            description: Filter based on the number of people in the image.
            items:
              $ref: "#/components/schemas/NumberOfPeopleFilterType"
            nullable: true
            type: array
          style: form
        - description: Return only images with selected aspect ratios.
          explode: false
          in: query
          name: orientations
          schema:
            description: Return only images with selected aspect ratios.
            items:
              $ref: "#/components/schemas/ImageOrientationRequest"
            nullable: true
            type: array
          style: form
        - description: Request results starting at a page number (default is 1).
          in: query
          name: page
          schema:
            default: 1
            description: Request results starting at a page number (default is 1).
            format: int32
            type: integer
        - description: Request number of images to return in each page. Default is 30, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 30
            description: Request number of images to return in each page. Default is 30, maximum page_size is 100.
            format: int32
            type: integer
        - description: Search images using a search phrase.
          in: query
          name: phrase
          schema:
            description: Search images using a search phrase.
            nullable: true
            type: string
        - description: Select sort order of results.  The default is best_match
          in: query
          name: sort_order
          schema:
            $ref: "#/components/schemas/SortOrder"
        - description: Return only images associated with specific people (using a comma-delimited list).
          explode: false
          in: query
          name: specific_people
          schema:
            description: Return only images associated with specific people (using a comma-delimited list).
            items:
              type: string
            nullable: true
            type: array
          style: form
        - description: Filter search results based on minimum quality ranking. Possible values 1, 2, 3 with 1 being best.
          in: query
          name: minimum_quality_rank
          schema:
            description: Filter search results based on minimum quality ranking. Possible values 1, 2, 3 with 1 being best.
            format: int32
            nullable: true
            type: integer
        - description: "Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.\r

            \                   The include_facets parameter must be set to \"true\" for facets to be returned."
          explode: false
          in: query
          name: facet_fields
          schema:
            description: "Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.\r

              \                   The include_facets parameter must be set to \"true\" for facets to be returned."
            items:
              $ref: "#/components/schemas/EditorialImageSearchFacetsFields"
            nullable: true
            type: array
          style: form
        - description: Specifies whether or not to include facets in the result set. Default is "false".
          in: query
          name: include_facets
          schema:
            description: Specifies whether or not to include facets in the result set. Default is "false".
            nullable: true
            type: boolean
        - description: Specifies the maximum number of facets to return per type. Default is 300.
          in: query
          name: facet_max_count
          schema:
            default: 300
            description: Specifies the maximum number of facets to return per type. Default is 300.
            format: int32
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EditorialImageSearchResults"
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
      summary: Search for editorial images only
      tags:
        - Search
  /v3/search/videos/creative:
    get:
      description: |-
        Use this endpoint to search premium stock video, from archival film to contemporary 4K and HD footage.

        You'll need an API key and access token to use this resource.

        You can show different information in the response by specifying values on the "fields" parameter (see details below).
        You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without
        being logged in (anonymous search).  If you are a Getty Images API customer and would like to ensure that your API searches return only 
        assets that you have a license to use, you need to also include an authorization token in the header of your request.
        Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens.

        Search requests without a phrase parameter are not supported and may not always work.

        ## Working with Fields Sets

        Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:

        #### Summary Fields Set

        The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search
        response results. The following fields are provided for every video in your result set when you include **summary_set** in your request.

        ```
        {
            "videos": 
            [
                "asset_family", 
                "caption",
                "collection_code",
                "collection_name",
                "display_sizes":
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "license_model",
                "title"
            ]
        }
        ```

        #### Detail Fields Set

        The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a 
        detailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request.

        ```
        {
            "videos": 
            [
                "allowed_use",
                "artist",
                "asset_family", 
        		"call_for_image",
                "caption", 
                "clip_length",
                "collection_code",
                "collection_id",
                "collection_name", 
                "color_type",
                "copyright",
                "date_created",
                "display_sizes":
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "era",
                "license_model",
                "mastered_to",
                "originally_shot_on",
                "product_types",
                "quality_rank",
                "shot_speed",
                "source",
                "title"
            ]
        }
        ```

        #### Display Fields Set

        The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files 
        that are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result 
        set when you include **display_set** in your request.

        The URI provided is subject to change at any time and must be used as-is with no modification.

        ```
        {
            "videos":
            [
                "display_sizes": 
                [
                    {
                        "is_watermarked": <boolean>,
                        "name": "comp",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "preview",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "thumb",
                        "uri": "<link>"
                    }
                ]
            ]
        }
        ```
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes.
          in: header
          name: GI-Country-Code
          schema:
            description: Use of this parameter requires configuration changes to your API key. Please contact your sales representative to learn more.
            type: string
        - description: Provides filtering according to the age of individuals in a video.
          explode: false
          in: query
          name: age_of_people
          schema:
            description: Provides filtering according to the age of individuals in a video.
            items:
              $ref: "#/components/schemas/AgeOfPeopleFilterType"
            nullable: true
            type: array
          style: form
        - description: Search for videos by specific artists (free-text, comma-separated list of artists).
          in: query
          name: artists
          schema:
            description: Search for videos by specific artists (free-text, comma-separated list of artists).
            nullable: true
            type: string
        - description: Search for videos by specific aspect ratios.
          explode: false
          in: query
          name: aspect_ratios
          schema:
            description: Search for videos by specific aspect ratios.
            items:
              $ref: "#/components/schemas/VideoAspectRatioFilterType"
            nullable: true
            type: array
          style: form
        - description: Provides filtering by collection code.
          explode: false
          in: query
          name: collection_codes
          schema:
            description: Provides filtering by collection code.
            items:
              type: string
            nullable: true
            type: array
          style: form
        - description: Use to include or exclude collections from search. The default is include
          in: query
          name: collections_filter_type
          schema:
            $ref: "#/components/schemas/CollectionsFilterType"
        - description: Filter based on video composition.
          explode: false
          in: query
          name: compositions
          schema:
            description: Filter based on video composition.
            items:
              $ref: "#/components/schemas/CompositionsFilterType"
            nullable: true
            type: array
          style: form
        - description: "Filters based on which product the asset will download against.\r

            \                    Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription.\r

            \                    If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. \r

            \                    For example, some users may have more than one premiumaccess product, so the download_product value would be premiumaccess:1234. \r

            \                    Product ID can be obtained from the GET /products response."
          in: query
          name: download_product
          schema:
            description: "Filters based on which product the asset will download against.\r

              \                    Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription.\r

              \                    If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. \r

              \                    For example, some users may have more than one premiumaccess product, so the download_product value would be premiumaccess:1234. \r

              \                    Product ID can be obtained from the GET /products response."
            nullable: true
            type: string
        - description: Excludes videos containing nudity. The default is false.
          in: query
          name: exclude_nudity
          schema:
            default: false
            description: Excludes videos containing nudity. The default is false.
            type: boolean
        - description: Exclude videos that are only available for editorial (non-commercial) use. Default value is false.
          in: query
          name: exclude_editorial_use_only
          schema:
            description: Exclude videos that are only available for editorial (non-commercial) use. Default value is false.
            nullable: true
            type: boolean
        - description: Return only videos not tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those videos matching the query phrase which also do not contain the requested keyword(s) are returned.
          explode: false
          in: query
          name: exclude_keyword_ids
          schema:
            description: Return only videos not tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those videos matching the query phrase which also do not contain the requested keyword(s) are returned.
            items:
              format: int32
              type: integer
            nullable: true
            type: array
          style: form
        - description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate."
          explode: false
          in: query
          name: fields
          schema:
            description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate."
            items:
              $ref: "#/components/schemas/CreativeVideosFieldValues"
            nullable: true
            type: array
          style: form
        - description: Filters according to the digital video format available on a film asset.
          in: query
          name: format_available
          schema:
            $ref: "#/components/schemas/VideoFormatsRequest"
        - description: Provides filtering by video frame rate (frames/second).
          explode: false
          in: query
          name: frame_rates
          schema:
            description: Provides filtering by video frame rate (frames/second).
            items:
              $ref: "#/components/schemas/VideoFrameRates"
            nullable: true
            type: array
          style: form
        - description: Filter based on image technique.
          explode: false
          in: query
          name: image_techniques
          schema:
            description: Filter based on image technique.
            items:
              $ref: "#/components/schemas/ImageTechniquesFilterType"
            nullable: true
            type: array
          style: form
        - description: Specifies whether or not to include related searches in the response. The default is false.
          in: query
          name: include_related_searches
          schema:
            default: false
            description: Specifies whether or not to include related searches in the response. The default is false.
            type: boolean
        - description: Return only videos tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those videos matching the query phrase which also contain the requested keyword(s) are returned.
          explode: false
          in: query
          name: keyword_ids
          schema:
            description: Return only videos tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those videos matching the query phrase which also contain the requested keyword(s) are returned.
            items:
              format: int32
              type: integer
            nullable: true
            type: array
          style: form
        - description: Specifies the video licensing model(s).
          explode: false
          in: query
          name: license_models
          schema:
            description: Specifies the video licensing model(s).
            items:
              $ref: "#/components/schemas/LicenseModelVideoRequest"
            nullable: true
            type: array
          style: form
        - description: Return only videos with selected orientations.
          explode: false
          in: query
          name: orientations
          schema:
            description: Return only videos with selected orientations.
            items:
              $ref: "#/components/schemas/VideoOrientationRequest"
            nullable: true
            type: array
          style: form
        - description: Provides filtering by minimum length of video clip, in seconds
          in: query
          name: min_clip_length
          schema:
            default: 0
            description: Provides filtering by minimum length of video clip, in seconds
            format: int32
            type: integer
        - description: Provides filtering by maximum length of video, in seconds
          in: query
          name: max_clip_length
          schema:
            default: 0
            description: Provides filtering by maximum length of video, in seconds
            format: int32
            type: integer
        - description: Identifies page to return. Default is 1.
          in: query
          name: page
          schema:
            default: 1
            description: Identifies page to return. Default is 1.
            format: int32
            type: integer
        - description: Specifies page size. Default is 30, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 30
            description: Specifies page size. Default is 30, maximum page_size is 100.
            format: int32
            type: integer
        - description: Free-text search query.
          in: query
          name: phrase
          schema:
            default: ""
            description: Free-text search query.
            nullable: true
            type: string
        - description: Setting safe_search to "true" excludes images containing nudity, death, profanity, drugs and alcohol, suggestive content, and graphic content from the result set. The default is false. Because this is a keyword-based filter, it's possible that a small number of unsafe images may not be caught by the filter. Please direct feedback to your Getty Images Account or API support representative.
          in: query
          name: safe_search
          schema:
            default: false
            description: Setting safe_search to "true" excludes images containing nudity, death, profanity, drugs and alcohol, suggestive content, and graphic content from the result set. The default is false. Because this is a keyword-based filter, it's possible that a small number of unsafe images may not be caught by the filter. Please direct feedback to your Getty Images Account or API support representative.
            type: boolean
        - description: Select sort order of results.  The default is best_match
          in: query
          name: sort_order
          schema:
            $ref: "#/components/schemas/CreativeVideoSortOrder"
        - description: Allows filtering by type of model release.
          in: query
          name: release_status
          schema:
            $ref: "#/components/schemas/ReleaseStatus"
        - description: "Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.\r

            \                   The include_facets parameter must be set to \"true\" for facets to be returned."
          explode: false
          in: query
          name: facet_fields
          schema:
            description: "Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.\r

              \                   The include_facets parameter must be set to \"true\" for facets to be returned."
            items:
              $ref: "#/components/schemas/CreateVideoSearchFacetsFields"
            nullable: true
            type: array
          style: form
        - description: Specifies the maximum number of facets to return per type. Default is 300.
          in: query
          name: facet_max_count
          schema:
            default: 300
            description: Specifies the maximum number of facets to return per type. Default is 300.
            format: int32
            type: integer
        - description: Specifies whether or not to include facets in the result set. Default is "false".
          in: query
          name: include_facets
          schema:
            description: Specifies whether or not to include facets in the result set. Default is "false".
            nullable: true
            type: boolean
        - description: Filter based on viewpoint.
          explode: false
          in: query
          name: viewpoints
          schema:
            description: Filter based on viewpoint.
            items:
              $ref: "#/components/schemas/ViewpointsFilterType"
            nullable: true
            type: array
          style: form
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreativeVideoSearchResults"
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
        "500":
          description: InvalidIStockCollection
      summary: Search for creative videos
      tags:
        - Search
  /v3/search/videos/creative/by-image:
    get:
      description: |
        Search for **similar creative videos** by passing an `image_url` to an uploaded image/frame grab from a video OR an `asset_id` of an asset in our catalog.  All responses will have the `exclude_nudity` filter automatically applied.

        ## Searching by URL

        Before calling the search by image endpoint, an image or frame grab in JPEG format must be uploaded to `https://api.gettyimages.com/v3/search/by-image/uploads/{CLIENT_IMAGE.jpg}`, where the client defines the `{CLIENT_IMAGE.jpg}` portion of the URL.

        For example, using cURL:

        ``` sh
        curl -i -X PUT https://api.gettyimages.com/v3/search/by-image/uploads/my-test-image.jpg -H 'Content-Type: image/jpeg' -H 'Api-Key: API_KEY' --data-binary "@testimage.jpg"
        ```

        Once the image has been uploaded, use the full URL in the `image_url` parameter, e.g. `image_url=https://api.gettyimages.com/v3/search/by-image/uploads/my-test-image.jpg`.

        - Uploaded files must be 10MB or smaller
        - Uploads to the same URL will overwrite each other, so ensure that the client application is handling naming uniqueness appropriately.
        - Uploads expire after 24 hours.
        - Uploads and searches must be performed using the _same_ API Key.

        ## Searching by asset id

        When searching by `asset_id`, any image or video asset id in the Getty/iStock catalog can be used as the source for similar videos.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes.
          in: header
          name: GI-Country-Code
          schema:
            description: Use of this parameter requires configuration changes to your API key. Please contact your sales representative to learn more.
            type: string
        - description: Specifies the Getty video id to use in the search.
          in: query
          name: asset_id
          schema:
            description: Specifies the Getty video id to use in the search.
            nullable: true
            type: string
        - description: Exclude videos that are only available for editorial (non-commercial) use. Default value is false.
          in: query
          name: exclude_editorial_use_only
          schema:
            description: Exclude videos that are only available for editorial (non-commercial) use. Default value is false.
            nullable: true
            type: boolean
        - description: "Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.\r

            \                    The include_facets parameter must be set to \"true\" for facets to be returned."
          explode: false
          in: query
          name: facet_fields
          schema:
            description: "Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.\r

              \                    The include_facets parameter must be set to \"true\" for facets to be returned."
            items:
              $ref: "#/components/schemas/CreateVideoSearchFacetsFields"
            nullable: true
            type: array
          style: form
        - description: Specifies the maximum number of facets to return per type. Default is 300.
          in: query
          name: facet_max_count
          schema:
            default: 300
            description: Specifies the maximum number of facets to return per type. Default is 300.
            format: int32
            type: integer
        - description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate."
          explode: false
          in: query
          name: fields
          schema:
            description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate."
            items:
              $ref: "#/components/schemas/CreativeVideosFieldValues"
            nullable: true
            type: array
          style: form
        - description: Specifies the location of the image to use in the search.
          in: query
          name: image_url
          schema:
            description: Specifies the location of the image to use in the search.
            nullable: true
            type: string
        - description: Specifies whether or not to include facets in the result set. Default is "false".
          in: query
          name: include_facets
          schema:
            description: Specifies whether or not to include facets in the result set. Default is "false".
            nullable: true
            type: boolean
        - description: Request results starting at a page number (default is 1).
          in: query
          name: page
          schema:
            default: 1
            description: Request results starting at a page number (default is 1).
            format: int32
            type: integer
        - description: Request number of images to return in each page. Default is 30, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 30
            description: Request number of images to return in each page. Default is 30, maximum page_size is 100.
            format: int32
            type: integer
        - description: "Filter images to those from one of your product types. \r

            \                    Allowed values are easyaccess, imagepack, premiumaccess and royaltyfreesubscription. \r

            \                    If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. \r

            \                    For example, some users may have more than one premiumaccess product, so the product_types value would be premiumaccess:1234. \r

            \                    Product ID can be obtained from the GET /products response."
          explode: false
          in: query
          name: product_types
          schema:
            description: "Filter images to those from one of your product types. \r

              \                    Allowed values are easyaccess, imagepack, premiumaccess and royaltyfreesubscription. \r

              \                    If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. \r

              \                    For example, some users may have more than one premiumaccess product, so the product_types value would be premiumaccess:1234. \r

              \                    Product ID can be obtained from the GET /products response."
            items:
              type: string
            nullable: true
            type: array
          style: form
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/CreativeVideoSearchResults"
          description: Success
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
        "404":
          description: AssetNotFound
        "500":
          description: InvalidIStockCollection
      summary: Search for creative videos based on url
      tags:
        - Search
  /v3/search/videos/editorial:
    get:
      description: |-
        Use this endpoint to search current and archival video clips of celebrities, newsmakers, and events.

        You'll need an API key and access token to use this resource.

        You can show different information in the response by specifying values on the "fields" parameter (see details below).
        You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search).  If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request.  Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token.

        Search requests without a phrase parameter are not supported and may not always work.

        ## Working with Fields Sets

        Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:

        #### Summary Fields Set

        The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every video in your result set when you include **summary_set** in your request.

        ```
        {
            "videos": 
            [
                "asset_family", 
                "caption",
                "collection_code",
                "collection_name",
                "display_sizes":
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "license_model",
                "title"
            ]
        }
        ```

        #### Detail Fields Set

        The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request.

        ```
        {
            "videos": 
            [
                "allowed_use",
                "artist",
                "asset_family", 
        		"call_for_image",
                "caption", 
                "clip_length",
                "collection_code",
                "collection_id",
                "collection_name", 
                "color_type",
                "copyright",
                "date_created",
                "display_sizes":
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "era",
                "event_ids",
                "license_model",
                "mastered_to",
                "originally_shot_on",
                "product_types",
                "quality_rank",
                "shot_speed",
                "source",
                "title"
            ]
        }
        ```

        #### Display Fields Set

        The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result set when you include **display_set** in your request.

        The URI provided is subject to change at any time and must be used as-is with no modification.

        ```
        {
            "videos":
            [
                "display_sizes": 
                [
                    {
                        "is_watermarked": <boolean>,
                        "name": "comp",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "preview",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "thumb",
                        "uri": "<link>"
                    }
                ]
            ]
        }
        ```
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Receive regionally relevant search results based on the value specified. Accepts only ISO Alpha-3 country codes. The Countries operation can be used to retrieve the codes.
          in: header
          name: GI-Country-Code
          schema:
            description: Use of this parameter requires configuration changes to your API key. Please contact your sales representative to learn more.
            type: string
        - description: Provides filtering according to the age of individuals in a video.
          explode: false
          in: query
          name: age_of_people
          schema:
            description: Provides filtering according to the age of individuals in a video.
            items:
              $ref: "#/components/schemas/AgeOfPeopleFilterType"
            nullable: true
            type: array
          style: form
        - description: Search for videos by specific artists (free-text, comma-separated list of artists).
          in: query
          name: artists
          schema:
            description: Search for videos by specific artists (free-text, comma-separated list of artists).
            nullable: true
            type: string
        - description: Search for videos by specific aspect ratios.
          explode: false
          in: query
          name: aspect_ratios
          schema:
            description: Search for videos by specific aspect ratios.
            items:
              $ref: "#/components/schemas/VideoAspectRatioFilterType"
            nullable: true
            type: array
          style: form
        - description: Provides filtering by collection code.
          explode: false
          in: query
          name: collection_codes
          schema:
            description: Provides filtering by collection code.
            items:
              type: string
            nullable: true
            type: array
          style: form
        - description: Use to include or exclude collections from search. The default is include
          in: query
          name: collections_filter_type
          schema:
            $ref: "#/components/schemas/CollectionsFilterType"
        - description: Filter based on video composition.
          explode: false
          in: query
          name: compositions
          schema:
            description: Filter based on video composition.
            items:
              $ref: "#/components/schemas/CompositionsFilterType"
            nullable: true
            type: array
          style: form
        - description: Return only images that are created on or after this date. Use ISO 8601 format (e.g., 1999-12-31).
          in: query
          name: date_from
          schema:
            description: Return only images that are created on or after this date. Use ISO 8601 format (e.g., 1999-12-31).
            format: date-time
            nullable: true
            type: string
        - description: Return only images that are created on or before this date. Use ISO 8601 format (e.g., 1999-12-31).
          in: query
          name: date_to
          schema:
            description: Return only images that are created on or before this date. Use ISO 8601 format (e.g., 1999-12-31).
            format: date-time
            nullable: true
            type: string
        - description: "Filters based on which product the asset will download against.\r

            \                    Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription.\r

            \                    If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. \r

            \                    For example, some users may have more than one premiumaccess product, so the download_product value would be premiumaccess:1234. \r

            \                    Product ID can be obtained from the GET /products response."
          in: query
          name: download_product
          schema:
            description: "Filters based on which product the asset will download against.\r

              \                    Allowed values are easyaccess, editorialsubscription, imagepack, premiumaccess and royaltyfreesubscription.\r

              \                    If you have more than one instance of a product, you may also include the ID of the product instance you wish to filter on. \r

              \                    For example, some users may have more than one premiumaccess product, so the download_product value would be premiumaccess:1234. \r

              \                    Product ID can be obtained from the GET /products response."
            nullable: true
            type: string
        - description: Allows filtering by types of video.
          explode: false
          in: query
          name: editorial_video_types
          schema:
            description: Allows filtering by types of video.
            items:
              $ref: "#/components/schemas/EditorialVideoType"
            nullable: true
            type: array
          style: form
        - description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate."
          explode: false
          in: query
          name: fields
          schema:
            description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate."
            items:
              $ref: "#/components/schemas/EditorialVideosFieldValues"
            nullable: true
            type: array
          style: form
        - description: Filters according to the digital video format available on a film asset.
          in: query
          name: format_available
          schema:
            $ref: "#/components/schemas/VideoFormatsRequest"
        - description: Provides filtering by video frame rate (frames/second).
          explode: false
          in: query
          name: frame_rates
          schema:
            description: Provides filtering by video frame rate (frames/second).
            items:
              $ref: "#/components/schemas/VideoFrameRates"
            nullable: true
            type: array
          style: form
        - description: Filter based on image technique.
          explode: false
          in: query
          name: image_techniques
          schema:
            description: Filter based on image technique.
            items:
              $ref: "#/components/schemas/ImageTechniquesFilterType"
            nullable: true
            type: array
          style: form
        - description: Specifies whether or not to include related searches in the response. The default is false.
          in: query
          name: include_related_searches
          schema:
            default: false
            description: Specifies whether or not to include related searches in the response. The default is false.
            type: boolean
        - description: Return only videos tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those videos matching the query phrase which also contain the requested keyword(s) are returned.
          explode: false
          in: query
          name: keyword_ids
          schema:
            description: Return only videos tagged with specific keyword(s). Specify using a comma-separated list of keyword Ids. If keyword Ids and phrase are both specified, only those videos matching the query phrase which also contain the requested keyword(s) are returned.
            items:
              format: int32
              type: integer
            nullable: true
            type: array
          style: form
        - description: Provides filtering by minimum length of video clip, in seconds
          in: query
          name: min_clip_length
          schema:
            default: 0
            description: Provides filtering by minimum length of video clip, in seconds
            format: int32
            type: integer
        - description: Provides filtering by maximum length of video clip, in seconds
          in: query
          name: max_clip_length
          schema:
            default: 0
            description: Provides filtering by maximum length of video clip, in seconds
            format: int32
            type: integer
        - description: Return only videos with selected orientations.
          explode: false
          in: query
          name: orientations
          schema:
            description: Return only videos with selected orientations.
            items:
              $ref: "#/components/schemas/VideoOrientationRequest"
            nullable: true
            type: array
          style: form
        - description: Identifies page to return. Default is 1.
          in: query
          name: page
          schema:
            default: 1
            description: Identifies page to return. Default is 1.
            format: int32
            type: integer
        - description: Specifies page size. Default is 30, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 30
            description: Specifies page size. Default is 30, maximum page_size is 100.
            format: int32
            type: integer
        - description: Free-text search query.
          in: query
          name: phrase
          schema:
            default: ""
            description: Free-text search query.
            nullable: true
            type: string
        - description: Select sort order of results.  The default is best_match
          in: query
          name: sort_order
          schema:
            $ref: "#/components/schemas/SortOrder"
        - description: Allows filtering by specific peoples' names.
          explode: false
          in: query
          name: specific_people
          schema:
            description: Allows filtering by specific peoples' names.
            items:
              type: string
            nullable: true
            type: array
          style: form
        - description: Allows filtering by type of model release.
          in: query
          name: release_status
          schema:
            $ref: "#/components/schemas/ReleaseStatus"
        - description: "Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.\r

            \                   The include_facets parameter must be set to \"true\" for facets to be returned."
          explode: false
          in: query
          name: facet_fields
          schema:
            description: "Specifies the facets to return in the response. Facets provide additional search parameters to refine your results.\r

              \                   The include_facets parameter must be set to \"true\" for facets to be returned."
            items:
              $ref: "#/components/schemas/EditorialVideoSearchFacetsFields"
            nullable: true
            type: array
          style: form
        - description: Specifies whether or not to include facets in the result set. Default is "false".
          in: query
          name: include_facets
          schema:
            description: Specifies whether or not to include facets in the result set. Default is "false".
            nullable: true
            type: boolean
        - description: Specifies the maximum number of facets to return per type. Default is 300.
          in: query
          name: facet_max_count
          schema:
            default: 300
            description: Specifies the maximum number of facets to return per type. Default is 300.
            format: int32
            type: integer
        - description: Filter based on viewpoint.
          explode: false
          in: query
          name: viewpoints
          schema:
            description: Filter based on viewpoint.
            items:
              $ref: "#/components/schemas/ViewpointsFilterType"
            nullable: true
            type: array
          style: form
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/EditorialVideoSearchResults"
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
      summary: Search for editorial videos
      tags:
        - Search
  "/v3/usage-batches/{id}":
    put:
      description: |
        # Report Usage

        Use this endpoint to report the usages of a set of assets. The count of assets submitted in a single batch to this endpoint is limited to 1000. Note that all asset Ids specified must be valid or the operation will fail causing no usages to be recorded. In this case, you will need to remove the invalid asset Ids from the query request and re-submit the query.

        ##  Quickstart

        You'll need an API key and a [Resource Owner Grant](http://developers.gettyimages.com/en/authorization-faq.html) access token to use this resource.
        Please see our [Getting Started](http://developers.gettyimages.com/en/getting-started.html) page for more information on how to sign up for an API key. 

        _Note_: Date of use can be in any unambiguous date format.
      parameters:
        - description: Specifies a unique batch transaction id to identify the report.
          in: path
          name: id
          required: true
          schema:
            description: Specifies a unique batch transaction id to identify the report.
            nullable: true
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/report_usage_batch_request"
        description: "Specifies up to 1000 sets of asset Id, usage count, and date of use to submit usages for. \r

          \            Note that all asset Ids specified must be valid or the operation will fail causing no usages to be recorded. \r

          \            All dates must be on or before this date and the format should be ISO 8601 (ex: YYYY-MM-DD), time is not needed."
      responses:
        "201":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/report_usage_batch_response"
          description: Success - All usages reported were successfully recorded.
        "400":
          description: InvalidRequest - The content of the request was invalid. Most commonly this is due to either too many assets specified, no assets or invalid JSON.
        "401":
          description: AuthorizationTokenRequired - Authorization token was missing or not valid.
        "403":
          description: UnauthorizedToReportUsage
        "409":
          description: TransactionIdDuplicated
      summary: Report usage of assets via a batch format.
      tags:
        - Usage
  /v3/videos:
    get:
      description: |
        Use this endpoint to return detailed video metadata for all the specified video ids.

        You'll need an API key and access token to use this resource.

        You can show different information in the response by specifying values on the "fields" parameter (see details below).
        You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search).  If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request.  Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token.

        ## Working with Fields Sets

        Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:

        #### Summary Fields Set

        The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every video in your result set when you include **summary_set** in your request.

        ```
        {
            "videos": 
            [
                "asset_family",
                "caption",
                "collection_code",
                "collection_name",
                "display_sizes":
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "license_model",
                "title"
            ]
        }
        ```

        #### Detail Fields Set

        The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request.

        ```
        {
            "videos": 
            [
                "allowed_use",
                "artist",
                "asset_family",
        		"call_for_image",
                "caption",
                "clip_length",
                "collection_code",
                "collection_id",
                "collection_name",
                "color_type",
                "copyright",
                "date_created",
                "display_sizes":
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "download_sizes",
                "era",
                "event_ids",
                "license_model",
                "mastered_to",
                "originally_shot_on",
                "product_types",
                "quality_rank",
                "shot_speed",
                "source",
                "title"
            ]
        }
        ```

        #### Display Fields Set

        The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result set when you include **display_set** in your request.

        The URI provided is subject to change at any time and must be used as-is with no modification.

        ```
        {
            "videos":
            [
              {
                "display_sizes": 
                [
                    {
                        "is_watermarked": <boolean>,
                        "name": "comp",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "preview",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "thumb",
                        "uri": "<link>"
                    }
                ],
                "key_frames": [
                    {
                      "uri": "<link>"
                    },
                    {
                      "uri": "<link>"
                    },
                    {
                      "uri": "<link>"
                    },
                    {
                      "uri": "<link>"
                    },
                    {
                      "uri": "<link>"
                    }
                ]
              }
            ]
        }
        ```

        ## Request Usage Considerations

        - Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Specifies one or more video ids to return. Use comma delimiter when requesting multiple ids.  Maximum of 100 ids.
          explode: false
          in: query
          name: ids
          schema:
            description: Specifies one or more video ids to return. Use comma delimiter when requesting multiple ids.  Maximum of 100 ids.
            items:
              type: string
            nullable: true
            type: array
          style: form
        - description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate."
          explode: false
          in: query
          name: fields
          schema:
            description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate."
            items:
              $ref: "#/components/schemas/VideoDetailFieldValues"
            nullable: true
            type: array
          style: form
      responses:
        "200":
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
        "404":
          description: VideosNotFound
        "500":
          description: InvalidIStockCollection
      summary: Get metadata for multiple videos by supplying multiple video ids
      tags:
        - Videos
  "/v3/videos/{id}":
    get:
      description: |
        Use this endpoint to return detailed video metadata for the specified video id.

        You'll need an API key and access token to use this resource.

        You can show different information in the response by specifying values on the "fields" parameter (see details below).
        You can search with only an API key, and that will give you search results that are equivalent to doing a search on the GettyImages.com site without being logged in (anonymous search).  If you are a Getty Images API customer and would like to ensure that your API searches return only assets that you have a license to use, you need to also include an authorization token in the header of your request.  Please consult our [Authorization FAQ](http://developers.gettyimages.com/en/authorization-faq.html) for more information on authorization tokens, and our [Authorization Workflows](https://github.com/gettyimages/gettyimages-api/blob/master/OAuth2Workflow.md) for code examples of getting a token.

        ## Working with Fields Sets

        Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:

        #### Summary Fields Set

        The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every video in your result set when you include **summary_set** in your request.

        ```
        {
            "videos":
            [
                "asset_family",
                "caption",
                "collection_code",
                "collection_name",
                "display_sizes":
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "license_model",
                "title"
            ]
        }
        ```

        #### Detail Fields Set

        The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request.

        ```
        {
            "videos":
            [
                "allowed_use",
                "artist",
                "asset_family",
        		"call_for_image",
                "caption",
                "clip_length",
                "collection_code",
                "collection_id",
                "collection_name",
                "color_type",
                "copyright",
                "date_created",
                "display_sizes":
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "download_sizes",
                "era",
                "event_ids",
                "license_model",
                "mastered_to",
                "originally_shot_on",
                "product_types",
                "quality_rank",
                "shot_speed",
                "source",
                "title"
            ]
        }
        ```

        #### Display Fields Set

        The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result set when you include **display_set** in your request.

        The URI provided is subject to change at any time and must be used as-is with no modification.

        ```
        {
            "display_sizes": [
                {
                    "is_watermarked": <boolean>,
                    "name": "comp",
                    "uri": "<link>"
                },
                {
                    "is_watermarked": <boolean>,
                    "name": "preview",
                    "uri": "<link>"
                },
                {
                    "is_watermarked": <boolean>,
                    "name": "thumb",
                    "uri": "<link>"
                }
            ],
            "key_frames": [
                {
                    "uri": "<link>"
                },
                {
                    "uri": "<link>"
                },
                {
                    "uri": "<link>"
                },
                {
                    "uri": "<link>"
                },
                {
                    "uri": "<link>"
                }
            ]
        }
        ```

        ## Request Usage Considerations

        - Specifying the "entity_details" response field can have significant performance implications. The field should be used only when necessary.
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: A video id. For more than one video please use the /v3/video endpoint.
          in: path
          name: id
          required: true
          schema:
            description: A video id. For more than one video please use the /v3/video endpoint.
            nullable: true
            type: string
        - description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate."
          explode: false
          in: query
          name: fields
          schema:
            description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate."
            items:
              $ref: "#/components/schemas/VideoDetailFieldValues"
            nullable: true
            type: array
          style: form
      responses:
        "200":
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
        "404":
          description: VideosNotFound
        "500":
          description: InvalidIStockCollection
      summary: Get metadata for a single video by supplying one video id
      tags:
        - Videos
  "/v3/videos/{id}/downloadhistory":
    get:
      description: ""
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: A video id.
          in: path
          name: id
          required: true
          schema:
            description: A video id.
            nullable: true
            type: string
        - description: "If specified, returns the list of previously downloaded videos for all users in your company.\r

            \            Your account must be enabled for this functionality. Contact your Getty Images account rep for more information. Default is false."
          in: query
          name: company_downloads
          schema:
            description: "If specified, returns the list of previously downloaded videos for all users in your company.\r

              \            Your account must be enabled for this functionality. Contact your Getty Images account rep for more information. Default is false."
            type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AssetDownloadHistoryResults"
          description: OK
        "400":
          description: Bad request
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
        "404":
          description: VideosNotFound
        "500":
          description: InvalidIStockCollection
      summary: Returns information about a customer's download history for a specific asset
      tags:
        - Videos
  "/v3/videos/{id}/same-series":
    get:
      description: |
        This endpoint will provide the list of videos, if any exist, from the same series as the specified creative asset id. These images are typically from the same photo shoot. This functionality will not work for editorial assets.

        You'll need an API key and access token to use this resource.

        ## Working with Fields Sets

        Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:

        #### Summary Fields Set

        The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every video in your result set when you include **summary_set** in your request.

        ```
        {
            "videos":
            [
                "asset_family",
                "caption",
                "collection_code",
                "collection_name",
                "display_sizes":
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "license_model",
                "title"
            ]
        }
        ```

        #### Detail Fields Set

        The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request.

        ```
        {
            "videos":
            [
                "allowed_use",
                "artist",
                "asset_family",
        		"call_for_image",
                "caption",
                "clip_length",
                "collection_code",
                "collection_id",
                "collection_name",
                "color_type",
                "copyright",
                "date_created",
                "display_sizes":
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "download_sizes",
                "era",
                "license_model",
                "mastered_to",
                "originally_shot_on",
                "product_types",
                "quality_rank",
                "shot_speed",
                "source",
                "title"
            ]
        }
        ```

        #### Display Fields Set

        The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result set when you include **display_set** in your request.

        The URI provided is subject to change at any time and must be used as-is with no modification.

        ```
        {
            "videos":
            [
                "display_sizes": 
                [
                    {
                        "is_watermarked": <boolean>,
                        "name": "comp",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "preview",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "thumb",
                        "uri": "<link>"
                    }
                ]
            ]
        }
        ```
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: Identifies an existing video
          in: path
          name: id
          required: true
          schema:
            description: Identifies an existing video
            nullable: true
            type: string
        - description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate."
          explode: false
          in: query
          name: fields
          schema:
            description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate."
            items:
              $ref: "#/components/schemas/AssociatedVideoDetailFieldValues"
            nullable: true
            type: array
          style: form
        - description: Identifies page to return. Default is 1.
          in: query
          name: page
          schema:
            default: 1
            description: Identifies page to return. Default is 1.
            format: int32
            type: integer
        - description: Specifies page size. Default is 30, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 30
            description: Specifies page size. Default is 30, maximum page_size is 100.
            format: int32
            type: integer
      responses:
        "200":
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
        "404":
          description: VideosNotFound
        "500":
          description: InvalidIStockCollection
      summary: Retrieve creative videos from the same series
      tags:
        - Videos
  "/v3/videos/{id}/similar":
    get:
      description: |-
        This endpoint will provide a list of videos that are similar to the specified asset id.

        You'll need an API key and access token to use this resource.

        ## Working with Fields Sets

        Fields sets are used in the **fields** request parameter to receive a suite of metadata fields. The following fields sets are available:

        #### Summary Fields Set

        The **summary_set** query string parameter fields value represents a small batch of metadata fields that are often used to build search response results. The following fields are provided for every video in your result set when you include **summary_set** in your request.

        ```
        {
            "videos": 
            [
                "asset_family",
                "caption",
                "collection_code",
                "collection_name",
                "display_sizes":
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "license_model",
                "title"
            ]
        }
        ```

        #### Detail Fields Set

        The **detail_set** query string parameter fields value represents a large batch of metadata fields that are often used to build a detailed view of videos. The following fields are provided for every video in your result set when you include **detail_set** in your request.

        ```
        {
            "videos": 
            [
                "allowed_use",
                "artist",
                "asset_family",
        		"call_for_image",
                "caption",
                "clip_length",
                "collection_code",
                "collection_id",
                "collection_name",
                "color_type",
                "copyright",
                "date_created",
                "display_sizes":
                [
                    {
                        "name": "comp"
                    },
                    {
                        "name": "preview"
                    },
                    {
                        "name": "thumb"
                    }
                ],
                "download_sizes",
                "era",
                "event_ids",
                "license_model",
                "mastered_to",
                "originally_shot_on",
                "product_types",
                "quality_rank",
                "shot_speed",
                "source",
                "title"
            ]
        }
        ```

        #### Display Fields Set

        The **display_set** query string parameter fields value represents the fields that provide you with URLs for the low resolution files that are most frequently used to build a UI displaying search results. The following fields are provided for every video in your result set when you include **display_set** in your request.

        The URI provided is subject to change at any time and must be used as-is with no modification.

        ```
        {
            "videos":
            [
                "display_sizes": 
                [
                    {
                        "is_watermarked": <boolean>,
                        "name": "comp",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "preview",
                        "uri": "<link>"
                    },
                    {
                        "is_watermarked": <boolean>,
                        "name": "thumb",
                        "uri": "<link>"
                    }
                ]
            ]
        }
        ```
      parameters:
        - description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
          in: header
          name: Accept-Language
          schema:
            description: "Provide a header to specify the language of result values. Supported values: cs (iStock only), de, en-GB, en-US, es, fi (iStock only), fr, hu (iStock only), id (iStock only), it, ja, ko (creative assets only), nl, pl (creative assets only), pt-BR, pt-PT, ro (iStock only), ru (creative assets only), sv, th (iStock only), tr, uk (iStock only), vi (iStock only), zh-HK (creative assets only)."
            type: string
        - description: A video id.
          in: path
          name: id
          required: true
          schema:
            description: A video id.
            nullable: true
            type: string
        - description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate."
          explode: false
          in: query
          name: fields
          schema:
            description: "Specifies fields to return. Defaults to 'summary_set'. NOTE: Bytes returned by 'download_sizes' field is an estimate."
            items:
              $ref: "#/components/schemas/AssociatedVideoDetailFieldValues"
            nullable: true
            type: array
          style: form
        - description: Identifies page to return. Default is 1.
          in: query
          name: page
          schema:
            default: 1
            description: Identifies page to return. Default is 1.
            format: int32
            type: integer
        - description: Specifies page size. Default is 30, maximum page_size is 100.
          in: query
          name: page_size
          schema:
            default: 30
            description: Specifies page size. Default is 30, maximum page_size is 100.
            format: int32
            type: integer
      responses:
        "200":
          description: OK
        "400":
          description: InvalidParameterValue
        "401":
          description: AuthorizationTokenRequired
        "403":
          description: UnauthorizedDisplaySize
        "404":
          description: VideosNotFound
        "500":
          description: InvalidIStockCollection
      summary: Retrieve similar videos
      tags:
        - Videos
components:
  schemas:
    AcquireAssetLicensesRequest:
      additionalProperties: false
      properties:
        extended_licenses:
          items:
            $ref: "#/components/schemas/ExtendedLicenses"
          type: array
        use_team_credits:
          description: Defaults to false.
          type: boolean
      required:
        - extended_licenses
      type: object
    AddBoardAssetsResult:
      additionalProperties: false
      properties:
        assets_added:
          items:
            $ref: "#/components/schemas/BoardAsset"
          nullable: true
          type: array
        assets_not_added:
          items:
            type: string
          nullable: true
          type: array
      type: object
    AffiliateImage:
      additionalProperties: false
      properties:
        caption:
          nullable: true
          type: string
        destination_url:
          nullable: true
          type: string
        id:
          nullable: true
          type: string
        preview_urls:
          $ref: "#/components/schemas/AffiliateImageUrls"
        title:
          nullable: true
          type: string
      type: object
    AffiliateImageSearchResponse:
      additionalProperties: false
      properties:
        auto_corrections:
          $ref: "#/components/schemas/AutoCorrections"
        images:
          items:
            $ref: "#/components/schemas/AffiliateImage"
          nullable: true
          type: array
      type: object
    AffiliateImageUrls:
      additionalProperties: false
      properties:
        large:
          nullable: true
          type: string
        large_height:
          format: int32
          type: integer
        large_width:
          format: int32
          type: integer
        medium:
          nullable: true
          type: string
        medium_height:
          format: int32
          type: integer
        medium_width:
          format: int32
          type: integer
        small:
          nullable: true
          type: string
        small_height:
          format: int32
          type: integer
        small_width:
          format: int32
          type: integer
      type: object
    AffiliateSearchStyle:
      description: Specifies the graphical style of images desired.
      enum:
        - photography
        - vector
      type: string
    AffiliateVideo:
      additionalProperties: false
      properties:
        caption:
          nullable: true
          type: string
        clip_length:
          nullable: true
          type: string
        destination_url:
          nullable: true
          type: string
        id:
          nullable: true
          type: string
        preview_urls:
          $ref: "#/components/schemas/AffiliateVideoUrls"
        title:
          nullable: true
          type: string
      type: object
    AffiliateVideoSearchResponse:
      additionalProperties: false
      properties:
        auto_corrections:
          $ref: "#/components/schemas/AutoCorrections"
        videos:
          items:
            $ref: "#/components/schemas/AffiliateVideo"
          nullable: true
          type: array
      type: object
    AffiliateVideoUrls:
      additionalProperties: false
      properties:
        large_motion:
          nullable: true
          type: string
        large_still:
          nullable: true
          type: string
        medium_still:
          nullable: true
          type: string
        small_motion:
          nullable: true
          type: string
        small_still:
          nullable: true
          type: string
      type: object
    AgeOfPeopleFilterType:
      enum:
        - newborn
        - baby
        - child
        - teenager
        - young_adult
        - adult
        - adults_only
        - mature_adult
        - senior_adult
        - 0-1_months
        - 2-5_months
        - 6-11_months
        - 12-17_months
        - 18-23_months
        - 2-3_years
        - 4-5_years
        - 6-7_years
        - 8-9_years
        - 10-11_years
        - 12-13_years
        - 14-15_years
        - 16-17_years
        - 18-19_years
        - 20-24_years
        - 20-29_years
        - 25-29_years
        - 30-34_years
        - 30-39_years
        - 35-39_years
        - 40-44_years
        - 40-49_years
        - 45-49_years
        - 50-54_years
        - 50-59_years
        - 55-59_years
        - 60-64_years
        - 60-69_years
        - 65-69_years
        - 70-79_years
        - 80-89_years
        - 90_plus_years
        - 100_over
      type: string
    AllowedUse:
      additionalProperties: false
      properties:
        how_can_i_use_it:
          description: Indicates how the asset can be used
          nullable: true
          type: string
        release_info:
          description: Indicates release status
          nullable: true
          type: string
        usage_restrictions:
          description: Indicates asset usage restriction, if any
          items:
            type: string
          nullable: true
          type: array
      type: object
    Artist:
      additionalProperties: false
      properties:
        name:
          nullable: true
          type: string
      type: object
    ArtistsImageSearchFieldValues:
      enum:
        - id
        - allowed_use
        - alternative_ids
        - artist
        - asset_family
        - asset_type
        - call_for_image
        - caption
        - collection_id
        - collection_code
        - collection_name
        - comp
        - copyright
        - date_created
        - date_submitted
        - detail_set
        - display_set
        - editorial_segments
        - event_ids
        - graphical_style
        - keywords
        - license_model
        - max_dimensions
        - orientation
        - preview
        - product_types
        - quality_rank
        - referral_destinations
        - summary_set
        - thumb
        - title
      type: string
    ArtistsVideoSearchFieldValues:
      enum:
        - id
        - allowed_use
        - alternative_ids
        - artist
        - asset_family
        - asset_type
        - call_for_image
        - caption
        - clip_length
        - collection_id
        - collection_code
        - collection_name
        - comp
        - copyright
        - date_created
        - date_submitted
        - detail_set
        - display_set
        - editorial_segments
        - event_ids
        - graphical_style
        - keywords
        - license_model
        - max_dimensions
        - orientation
        - preview
        - product_types
        - quality_rank
        - referral_destinations
        - summary_set
        - thumb
        - title
      type: string
    Asset:
      additionalProperties: false
      properties:
        asset_type:
          nullable: true
          type: string
        date_added:
          format: date-time
          type: string
        display_sizes:
          items:
            $ref: "#/components/schemas/DisplaySize"
          nullable: true
          type: array
        id:
          nullable: true
          type: string
      type: object
    AssetChanges:
      additionalProperties: false
      properties:
        change_set_id:
          description: Contains the identifier for the change-set resource. Passed into ConfirmAssetChanges requests to confirm receipt of the asset changes in the response.
          nullable: true
          type: string
        changed_assets:
          description: Contains a list of ChangedAssetList results for the query.
          items:
            $ref: "#/components/schemas/ChangedAssetDetail"
          nullable: true
          type: array
      type: object
    AssetDownloadHistoryResults:
      additionalProperties: false
      properties:
        downloads:
          nullable: true
        id:
          nullable: true
          type: string
      type: object
    AssetEvent:
      additionalProperties: false
      properties:
        asset_id:
          nullable: true
          type: string
        email_address:
          nullable: true
          type: string
        timestamp:
          format: date-time
          type: string
      type: object
    AssetFamily:
      enum:
        - NotSet
        - Editorial
        - Creative
        - Both
      type: string
    AssetIdFromOrder:
      additionalProperties: false
      properties:
        id:
          nullable: true
          type: string
      type: object
    AssetLicenseName:
      enum:
        - Standard
        - Multiseat
        - Unlimited
        - Resale
        - Indemnification
      type: string
    AssetLicensingResponse:
      additionalProperties: false
      properties:
        acquired_licenses:
          items:
            $ref: "#/components/schemas/ExtendedLicenses"
          nullable: true
          type: array
        credits_used:
          format: int32
          type: integer
      type: object
    AssetType:
      enum:
        - NotSet
        - Image
        - Film
        - Music
      type: string
    AssociatedVideoDetailFieldValues:
      enum:
        - allowed_use
        - artist
        - aspect_ratio
        - asset_family
        - call_for_image
        - caption
        - clip_length
        - collection_code
        - collection_id
        - collection_name
        - color_type
        - comp
        - copyright
        - date_created
        - date_submitted
        - detail_set
        - display_set
        - download_product
        - download_sizes
        - editorial_segments
        - entity_details
        - era
        - event_ids
        - id
        - istock_collection
        - keywords
        - largest_downloads
        - license_model
        - mastered_to
        - orientation
        - originally_shot_on
        - preview
        - product_types
        - quality_rank
        - referral_destinations
        - shot_speed
        - source
        - summary_set
        - thumb
        - title
        - istock_licenses
      type: string
    AutoCorrections:
      additionalProperties: false
      properties:
        phrase:
          nullable: true
          type: string
      type: object
    BlendedImageSortOrder:
      enum:
        - best_match
        - most_popular
        - newest
        - random
      type: string
    BlendedVideoSearchItem:
      additionalProperties: false
      properties:
        allowed_use:
          $ref: "#/components/schemas/AllowedUse"
        artist:
          nullable: true
          type: string
        asset_family:
          nullable: true
          type: string
        caption:
          nullable: true
          type: string
        clip_length:
          nullable: true
          type: string
        collection_code:
          nullable: true
          type: string
        collection_id:
          format: int32
          nullable: true
          type: integer
        collection_name:
          nullable: true
          type: string
        color_type:
          nullable: true
          type: string
        copyright:
          nullable: true
          type: string
        date_created:
          format: date-time
          nullable: true
          type: string
        display_sizes:
          items:
            $ref: "#/components/schemas/VideoSearchItemDisplaySize"
          nullable: true
          type: array
        download_product:
          nullable: true
          type: string
        era:
          nullable: true
          type: string
        event_ids:
          items:
            format: int32
            type: integer
          nullable: true
          type: array
        id:
          nullable: true
          type: string
        istock_licenses:
          items:
            $ref: "#/components/schemas/IStockLicense"
          nullable: true
          type: array
        keywords:
          items:
            $ref: "#/components/schemas/Keyword"
          nullable: true
          type: array
        largest_downloads:
          items:
            $ref: "#/components/schemas/Download"
          nullable: true
          type: array
        license_model:
          nullable: true
          type: string
        mastered_to:
          nullable: true
          type: string
        originally_shot_on:
          nullable: true
          type: string
        product_types:
          items:
            type: string
          nullable: true
          type: array
        referral_destinations:
          items:
            $ref: "#/components/schemas/ReferralDestination"
          nullable: true
          type: array
        shot_speed:
          nullable: true
          type: string
        source:
          nullable: true
          type: string
        title:
          nullable: true
          type: string
      type: object
    BlendedVideoSearchResults:
      additionalProperties: false
      properties:
        facets:
          $ref: "#/components/schemas/SearchFacetsResponse"
        related_searches:
          items:
            $ref: "#/components/schemas/RelatedSearch"
          nullable: true
          type: array
        result_count:
          format: int32
          type: integer
        videos:
          items:
            $ref: "#/components/schemas/BlendedVideoSearchItem"
          nullable: true
          type: array
      type: object
    BlendedVideosFieldValues:
      enum:
        - allowed_use
        - artist
        - aspect_ratio
        - asset_family
        - call_for_image
        - caption
        - clip_length
        - collection_code
        - collection_id
        - collection_name
        - color_type
        - comp
        - copyright
        - date_created
        - date_submitted
        - detail_set
        - display_set
        - download_product
        - download_sizes
        - editorial_segments
        - entity_details
        - era
        - event_ids
        - id
        - istock_collection
        - keywords
        - largest_downloads
        - license_model
        - mastered_to
        - object_name
        - orientation
        - originally_shot_on
        - preview
        - product_types
        - quality_rank
        - referral_destinations
        - shot_speed
        - source
        - summary_set
        - thumb
        - title
        - istock_licenses
      type: string
    BoardAsset:
      additionalProperties: false
      properties:
        asset_id:
          type: string
      required:
        - asset_id
      type: object
    BoardCommentPermissions:
      additionalProperties: false
      properties:
        can_add_comment:
          type: boolean
      type: object
    BoardCreated:
      additionalProperties: false
      properties:
        id:
          nullable: true
          type: string
      type: object
    BoardDetail:
      additionalProperties: false
      properties:
        asset_count:
          format: int32
          type: integer
        assets:
          items:
            $ref: "#/components/schemas/Asset"
          nullable: true
          type: array
        comment_count:
          format: int32
          type: integer
        date_created:
          format: date-time
          type: string
        date_last_updated:
          format: date-time
          type: string
        description:
          nullable: true
          type: string
        id:
          nullable: true
          type: string
        links:
          $ref: "#/components/schemas/Links"
        name:
          nullable: true
          type: string
        permissions:
          $ref: "#/components/schemas/BoardPermissions"
      type: object
    BoardInfo:
      additionalProperties: false
      properties:
        description:
          nullable: true
          type: string
        name:
          type: string
      required:
        - name
      type: object
    BoardList:
      additionalProperties: false
      properties:
        board_count:
          format: int32
          type: integer
        boards:
          items:
            $ref: "#/components/schemas/BoardListBoard"
          nullable: true
          type: array
      type: object
    BoardListBoard:
      additionalProperties: false
      properties:
        asset_count:
          format: int32
          type: integer
        board_relationship:
          nullable: true
          type: string
        date_created:
          format: date-time
          type: string
        date_last_updated:
          format: date-time
          type: string
        description:
          nullable: true
          type: string
        hero_asset:
          $ref: "#/components/schemas/Asset"
        id:
          nullable: true
          type: string
        name:
          nullable: true
          type: string
      type: object
    BoardPermissions:
      additionalProperties: false
      properties:
        can_add_assets:
          type: boolean
        can_delete_board:
          type: boolean
        can_invite_to_board:
          type: boolean
        can_remove_assets:
          type: boolean
        can_update_description:
          type: boolean
        can_update_name:
          type: boolean
      type: object
    BoardRelationship:
      enum:
        - owned
        - invited
      type: string
    BoardSortOrder:
      enum:
        - date_last_updated_descending
        - date_last_updated_ascending
        - name_ascending
        - name_decending
      type: string
    ChangedAssetDetail:
      additionalProperties: false
      properties:
        asset_changed_utc_datetime:
          description: Contains the date of the asset change.
          format: date-time
          type: string
        asset_lifecycle:
          description: Contains the type of change this asset change is. (i.e. "New," "Updated" or "Deleted")
          nullable: true
          type: string
        asset_type:
          description: Contains the type of asset this asset change is (i.e. "Image").
          nullable: true
          type: string
        id:
          description: Contains the Id for the asset change.
          nullable: true
          type: string
        uri:
          description: Contains the asset download URL for assets with an AssetLifecycle of "New."
          nullable: true
          type: string
      type: object
    Channel:
      additionalProperties: false
      properties:
        AssetChangeType:
          nullable: true
          type: string
        AssetFamily:
          $ref: "#/components/schemas/AssetFamily"
        AssetType:
          $ref: "#/components/schemas/AssetType"
        ChannelId:
          format: int32
          type: integer
        CreateDateUtc:
          format: date-time
          type: string
        Metadata:
          nullable: true
          type: string
        NotificationCount:
          format: int32
          type: integer
        OldestChangeNotificationDateUtc:
          format: date-time
          type: string
      type: object
    Collaborator:
      additionalProperties: false
      properties:
        first_name:
          nullable: true
          type: string
        last_name:
          nullable: true
          type: string
      type: object
    Collection:
      additionalProperties: false
      properties:
        asset_family:
          nullable: true
          type: string
        code:
          nullable: true
          type: string
        id:
          format: int32
          type: integer
        license_model:
          nullable: true
          type: string
        name:
          nullable: true
          type: string
        product_types:
          items:
            type: string
          nullable: true
          type: array
      type: object
    CollectionsFilterType:
      enum:
        - include
        - exclude
      type: string
    CollectionsList:
      additionalProperties: false
      properties:
        collections:
          items:
            $ref: "#/components/schemas/Collection"
          nullable: true
          type: array
      type: object
    Comment:
      additionalProperties: false
      properties:
        created_by:
          $ref: "#/components/schemas/Collaborator"
        date_created:
          format: date-time
          type: string
        id:
          nullable: true
          type: string
        permissions:
          $ref: "#/components/schemas/CommentPermissions"
        text:
          nullable: true
          type: string
      type: object
    CommentCreated:
      additionalProperties: false
      properties:
        id:
          nullable: true
          type: string
      type: object
    CommentPermissions:
      additionalProperties: false
      properties:
        can_delete_comment:
          type: boolean
      type: object
    CommentRequest:
      additionalProperties: false
      properties:
        text:
          nullable: true
          type: string
      type: object
    CommentsList:
      additionalProperties: false
      properties:
        comments:
          items:
            $ref: "#/components/schemas/Comment"
          nullable: true
          type: array
        permissions:
          $ref: "#/components/schemas/BoardCommentPermissions"
      type: object
    CompositionsFilterType:
      enum:
        - abstract
        - candid
        - close_up
        - copy_space
        - cut_out
        - full_frame
        - full_length
        - headshot
        - looking_at_camera
        - macro
        - portrait
        - sparse
        - still_life
        - three_quarter_length
        - waist_up
      type: string
    Contributor:
      additionalProperties: false
      description: Contributor information for an image or video
      properties:
        display_name:
          description: The contributor's display name
          nullable: true
          type: string
        member_name:
          description: The contributor's member name
          nullable: true
          type: string
      type: object
    CountriesList:
      additionalProperties: false
      properties:
        countries:
          items:
            $ref: "#/components/schemas/Country"
          nullable: true
          type: array
      type: object
    Country:
      additionalProperties: false
      properties:
        iso_alpha_2:
          nullable: true
          type: string
        iso_alpha_3:
          nullable: true
          type: string
        name:
          nullable: true
          type: string
      type: object
    CreateImageSearchFacetsFields:
      enum:
        - artists
        - locations
      type: string
    CreateVideoSearchFacetsFields:
      enum:
        - artists
        - locations
      type: string
    CreativeImageSearchResults:
      additionalProperties: false
      properties:
        auto_corrections:
          $ref: "#/components/schemas/AutoCorrections"
        images:
          items:
            $ref: "#/components/schemas/ImageSearchItemCreative"
          nullable: true
          type: array
        related_searches:
          items:
            $ref: "#/components/schemas/RelatedSearch"
          nullable: true
          type: array
        result_count:
          format: int32
          type: integer
      type: object
    CreativeImageSortOrder:
      enum:
        - best_match
        - most_popular
        - newest
        - random
      type: string
    CreativeImagesFieldValues:
      enum:
        - allowed_use
        - alternative_ids
        - artist
        - asset_family
        - call_for_image
        - caption
        - collection_code
        - collection_id
        - collection_name
        - color_type
        - comp
        - copyright
        - date_camera_shot
        - date_created
        - date_submitted
        - detail_set
        - display_set
        - download_product
        - download_sizes
        - graphical_style
        - id
        - istock_collection
        - keywords
        - largest_downloads
        - license_model
        - max_dimensions
        - orientation
        - preview
        - product_types
        - quality_rank
        - referral_destinations
        - summary_set
        - thumb
        - title
        - uri_oembed
      type: string
    CreativeVideoSearchItem:
      additionalProperties: false
      properties:
        allowed_use:
          $ref: "#/components/schemas/AllowedUse"
        artist:
          nullable: true
          type: string
        asset_family:
          nullable: true
          type: string
        caption:
          nullable: true
          type: string
        clip_length:
          nullable: true
          type: string
        collection_code:
          nullable: true
          type: string
        collection_id:
          format: int32
          nullable: true
          type: integer
        collection_name:
          nullable: true
          type: string
        color_type:
          nullable: true
          type: string
        copyright:
          nullable: true
          type: string
        date_created:
          format: date-time
          nullable: true
          type: string
        display_sizes:
          items:
            $ref: "#/components/schemas/VideoSearchItemDisplaySize"
          nullable: true
          type: array
        download_product:
          nullable: true
          type: string
        era:
          nullable: true
          type: string
        event_ids:
          items:
            format: int32
            type: integer
          nullable: true
          type: array
        id:
          nullable: true
          type: string
        istock_licenses:
          items:
            $ref: "#/components/schemas/IStockLicense"
          nullable: true
          type: array
        keywords:
          items:
            $ref: "#/components/schemas/Keyword"
          nullable: true
          type: array
        largest_downloads:
          items:
            $ref: "#/components/schemas/Download"
          nullable: true
          type: array
        license_model:
          nullable: true
          type: string
        mastered_to:
          nullable: true
          type: string
        originally_shot_on:
          nullable: true
          type: string
        product_types:
          items:
            type: string
          nullable: true
          type: array
        referral_destinations:
          items:
            $ref: "#/components/schemas/ReferralDestination"
          nullable: true
          type: array
        shot_speed:
          nullable: true
          type: string
        title:
          nullable: true
          type: string
      type: object
    CreativeVideoSearchResults:
      additionalProperties: false
      properties:
        auto_corrections:
          $ref: "#/components/schemas/AutoCorrections"
        facets:
          $ref: "#/components/schemas/SearchFacetsResponse"
        related_searches:
          items:
            $ref: "#/components/schemas/RelatedSearch"
          nullable: true
          type: array
        result_count:
          format: int32
          type: integer
        videos:
          items:
            $ref: "#/components/schemas/CreativeVideoSearchItem"
          nullable: true
          type: array
      type: object
    CreativeVideoSortOrder:
      enum:
        - best_match
        - most_popular
        - newest
        - random
      type: string
    CreativeVideosFieldValues:
      enum:
        - allowed_use
        - artist
        - aspect_ratio
        - asset_family
        - call_for_image
        - caption
        - clip_length
        - collection_code
        - collection_id
        - collection_name
        - color_type
        - comp
        - copyright
        - date_created
        - date_submitted
        - detail_set
        - display_set
        - download_product
        - download_sizes
        - era
        - id
        - istock_collection
        - keywords
        - largest_downloads
        - license_model
        - mastered_to
        - object_name
        - orientation
        - originally_shot_on
        - preview
        - product_types
        - quality_rank
        - referral_destinations
        - shot_speed
        - summary_set
        - thumb
        - title
      type: string
    CuratedSet:
      additionalProperties: false
      properties:
        assets:
          items:
            type: string
          nullable: true
          type: array
        date_created:
          format: date-time
          nullable: true
          type: string
        date_last_updated:
          format: date-time
          nullable: true
          type: string
        description:
          nullable: true
          type: string
        hero_image_uri:
          nullable: true
          type: string
        keywords:
          items:
            type: string
          nullable: true
          type: array
        set_id:
          nullable: true
          type: string
        title:
          nullable: true
          type: string
      type: object
    CustomerInfoResponse:
      additionalProperties: false
      properties:
        first_name:
          nullable: true
          type: string
        last_name:
          nullable: true
          type: string
        middle_name:
          nullable: true
          type: string
      type: object
    Dimensions:
      additionalProperties: false
      properties:
        dpi:
          format: int32
          nullable: true
          type: integer
        height:
          format: int32
          nullable: true
          type: integer
        width:
          format: int32
          nullable: true
          type: integer
      type: object
    DisplaySize:
      additionalProperties: false
      properties:
        name:
          nullable: true
          type: string
        uri:
          nullable: true
          type: string
      type: object
    Download:
      additionalProperties: false
      properties:
        agreement_name:
          nullable: true
          type: string
        product_id:
          nullable: true
          type: string
        product_type:
          nullable: true
          type: string
        uri:
          nullable: true
          type: string
      type: object
    DownloadDetails:
      additionalProperties: false
      properties:
        download_notes:
          nullable: true
          type: string
        project_code:
          nullable: true
          type: string
      type: object
    DownloadFileType:
      enum:
        - eps
        - jpg
      type: string
    DownloadRequirements:
      additionalProperties: false
      properties:
        is_note_required:
          type: boolean
        is_project_code_required:
          type: boolean
        project_codes:
          items:
            type: string
          nullable: true
          type: array
      type: object
    EditorialGraphicalStyle:
      enum:
        - photography
        - illustration
        - vector
      type: string
    EditorialImageSearchFacetsFields:
      enum:
        - artists
        - events
        - locations
        - specific_people
      type: string
    EditorialImageSearchResults:
      additionalProperties: false
      properties:
        images:
          items:
            $ref: "#/components/schemas/ImageSearchItemEditorial"
          nullable: true
          type: array
        related_searches:
          items:
            $ref: "#/components/schemas/RelatedSearch"
          nullable: true
          type: array
        result_count:
          format: int32
          type: integer
      type: object
    EditorialImagesFieldValues:
      enum:
        - allowed_use
        - alternative_ids
        - artist
        - asset_family
        - call_for_image
        - caption
        - collection_code
        - collection_id
        - collection_name
        - color_type
        - comp
        - copyright
        - date_camera_shot
        - date_created
        - date_submitted
        - detail_set
        - display_set
        - download_product
        - download_sizes
        - editorial_segments
        - editorial_source
        - event_ids
        - graphical_style
        - id
        - keywords
        - largest_downloads
        - license_model
        - max_dimensions
        - orientation
        - people
        - preview
        - product_types
        - quality_rank
        - referral_destinations
        - summary_set
        - thumb
        - title
        - uri_oembed
      type: string
    EditorialSegmentContract:
      enum:
        - archival
        - entertainment
        - news
        - publicity
        - royalty
        - sport
      type: string
    EditorialSource:
      additionalProperties: false
      properties:
        id:
          format: int32
          type: integer
      type: object
    EditorialVideoSearchFacetsFields:
      enum:
        - artists
        - events
        - locations
        - specific_people
      type: string
    EditorialVideoSearchItem:
      additionalProperties: false
      properties:
        allowed_use:
          $ref: "#/components/schemas/AllowedUse"
        artist:
          nullable: true
          type: string
        asset_family:
          nullable: true
          type: string
        caption:
          nullable: true
          type: string
        clip_length:
          nullable: true
          type: string
        collection_code:
          nullable: true
          type: string
        collection_id:
          format: int32
          nullable: true
          type: integer
        collection_name:
          nullable: true
          type: string
        color_type:
          nullable: true
          type: string
        copyright:
          nullable: true
          type: string
        date_created:
          format: date-time
          nullable: true
          type: string
        display_sizes:
          items:
            $ref: "#/components/schemas/VideoSearchItemDisplaySize"
          nullable: true
          type: array
        download_product:
          nullable: true
          type: string
        era:
          nullable: true
          type: string
        event_ids:
          items:
            format: int32
            type: integer
          nullable: true
          type: array
        id:
          nullable: true
          type: string
        istock_licenses:
          items:
            $ref: "#/components/schemas/IStockLicense"
          nullable: true
          type: array
        keywords:
          items:
            $ref: "#/components/schemas/Keyword"
          nullable: true
          type: array
        largest_downloads:
          items:
            $ref: "#/components/schemas/Download"
          nullable: true
          type: array
        license_model:
          nullable: true
          type: string
        mastered_to:
          nullable: true
          type: string
        originally_shot_on:
          nullable: true
          type: string
        product_types:
          items:
            type: string
          nullable: true
          type: array
        referral_destinations:
          items:
            $ref: "#/components/schemas/ReferralDestination"
          nullable: true
          type: array
        shot_speed:
          nullable: true
          type: string
        source:
          nullable: true
          type: string
        title:
          nullable: true
          type: string
      type: object
    EditorialVideoSearchResults:
      additionalProperties: false
      properties:
        facets:
          $ref: "#/components/schemas/SearchFacetsResponse"
        related_searches:
          items:
            $ref: "#/components/schemas/RelatedSearch"
          nullable: true
          type: array
        result_count:
          format: int32
          type: integer
        videos:
          items:
            $ref: "#/components/schemas/EditorialVideoSearchItem"
          nullable: true
          type: array
      type: object
    EditorialVideoType:
      enum:
        - raw
        - produced
      type: string
    EditorialVideosFieldValues:
      enum:
        - allowed_use
        - artist
        - aspect_ratio
        - asset_family
        - call_for_image
        - caption
        - clip_length
        - collection_code
        - collection_id
        - collection_name
        - color_type
        - comp
        - copyright
        - date_created
        - date_submitted
        - detail_set
        - display_set
        - download_product
        - download_sizes
        - editorial_segments
        - era
        - event_ids
        - id
        - istock_collection
        - keywords
        - largest_downloads
        - license_model
        - mastered_to
        - object_name
        - orientation
        - originally_shot_on
        - preview
        - product_types
        - quality_rank
        - referral_destinations
        - shot_speed
        - source
        - summary_set
        - thumb
        - title
        - istock_licenses
      type: string
    Entertainment:
      additionalProperties: false
      properties:
        id:
          format: int32
          type: integer
        name:
          nullable: true
          type: string
      type: object
    EthnicityFilterType:
      enum:
        - black
        - caucasian
        - east_asian
        - hispanic_latino
        - japanese
        - middle_eastern
        - mixed_race_person
        - multiethnic_group
        - native_american_first_nations
        - pacific_islander
        - south_asian
        - southeast_asian
      type: string
    Event:
      additionalProperties: false
      properties:
        child_event_count:
          format: int32
          type: integer
        editorial_segments:
          items:
            type: string
          nullable: true
          type: array
        hero_image:
          $ref: "#/components/schemas/HeroImage"
        id:
          format: int32
          type: integer
        image_count:
          format: int32
          type: integer
        location:
          $ref: "#/components/schemas/LocationEvent"
        name:
          nullable: true
          type: string
        start_date:
          format: date-time
          nullable: true
          type: string
      type: object
    EventDetailFieldValues:
      enum:
        - id
        - child_event_count
        - editorial_segments
        - hero_image
        - image_count
        - location
        - name
        - start_date
        - type
      type: string
    EventFieldValues:
      enum:
        - id
        - child_event_count
        - editorial_segments
        - hero_image
        - image_count
        - keywords
        - location
        - name
        - start_date
        - type
      type: string
    EventSearchSortOrder:
      enum:
        - newest
        - oldest
      type: string
    EventsSearchResult:
      additionalProperties: false
      properties:
        events:
          items:
            $ref: "#/components/schemas/Event"
          nullable: true
          type: array
        result_count:
          format: int32
          type: integer
      type: object
    ExtendedLicenses:
      enum:
        - multiseat
        - unlimited
        - resale
        - indemnification
      type: string
    FacetEvent:
      additionalProperties: false
      properties:
        date:
          format: date-time
          type: string
        id:
          format: int32
          type: integer
        name:
          nullable: true
          type: string
      type: object
    GetDownloadsResponse:
      additionalProperties: false
      properties:
        downloads:
          items:
            $ref: "#/components/schemas/HistoricalDownload"
          nullable: true
          type: array
        result_count:
          format: int32
          type: integer
      type: object
    GetSendEventsResponse:
      additionalProperties: false
      properties:
        asset_send_events:
          items:
            $ref: "#/components/schemas/AssetEvent"
          nullable: true
          type: array
        last_offset:
          format: date-time
          nullable: true
          type: string
      type: object
    GraphicalStyle:
      enum:
        - fine_art
        - illustration
        - photography
        - vector
      type: string
    GraphicalStylesFilterType:
      enum:
        - include
        - exclude
      type: string
    HeroImage:
      additionalProperties: false
      properties:
        display_sizes:
          items:
            $ref: "#/components/schemas/HeroImageDisplaySize"
          nullable: true
          type: array
        id:
          nullable: true
          type: string
      type: object
    HeroImageDisplaySize:
      additionalProperties: false
      properties:
        is_watermarked:
          type: boolean
        name:
          nullable: true
          type: string
        uri:
          nullable: true
          type: string
      type: object
    HistoricalDownload:
      additionalProperties: false
      properties:
        agreement_name:
          nullable: true
          type: string
        asset_type:
          nullable: true
          type: string
        date_downloaded:
          format: date-time
          type: string
        dimensions:
          $ref: "#/components/schemas/Dimensions"
        download_details:
          $ref: "#/components/schemas/DownloadDetails"
        download_source:
          nullable: true
          type: string
        id:
          nullable: true
          type: string
        product_id:
          format: int32
          type: integer
        product_type:
          nullable: true
          type: string
        size_name:
          nullable: true
          type: string
        thumb_uri:
          nullable: true
          type: string
        user:
          $ref: "#/components/schemas/User"
      type: object
    IStockLicense:
      additionalProperties: false
      properties:
        credits:
          format: int32
          type: integer
        license_type:
          $ref: "#/components/schemas/AssetLicenseName"
      type: object
    ImageDetailFieldValues:
      enum:
        - allowed_use
        - alternative_ids
        - artist
        - artist_title
        - asset_family
        - call_for_image
        - caption
        - city
        - collection_code
        - collection_id
        - collection_name
        - color_type
        - comp
        - copyright
        - country
        - credit_line
        - date_camera_shot
        - date_created
        - date_submitted
        - detail_set
        - display_set
        - download_sizes
        - download_product
        - downloads
        - editorial_segments
        - editorial_source
        - entity_details
        - event_ids
        - graphical_style
        - id
        - istock_collection
        - istock_licenses
        - keywords
        - largest_downloads
        - license_model
        - links
        - max_dimensions
        - object_name
        - orientation
        - people
        - preview
        - product_types
        - quality_rank
        - referral_destinations
        - state_province
        - summary_set
        - thumb
        - title
        - uri_oembed
      type: string
    ImageOrientationRequest:
      enum:
        - horizontal
        - vertical
        - square
        - panoramic_horizontal
        - panoramic_vertical
      type: string
    ImageSearchItem:
      additionalProperties: false
      properties:
        allowed_use:
          $ref: "#/components/schemas/AllowedUse"
        alternative_ids:
          additionalProperties:
            type: string
          nullable: true
          type: object
        artist:
          nullable: true
          type: string
        asset_family:
          nullable: true
          type: string
        call_for_image:
          type: boolean
        caption:
          nullable: true
          type: string
        collection_code:
          nullable: true
          type: string
        collection_id:
          format: int32
          nullable: true
          type: integer
        collection_name:
          nullable: true
          type: string
        color_type:
          nullable: true
          type: string
        copyright:
          nullable: true
          type: string
        date_camera_shot:
          format: date-time
          nullable: true
          type: string
        date_created:
          format: date-time
          nullable: true
          type: string
        display_sizes:
          items:
            $ref: "#/components/schemas/ImageSearchItemDisplaySize"
          nullable: true
          type: array
        download_product:
          nullable: true
          type: string
        editorial_segments:
          items:
            type: string
          nullable: true
          type: array
        event_ids:
          items:
            format: int32
            type: integer
          nullable: true
          type: array
        graphical_style:
          nullable: true
          type: string
        id:
          nullable: true
          type: string
        istock_licenses:
          items:
            $ref: "#/components/schemas/IStockLicense"
          nullable: true
          type: array
        keywords:
          items:
            $ref: "#/components/schemas/Keyword"
          nullable: true
          type: array
        largest_downloads:
          items:
            $ref: "#/components/schemas/Download"
          nullable: true
          type: array
        license_model:
          nullable: true
          type: string
        max_dimensions:
          $ref: "#/components/schemas/MaxDimensions"
        orientation:
          nullable: true
          type: string
        people:
          items:
            type: string
          nullable: true
          type: array
        product_types:
          items:
            type: string
          nullable: true
          type: array
        quality_rank:
          format: int32
          type: integer
        referral_destinations:
          items:
            $ref: "#/components/schemas/ReferralDestination"
          nullable: true
          type: array
        title:
          nullable: true
          type: string
        uri_oembed:
          nullable: true
          type: string
      type: object
    ImageSearchItemCreative:
      additionalProperties: false
      properties:
        allowed_use:
          $ref: "#/components/schemas/AllowedUse"
        alternative_ids:
          additionalProperties:
            type: string
          nullable: true
          type: object
        artist:
          nullable: true
          type: string
        asset_family:
          nullable: true
          type: string
        call_for_image:
          type: boolean
        caption:
          nullable: true
          type: string
        collection_code:
          nullable: true
          type: string
        collection_id:
          format: int32
          nullable: true
          type: integer
        collection_name:
          nullable: true
          type: string
        color_type:
          nullable: true
          type: string
        copyright:
          nullable: true
          type: string
        date_camera_shot:
          format: date-time
          nullable: true
          type: string
        date_created:
          format: date-time
          nullable: true
          type: string
        display_sizes:
          items:
            $ref: "#/components/schemas/ImageSearchItemDisplaySize"
          nullable: true
          type: array
        download_product:
          nullable: true
          type: string
        graphical_style:
          nullable: true
          type: string
        id:
          nullable: true
          type: string
        keywords:
          items:
            $ref: "#/components/schemas/Keyword"
          nullable: true
          type: array
        largest_downloads:
          items:
            $ref: "#/components/schemas/Download"
          nullable: true
          type: array
        license_model:
          nullable: true
          type: string
        max_dimensions:
          $ref: "#/components/schemas/MaxDimensions"
        orientation:
          nullable: true
          type: string
        quality_rank:
          format: int32
          type: integer
        referral_destinations:
          items:
            $ref: "#/components/schemas/ReferralDestination"
          nullable: true
          type: array
        title:
          nullable: true
          type: string
        uri_oembed:
          nullable: true
          type: string
      type: object
    ImageSearchItemDisplaySize:
      additionalProperties: false
      properties:
        is_watermarked:
          type: boolean
        name:
          nullable: true
          type: string
        uri:
          nullable: true
          type: string
      type: object
    ImageSearchItemEditorial:
      additionalProperties: false
      properties:
        allowed_use:
          $ref: "#/components/schemas/AllowedUse"
        alternative_ids:
          additionalProperties:
            type: string
          nullable: true
          type: object
        artist:
          nullable: true
          type: string
        asset_family:
          nullable: true
          type: string
        call_for_image:
          type: boolean
        caption:
          nullable: true
          type: string
        collection_code:
          nullable: true
          type: string
        collection_id:
          format: int32
          nullable: true
          type: integer
        collection_name:
          nullable: true
          type: string
        color_type:
          nullable: true
          type: string
        copyright:
          nullable: true
          type: string
        date_camera_shot:
          format: date-time
          nullable: true
          type: string
        date_created:
          format: date-time
          nullable: true
          type: string
        display_sizes:
          items:
            $ref: "#/components/schemas/ImageSearchItemDisplaySize"
          nullable: true
          type: array
        download_product:
          nullable: true
          type: string
        editorial_segments:
          items:
            type: string
          nullable: true
          type: array
        editorial_source:
          $ref: "#/components/schemas/EditorialSource"
        event_ids:
          items:
            format: int32
            type: integer
          nullable: true
          type: array
        graphical_style:
          nullable: true
          type: string
        id:
          nullable: true
          type: string
        keywords:
          items:
            $ref: "#/components/schemas/Keyword"
          nullable: true
          type: array
        largest_downloads:
          items:
            $ref: "#/components/schemas/Download"
          nullable: true
          type: array
        license_model:
          nullable: true
          type: string
        max_dimensions:
          $ref: "#/components/schemas/MaxDimensions"
        orientation:
          nullable: true
          type: string
        people:
          items:
            type: string
          nullable: true
          type: array
        product_types:
          items:
            type: string
          nullable: true
          type: array
        quality_rank:
          format: int32
          type: integer
        referral_destinations:
          items:
            $ref: "#/components/schemas/ReferralDestination"
          nullable: true
          type: array
        title:
          nullable: true
          type: string
        uri_oembed:
          nullable: true
          type: string
      type: object
    ImageSearchItemSearchResults:
      additionalProperties: false
      properties:
        images:
          items:
            $ref: "#/components/schemas/ImageSearchItem"
          nullable: true
          type: array
        related_searches:
          items:
            $ref: "#/components/schemas/RelatedSearch"
          nullable: true
          type: array
        result_count:
          format: int32
          type: integer
      type: object
    ImageTechniquesFilterType:
      enum:
        - realtime
        - time_lapse
        - slow_motion
        - color
        - black_and_white
        - animation
        - selective_focus
      type: string
    ImagesDetailResults:
      additionalProperties: false
      properties:
        images:
          nullable: true
        images_not_found:
          items:
            type: string
          nullable: true
          type: array
      type: object
    ImagesFieldValues:
      enum:
        - accessrestriction
        - allowed_use
        - alternative_ids
        - artist
        - asset_family
        - call_for_image
        - caption
        - collection_code
        - collection_id
        - collection_name
        - color_type
        - comp
        - copyright
        - date_camera_shot
        - date_created
        - date_submitted
        - detail_set
        - display_set
        - download_product
        - download_sizes
        - editorial_segments
        - editorial_source
        - entity_details
        - event_ids
        - graphical_style
        - id
        - istock_collection
        - keywords
        - largest_downloads
        - license_model
        - max_dimensions
        - orientation
        - people
        - preview
        - product_types
        - quality_rank
        - referral_destinations
        - summary_set
        - thumb
        - title
        - uri_oembed
      type: string
    Keyword:
      additionalProperties: false
      properties:
        entity_types:
          items:
            type: string
          nullable: true
          type: array
        entity_uris:
          items:
            type: string
          nullable: true
          type: array
        keyword_id:
          nullable: true
          type: string
        relevance:
          format: int32
          nullable: true
          type: integer
        text:
          nullable: true
          type: string
        type:
          nullable: true
          type: string
      type: object
    LicenseModelImageRequest:
      enum:
        - rightsmanaged
        - royaltyfree
      type: string
    LicenseModelVideoRequest:
      enum:
        - rightsready
        - royaltyfree
      type: string
    Links:
      additionalProperties: false
      properties:
        invitation:
          nullable: true
          type: string
        share:
          nullable: true
          type: string
      type: object
    Location:
      additionalProperties: false
      properties:
        id:
          format: int32
          type: integer
        name:
          nullable: true
          type: string
      type: object
    LocationEvent:
      additionalProperties: false
      properties:
        city:
          nullable: true
          type: string
        country:
          nullable: true
          type: string
        state_province:
          nullable: true
          type: string
        venue:
          nullable: true
          type: string
      type: object
    LogLevel:
      enum:
        - Trace
        - Debug
        - Information
        - Warning
        - Error
        - Critical
        - None
      type: string
    MaxDimensions:
      additionalProperties: false
      properties:
        height:
          format: int32
          type: integer
        width:
          format: int32
          type: integer
      type: object
    MemcachedLogEntry:
      additionalProperties: false
      properties:
        ExceptionMessage:
          nullable: true
          type: string
        LogLevel:
          $ref: "#/components/schemas/LogLevel"
        Message:
          nullable: true
          type: string
        Time:
          format: date-time
          type: string
      type: object
    NumberOfPeopleFilterType:
      enum:
        - none
        - one
        - two
        - group
      type: string
    OrderDetail:
      additionalProperties: false
      properties:
        assets:
          items:
            $ref: "#/components/schemas/AssetIdFromOrder"
          nullable: true
          type: array
        end_client:
          nullable: true
          type: string
        id:
          nullable: true
          type: string
        invoice_number:
          nullable: true
          type: string
        notes:
          $ref: "#/components/schemas/OrderNotes"
        order_date:
          format: date-time
          type: string
      type: object
    OrderNotes:
      additionalProperties: false
      properties:
        licensee_name:
          nullable: true
          type: string
        ordered_by:
          nullable: true
          type: string
        project_title:
          nullable: true
          type: string
        purchase_order_number:
          nullable: true
          type: string
      type: object
    OverageDetails:
      additionalProperties: false
      properties:
        count:
          format: int32
          nullable: true
          type: integer
        limit:
          format: int32
          nullable: true
          type: integer
        overages_reached:
          nullable: true
          type: boolean
        remaining:
          format: int32
          nullable: true
          type: integer
      type: object
    PremiumAccessDownloadData:
      additionalProperties: false
      properties:
        download_notes:
          nullable: true
          type: string
        project_code:
          nullable: true
          type: string
      type: object
    PreviousAssetPurchase:
      additionalProperties: false
      properties:
        asset_id:
          nullable: true
          type: string
        asset_type:
          nullable: true
          type: string
        date_purchased:
          format: date-time
          type: string
        download_uri:
          nullable: true
          type: string
        file_size_in_bytes:
          nullable: true
          type: string
        license_model:
          nullable: true
          type: string
        order_id:
          nullable: true
          type: string
        purchased_by:
          nullable: true
          type: string
        size_name:
          nullable: true
          type: string
        thumb_uri:
          nullable: true
          type: string
      type: object
    PreviousAssetPurchases:
      additionalProperties: false
      properties:
        previous_purchases:
          items:
            $ref: "#/components/schemas/PreviousAssetPurchase"
          nullable: true
          type: array
        result_count:
          format: int32
          type: integer
      type: object
    PreviousPurchase:
      additionalProperties: false
      properties:
        date_purchased:
          format: date-time
          type: string
        image_id:
          nullable: true
          type: string
        license_model:
          nullable: true
          type: string
        order_id:
          nullable: true
          type: string
        thumb_uri:
          nullable: true
          type: string
      type: object
    PreviousPurchases:
      additionalProperties: false
      properties:
        previous_purchases:
          items:
            $ref: "#/components/schemas/PreviousPurchase"
          nullable: true
          type: array
        result_count:
          format: int32
          type: integer
      type: object
    Product:
      additionalProperties: false
      properties:
        agreement_name:
          nullable: true
          type: string
        application_website:
          nullable: true
          type: string
        credits_remaining:
          format: int32
          nullable: true
          type: integer
        download_limit:
          format: int32
          nullable: true
          type: integer
        download_limit_duration:
          nullable: true
          type: string
        download_limit_reset_utc_date:
          format: date-time
          nullable: true
          type: string
        download_requirements:
          $ref: "#/components/schemas/DownloadRequirements"
        downloads_remaining:
          format: int32
          nullable: true
          type: integer
        expiration_utc_date:
          format: date-time
          nullable: true
          type: string
        id:
          format: int32
          type: integer
        imagepack_resolution:
          nullable: true
          type: string
        name:
          nullable: true
          type: string
        overage:
          $ref: "#/components/schemas/OverageDetails"
        status:
          $ref: "#/components/schemas/ProductStatus"
        team_credits:
          format: int32
          nullable: true
          type: integer
        type:
          $ref: "#/components/schemas/ProductTypeResponse"
      type: object
    ProductFieldValues:
      enum:
        - download_requirements
      type: string
    ProductStatus:
      enum:
        - active
        - inactive
      type: string
    ProductStatusRequest:
      enum:
        - all
        - active
        - inactive
      type: string
    ProductTypeForDownloads:
      enum:
        - easyaccess
        - editorialsubscription
        - imagepack
        - premiumaccess
        - royaltyfreesubscription
        - creditpack
      type: string
    ProductTypeResponse:
      enum:
        - easyaccess
        - editorialsubscription
        - imagepack
        - premiumaccess
        - royaltyfreesubscription
        - creditpack
      type: string
    ProductsResult:
      additionalProperties: false
      properties:
        products:
          items:
            $ref: "#/components/schemas/Product"
          nullable: true
          type: array
      type: object
    ReferralDestination:
      additionalProperties: false
      properties:
        site_name:
          nullable: true
          type: string
        uri:
          nullable: true
          type: string
      type: object
    RelatedSearch:
      additionalProperties: false
      properties:
        phrase:
          nullable: true
          type: string
        url:
          nullable: true
          type: string
      type: object
    ReleaseStatus:
      enum:
        - release_not_important
        - fully_released
      type: string
    SearchByImageResourceResults:
      additionalProperties: false
      properties:
        auto_corrections:
          $ref: "#/components/schemas/AutoCorrections"
        facets:
          $ref: "#/components/schemas/SearchFacetsResponse"
        image_fingerprint:
          nullable: true
          type: string
        images:
          nullable: true
        related_searches:
          deprecated: true
          items:
            $ref: "#/components/schemas/RelatedSearch"
          nullable: true
          type: array
        result_count:
          format: int32
          type: integer
      type: object
    SearchFacetsResponse:
      additionalProperties: false
      properties:
        artists:
          items:
            $ref: "#/components/schemas/Artist"
          nullable: true
          type: array
        entertainment:
          items:
            $ref: "#/components/schemas/Entertainment"
          nullable: true
          type: array
        events:
          items:
            $ref: "#/components/schemas/FacetEvent"
          nullable: true
          type: array
        locations:
          items:
            $ref: "#/components/schemas/Location"
          nullable: true
          type: array
        specific_people:
          items:
            $ref: "#/components/schemas/SpecificPeople"
          nullable: true
          type: array
      type: object
    SearchFileType:
      enum:
        - eps
        - jpg
      type: string
    SelfResult:
      additionalProperties: false
      properties:
        email:
          nullable: true
          type: string
        id:
          nullable: true
          type: string
        name:
          nullable: true
          type: string
      type: object
    SortOrder:
      enum:
        - best_match
        - most_popular
        - newest
        - oldest
        - random
      type: string
    SpecificPeople:
      additionalProperties: false
      properties:
        id:
          format: int32
          type: integer
        name:
          nullable: true
          type: string
      type: object
    TeeShirtSize:
      enum:
        - x_small
        - small
        - medium
        - large
        - x_large
        - xx_large
        - vector
      type: string
    TerritoryRestriction:
      additionalProperties: false
      properties:
        country_code:
          nullable: true
          type: string
        description:
          nullable: true
          type: string
        type:
          nullable: true
          type: string
      type: object
    User:
      additionalProperties: false
      properties:
        first_name:
          nullable: true
          type: string
        last_name:
          nullable: true
          type: string
        middle_name:
          nullable: true
          type: string
        username:
          nullable: true
          type: string
      type: object
    VideoAspectRatioFilterType:
      enum:
        - 16:9
        - 9:16
        - 3:4
        - 4:3
        - 4:5
        - 2:1
        - 17:9
        - 9:17
      type: string
    VideoDetailFieldValues:
      enum:
        - id
        - allowed_use
        - artist
        - asset_family
        - call_for_image
        - caption
        - city
        - clip_length
        - collection_code
        - collection_id
        - collection_name
        - color_type
        - comp
        - copyright
        - country
        - date_created
        - date_submitted
        - detail_set
        - display_set
        - download_sizes
        - download_product
        - downloads
        - editorial_segments
        - entity_details
        - era
        - event_ids
        - istock_collection
        - istock_licenses
        - key_frames
        - keywords
        - license_model
        - mastered_to
        - object_name
        - orientation
        - originally_shot_on
        - preview
        - product_types
        - quality_rank
        - referral_destinations
        - shot_speed
        - source
        - state_province
        - summary_set
        - thumb
        - title
      type: string
    VideoFormatsRequest:
      enum:
        - sd
        - hd
        - 4k
        - hd_web
      type: string
    VideoFrameRates:
      enum:
        - "23.98"
        - "24"
        - "25"
        - "29.97"
        - "30"
        - "50"
        - "59.94"
        - "60"
      type: string
    VideoOrientationRequest:
      enum:
        - horizontal
        - vertical
      type: string
    VideoSearchItemDisplaySize:
      additionalProperties: false
      properties:
        aspect_ratio:
          nullable: true
          type: string
        is_watermarked:
          type: boolean
        name:
          nullable: true
          type: string
        uri:
          nullable: true
          type: string
      type: object
    ViewpointsFilterType:
      enum:
        - lockdown
        - panning
        - tracking_shot
        - aerial_view
        - high_angle_view
        - low_angle_view
        - tilt
        - point_of_view
      type: string
    asset_usage:
      additionalProperties: false
      description: Specifies the id, usage Quantity, and date of when an asset was used.
      properties:
        asset_id:
          description: Specifies the Id of the asset that was used.
          nullable: true
          type: string
        quantity:
          description: Specifies the number of times the asset was used.
          format: int32
          type: integer
        usage_date:
          description: Identifies the date the asset was used, in ISO 8601 format (e.g., YYYY-MM-DD), time is not needed.
          format: date-time
          type: string
      type: object
    report_usage_batch_request:
      additionalProperties: false
      description: Specifies the request information for the Batch Usages endpoint.
      properties:
        asset_usages:
          description: Identifies the list of asset id, usage count and date of usage combinations to record.
          items:
            $ref: "#/components/schemas/asset_usage"
          nullable: true
          type: array
      type: object
    report_usage_batch_response:
      additionalProperties: false
      description: Specifies the response from the Batch Usages endpoint.
      properties:
        invalid_assets:
          description: Identifies a list of asset ids submitted that did not match known Getty asset ids.
          items:
            type: string
          nullable: true
          type: array
        total_asset_usages_processed:
          description: Specifies the number of asset usage records that were successfully recorded.
          format: int32
          nullable: true
          type: integer
      type: object
  securitySchemes:
    Api-Key:
      in: header
      name: Api-Key
      type: apiKey
    OAuth2:
      flows:
        authorizationCode:
          authorizationUrl: https://api.gettyimages.com/v4/oauth2/auth
          refreshUrl: https://api.gettyimages.com/v4/oauth2/token
          scopes: {}
          tokenUrl: https://api.gettyimages.com/v4/oauth2/token
        clientCredentials:
          scopes: {}
          tokenUrl: https://api.gettyimages.com/v4/oauth2/token
        implicit:
          authorizationUrl: https://api.gettyimages.com/v4/oauth2/auth
          scopes: {}
        password:
          refreshUrl: https://api.gettyimages.com/v4/oauth2/token
          scopes: {}
          tokenUrl: https://api.gettyimages.com/v4/oauth2/token
      type: oauth2
