openapi: 3.2.0
info:
  title: ElevenLabs API Documentation Image API
  description: This is the documentation for the ElevenLabs API. You can use this API to use our service programmatically, this is done by using your API key. You can find your API key in the dashboard at https://elevenlabs.io/app/settings/api-keys.
  version: '1.0'
tags:
- name: Image
paths:
  /v1/flows/image:
    post:
      tags:
      - Image
      summary: Create Image Generation
      description: Start an image generation with the selected model.
      operationId: create_image_generation
      parameters:
      - name: xi-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.
          title: Xi-Api-Key
        description: Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImageGenerationRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaGenerationCreateResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-fern-sdk-group-name:
      - flows
      - image
      x-fern-sdk-method-name: create
    get:
      tags:
      - Image
      summary: List Image Generations
      description: List the image generations created through this API, newest first.
      operationId: list_image_generations
      parameters:
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 'Pagination cursor: the `next_cursor` value of the previous page''s response. Omit it for the first page.'
          title: Cursor
        description: 'Pagination cursor: the `next_cursor` value of the previous page''s response. Omit it for the first page.'
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          description: How many generations to return per page.
          default: 30
          title: Page Size
        description: How many generations to return per page.
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - enum:
            - pending
            - generating
            - completed
            - failed
            type: string
          - type: 'null'
          description: Only return generations with this lifecycle status.
          title: Status
        description: Only return generations with this lifecycle status.
      - name: model_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Only return generations of this model.
          title: Model Id
        description: Only return generations of this model.
      - name: xi-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.
          title: Xi-Api-Key
        description: Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaGenerationListResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-fern-sdk-group-name:
      - flows
      - image
      x-fern-sdk-method-name: list
  /v1/flows/image/{generation_id}:
    get:
      tags:
      - Image
      summary: Get Image Generation
      description: Retrieve the status of an image generation, and retrieve its output URL once completed.
      operationId: get_image_generation
      parameters:
      - name: generation_id
        in: path
        required: true
        schema:
          type: string
          title: Generation Id
      - name: xi-api-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.
          title: Xi-Api-Key
        description: Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaGenerationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-fern-sdk-group-name:
      - flows
      - image
      x-fern-sdk-method-name: get
components:
  schemas:
    MediaGenerationFailedResponse:
      properties:
        id:
          type: string
          title: Id
          description: The unique identifier of the generation.
          examples:
          - JWr5N6X9ZTqf8jD2LmQb
        status:
          type: string
          const: failed
          title: Status
          description: The lifecycle status of the generation.
          examples:
          - failed
        failure_reason:
          type: string
          enum:
          - timeout
          - model_error
          - moderated
          - invalid_parameters
          - dependency_failed
          - charging_failed
          - internal_error
          title: Failure Reason
          description: The category of failure.
          examples:
          - timeout
        error_message:
          type: string
          title: Error Message
          description: A human-readable description of the failure. Failed generations are not charged.
          examples:
          - Timed out while processing. You were not charged for this generation.
      type: object
      required:
      - id
      - status
      - failure_reason
      - error_message
      title: MediaGenerationFailedResponse
      description: A failed media generation and why it failed.
      example:
        error_message: Timed out while processing. You were not charged for this generation.
        failure_reason: timeout
        id: JWr5N6X9ZTqf8jD2LmQb
        status: failed
    ImageGenerationRequest:
      oneOf:
      - $ref: '#/components/schemas/GPTImage1Request'
      - $ref: '#/components/schemas/GPTImage1_5Request'
      - $ref: '#/components/schemas/GPTImage2Request'
      - $ref: '#/components/schemas/Gemini25FlashImageRequest'
      - $ref: '#/components/schemas/Gemini3ProImageRequest'
      - $ref: '#/components/schemas/Gemini31FlashImageRequest'
      - $ref: '#/components/schemas/Gemini31FlashLiteImageRequest'
      - $ref: '#/components/schemas/BytedanceSeedream5LiteRequest'
      - $ref: '#/components/schemas/BytedanceSeedream5ProRequest'
      discriminator:
        propertyName: model_id
        mapping:
          bytedance-seedream-5-lite: '#/components/schemas/BytedanceSeedream5LiteRequest'
          bytedance-seedream-5-pro: '#/components/schemas/BytedanceSeedream5ProRequest'
          gemini-2.5-flash-image: '#/components/schemas/Gemini25FlashImageRequest'
          gemini-3-pro-image: '#/components/schemas/Gemini3ProImageRequest'
          gemini-3.1-flash-image: '#/components/schemas/Gemini31FlashImageRequest'
          gemini-3.1-flash-lite-image: '#/components/schemas/Gemini31FlashLiteImageRequest'
          gpt-image-1: '#/components/schemas/GPTImage1Request'
          gpt-image-1.5: '#/components/schemas/GPTImage1_5Request'
          gpt-image-2: '#/components/schemas/GPTImage2Request'
    InlineImageReference:
      properties:
        type:
          type: string
          const: inline_base64
          title: Type
        content_base64:
          type: string
          maxLength: 34952536
          title: Content Base64
          description: The media file's bytes, base64-encoded (standard alphabet). Up to 25MB decoded.
          examples:
          - iVBORw0KGgoAAAANSUhEUgAA...
        mime_type:
          type: string
          enum:
          - image/jpeg
          - image/png
          - image/webp
          - image/heic
          - image/heif
          title: Mime Type
          description: The MIME type of the encoded image.
      additionalProperties: false
      type: object
      required:
      - type
      - content_base64
      - mime_type
      title: InlineImageReference
      description: 'An image passed inline as base64. The image is stored as an ephemeral

        asset with no guaranteed retention: it may be deleted at any time after

        the generation completes. To keep an input and reuse it across

        generations, upload it via the assets API (`POST /v1/assets`) and pass

        an `asset` reference instead.'
    StaticAssetReference:
      properties:
        type:
          type: string
          const: asset
          title: Type
        asset_id:
          type: string
          title: Asset Id
          description: The ID of an asset uploaded via the assets API (`POST /v1/assets`), as returned in that response's `asset_id`.
          examples:
          - 5xM2KqOnZyce22SPZ9d4
      additionalProperties: false
      type: object
      required:
      - type
      - asset_id
      title: StaticAssetReference
      description: An asset uploaded via the assets API.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    MediaGenerationCompletedResponse:
      properties:
        id:
          type: string
          title: Id
          description: The unique identifier of the generation.
          examples:
          - JWr5N6X9ZTqf8jD2LmQb
        status:
          type: string
          const: completed
          title: Status
          description: The lifecycle status of the generation.
          examples:
          - completed
        content_url:
          type: string
          title: Content Url
          description: A signed URL to download the generated media from. It expires about an hour after this response is returned; fetch the generation again for a fresh URL.
          examples:
          - https://storage.googleapis.com/generations/JWr5N6X9ZTqf8jD2LmQb
        content_mime_type:
          type: string
          title: Content Mime Type
          description: The MIME type of the generated media.
          examples:
          - video/mp4
          - image/png
          - audio/mpeg
      type: object
      required:
      - id
      - status
      - content_url
      - content_mime_type
      title: MediaGenerationCompletedResponse
      description: A completed media generation and its output.
      example:
        content_mime_type: video/mp4
        content_url: https://storage.googleapis.com/generations/JWr5N6X9ZTqf8jD2LmQb
        id: JWr5N6X9ZTqf8jD2LmQb
        status: completed
    Gemini31FlashLiteImageRequest:
      properties:
        webhook:
          anyOf:
          - $ref: '#/components/schemas/WebhookTarget'
          - type: 'null'
          description: Include to send the generation's result to the workspace's configured flows webhooks once it completes or fails. The webhook payload matches the terminal response of the corresponding GET endpoint.
          examples:
          - type: all
          - ids:
            - Q8mVr2LpXcT4nB6yJdKw
            type: ids
        prompt:
          type: string
          title: Prompt
          description: A text description of the image to generate.
          examples:
          - A corgi in a tiny lifeguard chair on a sunlit beach at golden hour, photorealistic
        model_id:
          type: string
          const: gemini-3.1-flash-lite-image
          title: Model Id
          description: The model to use for the generation.
        images:
          items:
            $ref: '#/components/schemas/ImageReference'
          type: array
          maxItems: 14
          title: Images
          description: Up to 14 reference images to edit or draw from.
        aspect_ratio:
          type: string
          enum:
          - auto
          - '1:1'
          - '2:3'
          - '3:2'
          - '3:4'
          - '4:3'
          - '4:5'
          - '5:4'
          - '9:16'
          - '16:9'
          - '21:9'
          title: Aspect Ratio
          description: The aspect ratio of the output image. With `auto`, the model picks an aspect ratio based on the inputs.
          default: '16:9'
        resolution:
          type: string
          const: 1K
          title: Resolution
          description: The resolution of the output image.
          default: 1K
      additionalProperties: false
      type: object
      required:
      - prompt
      - model_id
      title: Gemini31FlashLiteImageRequest
      description: Request body for the Google Gemini 3.1 Flash Lite image model.
    MediaGenerationResponse:
      oneOf:
      - $ref: '#/components/schemas/MediaGenerationInProgressResponse'
      - $ref: '#/components/schemas/MediaGenerationCompletedResponse'
      - $ref: '#/components/schemas/MediaGenerationFailedResponse'
      discriminator:
        propertyName: status
        mapping:
          completed: '#/components/schemas/MediaGenerationCompletedResponse'
          failed: '#/components/schemas/MediaGenerationFailedResponse'
          generating: '#/components/schemas/MediaGenerationInProgressResponse'
          pending: '#/components/schemas/MediaGenerationInProgressResponse'
    WebhookTarget:
      oneOf:
      - $ref: '#/components/schemas/WebhookTargetAll'
      - $ref: '#/components/schemas/WebhookTargetIds'
      discriminator:
        propertyName: type
        mapping:
          all: '#/components/schemas/WebhookTargetAll'
          ids: '#/components/schemas/WebhookTargetIds'
    Gemini31FlashImageRequest:
      properties:
        webhook:
          anyOf:
          - $ref: '#/components/schemas/WebhookTarget'
          - type: 'null'
          description: Include to send the generation's result to the workspace's configured flows webhooks once it completes or fails. The webhook payload matches the terminal response of the corresponding GET endpoint.
          examples:
          - type: all
          - ids:
            - Q8mVr2LpXcT4nB6yJdKw
            type: ids
        prompt:
          type: string
          title: Prompt
          description: A text description of the image to generate.
          examples:
          - A corgi in a tiny lifeguard chair on a sunlit beach at golden hour, photorealistic
        model_id:
          type: string
          const: gemini-3.1-flash-image
          title: Model Id
          description: The model to use for the generation.
        images:
          items:
            $ref: '#/components/schemas/ImageReference'
          type: array
          maxItems: 14
          title: Images
          description: Up to 14 reference images to edit or draw from.
        aspect_ratio:
          type: string
          enum:
          - auto
          - '1:1'
          - '2:3'
          - '3:2'
          - '3:4'
          - '4:3'
          - '4:5'
          - '5:4'
          - '9:16'
          - '16:9'
          - '21:9'
          - '1:4'
          - '4:1'
          - '1:8'
          - '8:1'
          title: Aspect Ratio
          description: The aspect ratio of the output image. With `auto`, the model picks an aspect ratio based on the inputs.
          default: '16:9'
        resolution:
          type: string
          enum:
          - '512'
          - 1K
          - 2K
          - 4K
          title: Resolution
          description: The resolution of the output image.
          default: 1K
      additionalProperties: false
      type: object
      required:
      - prompt
      - model_id
      title: Gemini31FlashImageRequest
      description: Request body for the Google Gemini 3.1 Flash image model.
    WebhookTargetAll:
      properties:
        type:
          type: string
          const: all
          title: Type
          description: Send the result to all of the workspace's configured flows webhooks.
          default: all
      type: object
      title: WebhookTargetAll
      description: Deliver the result to all of the workspace's configured flows webhooks.
    WebhookTargetIds:
      properties:
        type:
          type: string
          const: ids
          title: Type
          description: Send the result to the listed flows webhooks.
          default: ids
        ids:
          items:
            type: string
          type: array
          minItems: 1
          title: Ids
          description: The IDs of the workspace flows webhooks to deliver the result to. Each must be one of the workspace's configured flows webhooks.
          examples:
          - - Q8mVr2LpXcT4nB6yJdKw
      type: object
      required:
      - ids
      title: WebhookTargetIds
      description: Deliver the result to specific configured flows webhooks.
    MediaGenerationCreateResponse:
      properties:
        id:
          type: string
          title: Id
          description: The unique identifier of the generation. Pass it to the corresponding GET endpoint to retrieve the output.
          examples:
          - JWr5N6X9ZTqf8jD2LmQb
        status:
          type: string
          const: pending
          title: Status
          description: A newly created generation is always `pending`.
          examples:
          - pending
      type: object
      required:
      - id
      - status
      title: MediaGenerationCreateResponse
      description: A newly queued media generation; fetch the GET endpoint for the output.
      example:
        id: JWr5N6X9ZTqf8jD2LmQb
        status: pending
    GPTImage1_5Request:
      properties:
        webhook:
          anyOf:
          - $ref: '#/components/schemas/WebhookTarget'
          - type: 'null'
          description: Include to send the generation's result to the workspace's configured flows webhooks once it completes or fails. The webhook payload matches the terminal response of the corresponding GET endpoint.
          examples:
          - type: all
          - ids:
            - Q8mVr2LpXcT4nB6yJdKw
            type: ids
        prompt:
          type: string
          title: Prompt
          description: A text description of the image to generate.
          examples:
          - A corgi in a tiny lifeguard chair on a sunlit beach at golden hour, photorealistic
        images:
          items:
            $ref: '#/components/schemas/ImageReference'
          type: array
          maxItems: 5
          title: Images
          description: Up to 5 reference images to edit or draw from.
        mask:
          anyOf:
          - $ref: '#/components/schemas/ImageReference'
          - type: 'null'
          description: An image whose fully transparent areas mark where the first reference image may be edited; requires `images`.
        quality:
          type: string
          enum:
          - low
          - medium
          - high
          title: Quality
          description: The quality of the output image.
          default: medium
        background:
          type: string
          enum:
          - transparent
          - opaque
          - auto
          title: Background
          description: The background of the output image. With `auto`, the model picks the background that suits the image.
          default: auto
        aspect_ratio:
          type: string
          enum:
          - '1:1'
          - '3:2'
          - '2:3'
          title: Aspect Ratio
          description: The aspect ratio of the output image.
          default: '1:1'
        model_id:
          type: string
          const: gpt-image-1.5
          title: Model Id
          description: The model to use for the generation.
      additionalProperties: false
      type: object
      required:
      - prompt
      - model_id
      title: GPTImage1_5Request
      description: Request body for the OpenAI GPT Image 1.5 model.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    MediaGenerationListResponse:
      properties:
        generations:
          items:
            $ref: '#/components/schemas/MediaGenerationResponse'
          type: array
          title: Generations
          description: The generations on this page, newest first. Each item has the same shape as the corresponding GET endpoint's response.
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
          description: Pass as `cursor` to fetch the next page. `null` when there is no further page.
        has_more:
          type: boolean
          title: Has More
          description: Whether more generations exist beyond this page.
          readOnly: true
      type: object
      required:
      - generations
      - next_cursor
      - has_more
      title: MediaGenerationListResponse
      description: One page of the caller's generations, newest first.
      example:
        generations:
        - content_mime_type: video/mp4
          content_url: https://storage.googleapis.com/generations/JWr5N6X9ZTqf8jD2LmQb
          id: JWr5N6X9ZTqf8jD2LmQb
          status: completed
        - id: Kx2mP7Y4WVrg9kE3NnRc
          status: generating
        has_more: true
        next_cursor: MjAyNi0wNy0xN1QxMjowMDowMHxLeDJtUDdZNFdWcmc5a0UzTm5SYw
    GPTImage1Request:
      properties:
        webhook:
          anyOf:
          - $ref: '#/components/schemas/WebhookTarget'
          - type: 'null'
          description: Include to send the generation's result to the workspace's configured flows webhooks once it completes or fails. The webhook payload matches the terminal response of the corresponding GET endpoint.
          examples:
          - type: all
          - ids:
            - Q8mVr2LpXcT4nB6yJdKw
            type: ids
        prompt:
          type: string
          title: Prompt
          description: A text description of the image to generate.
          examples:
          - A corgi in a tiny lifeguard chair on a sunlit beach at golden hour, photorealistic
        images:
          items:
            $ref: '#/components/schemas/ImageReference'
          type: array
          maxItems: 5
          title: Images
          description: Up to 5 reference images to edit or draw from.
        mask:
          anyOf:
          - $ref: '#/components/schemas/ImageReference'
          - type: 'null'
          description: An image whose fully transparent areas mark where the first reference image may be edited; requires `images`.
        quality:
          type: string
          enum:
          - low
          - medium
          - high
          title: Quality
          description: The quality of the output image.
          default: medium
        background:
          type: string
          enum:
          - transparent
          - opaque
          - auto
          title: Background
          description: The background of the output image. With `auto`, the model picks the background that suits the image.
          default: auto
        aspect_ratio:
          type: string
          enum:
          - '1:1'
          - '3:2'
          - '2:3'
          title: Aspect Ratio
          description: The aspect ratio of the output image.
          default: '1:1'
        model_id:
          type: string
          const: gpt-image-1
          title: Model Id
          description: The model to use for the generation.
      additionalProperties: false
      type: object
      required:
      - prompt
      - model_id
      title: GPTImage1Request
      description: Request body for the OpenAI GPT Image 1 model.
    Gemini3ProImageRequest:
      properties:
        webhook:
          anyOf:
          - $ref: '#/components/schemas/WebhookTarget'
          - type: 'null'
          description: Include to send the generation's result to the workspace's configured flows webhooks once it completes or fails. The webhook payload matches the terminal response of the corresponding GET endpoint.
          examples:
          - type: all
          - ids:
            - Q8mVr2LpXcT4nB6yJdKw
            type: ids
        prompt:
          type: string
          title: Prompt
          description: A text description of the image to generate.
          examples:
          - A corgi in a tiny lifeguard chair on a sunlit beach at golden hour, photorealistic
        model_id:
          type: string
          const: gemini-3-pro-image
          title: Model Id
          description: The model to use for the generation.
        images:
          items:
            $ref: '#/components/schemas/ImageReference'
          type: array
          maxItems: 10
          title: Images
          description: Up to 10 reference images to edit or draw from.
        aspect_ratio:
          type: string
          enum:
          - auto
          - '1:1'
          - '2:3'
          - '3:2'
          - '3:4'
          - '4:3'
          - '4:5'
          - '5:4'
          - '9:16'
          - '16:9'
          - '21:9'
          title: Aspect Ratio
          description: The aspect ratio of the output image. With `auto`, the model picks an aspect ratio based on the inputs.
          default: '16:9'
        resolution:
          type: string
          enum:
          - 1K
          - 2K
          - 4K
          title: Resolution
          description: The resolution of the output image.
          default: 1K
      additionalProperties: false
      type: object
      required:
      - prompt
      - model_id
      title: Gemini3ProImageRequest
      description: Request body for the Google Gemini 3 Pro image model.
    GPTImage2Request:
      properties:
        webhook:
          anyOf:
          - $ref: '#/components/schemas/WebhookTarget'
          - type: 'null'
          description: Include to send the generation's result to the workspace's configured flows webhooks once it completes or fails. The webhook payload matches the terminal response of the corresponding GET endpoint.
          examples:
          - type: all
          - ids:
            - Q8mVr2LpXcT4nB6yJdKw
            type: ids
        prompt:
          type: string
          title: Prompt
          description: A text description of the image to generate.
          examples:
          - A corgi in a tiny lifeguard chair on a sunlit beach at golden hour, photorealistic
        images:
          items:
            $ref: '#/components/schemas/ImageReference'
          type: array
          maxItems: 10
          title: Images
          description: Up to 10 reference images to edit or draw from.
        mask:
          anyOf:
          - $ref: '#/components/schemas/ImageReference'
          - type: 'null'
          description: An image whose fully transparent areas mark where the first reference image may be edited; requires `images`.
        quality:
          type: string
          enum:
          - low
          - medium
          - high
          title: Quality
          description: The quality of the output image.
          default: medium
        model_id:
          type: string
          const: gpt-image-2
          title: Model Id
          description: The model to use for the generation.
        aspect_ratio:
          type: string
          enum:
          - auto
          - '1:1'
          - '4:5'
          - '5:4'
          - '3:4'
          - '4:3'
          - '2:3'
          - '3:2'
          - '1:2'
          - '2:1'
          - '9:16'
          - '16:9'
          - '21:9'
          - '1:3'
          - '3:1'
          title: Aspect Ratio
          description: The aspect ratio of the output image. With `auto`, the model picks an aspect ratio based on the inputs.
          default: '16:9'
        resolution:
          type: string
          enum:
          - 1K
          - 2K
          - 4K
          title: Resolution
          description: The resolution of the output image.
          default: 1K
      additionalProperties: false
      type: object
      required:
      - prompt
      - model_id
      title: GPTImage2Request
      description: Request body for the OpenAI GPT Image 2 model.
    ImageReference:
      oneOf:
      - $ref: '#/components/schemas/GenerationReference'
      - $ref: '#/components/schemas/StaticAssetReference'
      - $ref: '#/components/schemas/InlineImageReference'
      discriminator:
        propertyName: type
        mapping:
          asset: '#/components/schemas/StaticAssetReference'
          generation: '#/components/schemas/GenerationReference'
          inline_base64: '#/components/schemas/InlineImageReference'
    BytedanceSeedream5ProRequest:
      properties:
        webhook:
          anyOf:
          - $ref: '#/components/schemas/WebhookTarget'
          - type: 'null'
          description: Include to send the generation's result to the workspace's configured flows webhooks once it completes or fails. The webhook payload matches the terminal response of the corresponding GET endpoint.
          examples:
          - type: all
          - ids:
            - Q8mVr2LpXcT4nB6yJdKw
            type: ids
        prompt:
          type: string
          title: Prompt
          description: A text description of the image to generate.
          examples:
          - A corgi in a tiny lifeguard chair on a sunlit beach at golden hour, photorealistic
        images:
          items:
            $ref: '#/components/schemas/ImageReference'
          type: array
          maxItems: 10
          title: Images
          description: Up to 10 reference images to edit or draw from.
        aspect_ratio:
          type: string
          enum:
          - auto
          - '1:1'
          - '3:4'
          - '16:9'
          - '4:3'
          - '9:16'
          title: Aspect Ratio
          description: The aspect ratio of the output image. With `auto`, the model picks an aspect ratio based on the inputs.
          default: '16:9'
        seed:
          anyOf:
          - type: integer
          - type: 'null'
          title: Seed
          description: 'A seed for reproducible generation: the same seed and inputs give similar output across generations. Omit for random.'
        model_id:
          type: string
          const: bytedance-seedream-5-pro
          title: Model Id
          description: The model to use for the generation.
        resolution:
          type: string
          enum:
          - 1K
          - 2K
          title: Resolution
          description: The resolution of the output image.
          default: 2K
      additionalProperties: false
      type: object
      required:
      - prompt
      - model_id
      title: BytedanceSeedream5ProRequest
      description: 'Request body for the ByteDance Seedream 5.0 Pro image model.


        ByteDance models are disabled by default and require explicit approval

        before use. Contact support to request access.'
    Gemini25FlashImageRequest:
      properties:
        webhook:
          anyOf:
          - $ref: '#/components/schemas/WebhookTarget'
          - type: 'null'
          description: Include to send the generation's result to the workspace's configured flows webhooks once it completes or fails. The webhook payload matches the terminal response of the corresponding GET endpoint.
          examples:
          - type: all
          - ids:
            - Q8mVr2LpXcT4nB6yJdKw
            type: ids
        prompt:
          type: string
          title: Prompt
          description: A text description of the image to generate.
          examples:
          - A corgi in a tiny lifeguard chair on a sunlit beach at golden hour, photorealistic
        model_id:
          type: string
          const: gemini-2.5-flash-image
          title: Model Id
          description: The model to use for the generation.
        images:
          items:
            $ref: '#/components/schemas/ImageReference'
          type: array
          maxItems: 5
          title: Images
          description: Up to 5 reference images to edit or draw from.
        aspect_ratio:
          type: string
          enum:
          - auto
          - '1:1'
          - '2:3'
          - '3:2'
          - '3:4'
          - '4:3'
          - '4:5'
          - '5:4'
          - '9:16'
          - '16:9'
          - '21:9'
          title: Aspect Ratio
          description: The aspect ratio of the output image. With `auto`, the model picks an aspect ratio based on the inputs.
          default: '16:9'
      additionalProperties: false
      type: object
      required:
      - prompt
      - model_id
      title: Gemini25FlashImageRequest
      description: Request body for the Google Gemini 2.5 Flash image model.
    BytedanceSeedream5LiteRequest:
      properties:
        webhook:
          anyOf:
          - $ref: '#/components/schemas/WebhookTarget'
          - type: 'null'
          description: Include to send the generation's result to the workspace's configured flows webhooks once it completes or fails. The webhook payload matches the terminal response of the corresponding GET endpoint.
          examples:
          - type: all
          - ids:
            - Q8mVr2LpXcT4nB6yJdKw
            type: ids
        prompt:
          type: string
          title: Prompt
          description: A text description of the image to generate.
          examples:
          - A corgi in a tiny lifeguard chair on a sunlit beach at golden hour, photorealistic
        images:
          items:
            $ref: '#/components/schemas/ImageReference'
          type: array
          maxItems: 10
          title: Images
          description: Up to 10 reference images to edit or draw from.
        aspect_ratio:
          type: string
          enum:
          - auto
          - '1:1'
          - '3:4'
          - '16:9'
          - '4:3'
          - '9:16'
          title: Aspect Ratio
          description: The aspect ratio of the output image. With `auto`, the model picks an aspect ratio based on the inputs.
          default: '16:9'
        seed:
          anyOf:
          - type: integer
          - type: 'null'
          title: Seed
          description: 'A seed for reproducible generation: the same seed and inputs give similar output across generations. Omit for random.'
        model_id:
          type: string
          const: bytedance-seedream-5-lite
          title: Model Id
          description: The model to use for the generation.
        resolution:
          type: string
          enum:
          - 2K
          - 3K
          title: Resolution
          description: The resolution of the output image.
          default: 2K
      additionalProperties: false
      type: object
      required:
      - prompt
      - model_id
      title: BytedanceSeedream5LiteRequest
      description: 'Request body for the ByteDance Seedream 5.0 Lite image model.


        ByteDance models are disabled by default and require explicit approval

        before use. Contact support to request access.'
    GenerationReference:
      properties:
        type:
          type: string
          const: generation
          title: Type
        generation_id:
          type: string
          title: Generation Id
          description: The ID of the generation whose output to use, as returned when the generation was created.
          examples:
          - JWr5N6X9ZTqf8jD2LmQb
      additionalProperties: false
      type: object
      required:
      - type
      - generation_id
      title: GenerationReference
      description: The output of a prior generation on this API.
    MediaGenerationInProgressResponse:
      properties:
        id:
          type: string
          title: Id
          description: The unique identifier of the generation.
          examples:
          - JWr5N6X9ZTqf8jD2LmQb
        status:
          type: string
          enum:
          - pending
          - generating
          title: Status
          description: The lifecycle status of the generation. It ends at `completed` or `failed`.
          examples:
          - generating
      type: object
      required:
      - id
      - status
      title: MediaGenerationInProgressResponse
      description: A media generation that has not finished yet.
      example:
        id: JWr5N6X9ZTqf8jD2LmQb
        status: generating