Getty Images Ai Generator API

openapi: 3.2.0
info:
  title: Getty Images Ai Generator API
  version: '3'
  description: '

    Developer resources for the Getty Images API including SDK, documentation,

    release notes, status, notifications and sample code.'
servers:
- url: https://api.gettyimages.com
  description: Base URL declared by the provider in apis.yml (roadmap#122).
security:
- Api-Key: []
- OAuth2: []
tags:
- name: Ai Generator
paths:
  /v3/ai/image-generations/{generationRequestId}/images/{index}/download-sizes:
    get:
      tags:
      - Ai Generator
      summary: Get download sizes for a generated image
      description: '# AI Generator - Get Download Sizes


        Given a fulfilled generation request `id` and the `index` of a generated image, gets a list of download sizes for the image.

        '
      parameters:
      - name: generationRequestId
        in: path
        description: The ID from a previous request to generate images
        required: true
        style: simple
        schema:
          type: string
      - name: index
        in: path
        description: The index of the image from the specific images generation
        required: true
        style: simple
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Returns the result of a request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadSizesResponse'
        '400':
          description: InvalidProduct
        '404':
          description: Either the generation id does not exist, the index is incorrect, or the generation is still pending
        '410':
          description: GenerationRequestGone
  /v3/ai/redownloads:
    post:
      tags:
      - Ai Generator
      summary: Re-download a previously downloaded item
      description: '# Re-download AI Generated media


        Re-download previously downloaded AI generated media.


        ## `ReDownloadRequest` details


        | Parameter                       | Purpose                                                                                                                                                   |

        |---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|

        | `generated_asset_id` _Required_ | The generated asset identifier to re-download.  Can be retrieved from previously downloaded assets (`GET /v3/downloads`)                                  |

        | `product_id` _Required_         | The product to use to re-download.  Can be retrieved from products (`GET /v3/products`)                                                                   |

        | `size_name` _Required_          | The size to re-download.  Valid values are `1k` and `4k`                                                                                                  |

        | `notes`             | This is an optional free text parameter often used by clients who wish to include notes specific to their integration. This is for use by Getty Images customers only (not iStock). The products endpoint (`GET /v3/products`) provides this information.                                                                                                                                       |

        | `project_code`      | If your Getty Images Generative AI product requires project_codes, use of this parameter is required. If your product does not require a project_code, this parameter must be excluded from the request. This is for use by Getty Images customers only (not iStock). The products endpoint (`GET /v3/products`) provides this information.                                                                                                                  |'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReDownloadRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ReDownloadRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ReDownloadRequest'
      responses:
        '200':
          description: Returns the re-download response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadResponse'
        '400':
          description: The request was invalid
        '403':
          description: Product is not active or quota exceeded
        '404':
          description: Could not find source generated_asset_id
        '410':
          description: GenerationRequestGone
components:
  schemas:
    ReDownloadRequest:
      type: object
      properties:
        generated_asset_id:
          type:
          - string
          - 'null'
          description: The identifier of the previously-downloaded generated asset.
        product_id:
          type: integer
          description: The product ID to use for the download.
          format: int32
        size_name:
          type:
          - string
          - 'null'
          description: The size name.  Valid values are 1k or 4k.
        project_code:
          type:
          - string
          - 'null'
          description: The project code to use for the download request.  Some products require this value.
        notes:
          type:
          - string
          - 'null'
          description: The notes to use for the download request.  Some products require this value.
      additionalProperties: false
      description: Parameters for requesting an AI generation re-download
    DownloadResponse:
      type: object
      properties:
        url:
          type:
          - string
          - 'null'
        generated_asset_id:
          type:
          - string
          - 'null'
      additionalProperties: false
    DownloadSizeResponse:
      type: object
      properties:
        size_name:
          type:
          - string
          - 'null'
        height:
          type: integer
          format: int32
        width:
          type: integer
          format: int32
      additionalProperties: false
    DownloadSizesResponse:
      type: object
      properties:
        download_sizes:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/DownloadSizeResponse'
      additionalProperties: false
  securitySchemes:
    Api-Key:
      type: apiKey
      name: Api-Key
      in: header
    OAuth2:
      type: oauth2
      flows:
        password:
          tokenUrl: https://api.gettyimages.com/v4/oauth2/token
          refreshUrl: https://api.gettyimages.com/v4/oauth2/token
          scopes: {}
        clientCredentials:
          tokenUrl: https://api.gettyimages.com/v4/oauth2/token
          scopes: {}
        authorizationCode:
          authorizationUrl: https://api.gettyimages.com/v4/oauth2/auth
          tokenUrl: https://api.gettyimages.com/v4/oauth2/token
          refreshUrl: https://api.gettyimages.com/v4/oauth2/token
          scopes: {}