Frameo Generations API

openapi: 3.2.0
info:
  title: Frameo Generations API
  description: Generate video and images with Frameo's models from your own code.
  version: '1'
servers:
- url: https://api.frameo.ai
tags:
- name: Generations
paths:
  /v1/estimates:
    post:
      tags:
      - Generations
      summary: Estimate a generation
      description: What a generation would cost this workspace, after its pricing overrides. Nothing is charged.
      operationId: estimate_v1_estimates_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerationInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Estimate'
        '400':
          description: The request is invalid (invalid_request_error)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, revoked or expired API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Not enough credits (billing_error)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The key lacks a scope, or the workspace can't use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No such object in this workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate or concurrency limit; see Retry-After
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Upstream failure (api_error); safe to retry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Briefly unavailable (api_error); safe to retry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '504':
          description: Timed out upstream (api_error); safe to retry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - apiKey: []
  /v1/generations:
    post:
      tags:
      - Generations
      summary: Create a generation
      description: 'Start a generation. With an `Idempotency-Key`, a retry is safe: the same key and request

        return the same generation, and the same key with a different request is refused (409). If

        the platform is slow to answer, the generation still comes back, queued, and is confirmed in

        the background.'
      operationId: create_generation_v1_generations_post
      parameters:
      - name: idempotency-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: Idempotency-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGeneration'
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedGeneration'
        '400':
          description: The request is invalid (invalid_request_error)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, revoked or expired API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Not enough credits (billing_error)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The key lacks a scope, or the workspace can't use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No such object in this workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate or concurrency limit; see Retry-After
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Upstream failure (api_error); safe to retry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Briefly unavailable (api_error); safe to retry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '504':
          description: Timed out upstream (api_error); safe to retry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: The Idempotency-Key was used with a different request, or its first request is still in progress
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - apiKey: []
    get:
      tags:
      - Generations
      summary: List generations
      description: 'This workspace''s API generations, newest first. Pass the last id of a page as

        `starting_after` to get the next one.'
      operationId: list_generations_v1_generations_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 20
          title: Limit
      - name: starting_after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 40
          - type: 'null'
          title: Starting After
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerationList'
        '400':
          description: The request is invalid (invalid_request_error)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, revoked or expired API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Not enough credits (billing_error)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The key lacks a scope, or the workspace can't use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No such object in this workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate or concurrency limit; see Retry-After
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Upstream failure (api_error); safe to retry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Briefly unavailable (api_error); safe to retry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '504':
          description: Timed out upstream (api_error); safe to retry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - apiKey: []
  /v1/generations/{generation_id}:
    get:
      tags:
      - Generations
      summary: Get a generation
      operationId: get_generation_v1_generations__generation_id__get
      parameters:
      - name: generation_id
        in: path
        required: true
        schema:
          type: string
          title: Generation Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Generation'
        '400':
          description: The request is invalid (invalid_request_error)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing, invalid, revoked or expired API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Not enough credits (billing_error)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: The key lacks a scope, or the workspace can't use this
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No such object in this workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate or concurrency limit; see Retry-After
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Upstream failure (api_error); safe to retry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Briefly unavailable (api_error); safe to retry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '504':
          description: Timed out upstream (api_error); safe to retry
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - apiKey: []
components:
  schemas:
    CreateGeneration:
      properties:
        model:
          type: string
          maxLength: 120
          minLength: 1
          title: Model
        prompt:
          anyOf:
          - type: string
            maxLength: 20000
          - type: 'null'
          title: Prompt
        negative_prompt:
          anyOf:
          - type: string
            maxLength: 20000
          - type: 'null'
          title: Negative Prompt
        images:
          items:
            $ref: '#/components/schemas/Media'
          type: array
          maxItems: 32
          title: Images
        videos:
          items:
            $ref: '#/components/schemas/Media'
          type: array
          maxItems: 8
          title: Videos
        audios:
          items:
            $ref: '#/components/schemas/Media'
          type: array
          maxItems: 8
          title: Audios
        duration_seconds:
          anyOf:
          - type: integer
          - type: 'null'
          title: Duration Seconds
        resolution:
          anyOf:
          - type: string
            maxLength: 20
          - type: 'null'
          title: Resolution
        aspect_ratio:
          anyOf:
          - type: string
            maxLength: 20
          - type: 'null'
          title: Aspect Ratio
        generate_audio:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Generate Audio
        seed:
          anyOf:
          - type: integer
          - type: 'null'
          title: Seed
        draft:
          anyOf:
          - $ref: '#/components/schemas/Draft'
          - type: 'null'
        metadata:
          additionalProperties:
            type: string
          type: object
          title: Metadata
      additionalProperties: false
      type: object
      required:
      - model
      title: CreateGeneration
    Estimate:
      properties:
        object:
          type: string
          const: estimate
          title: Object
          default: estimate
        model:
          type: string
          title: Model
        type:
          type: string
          title: Type
        credits:
          type: integer
          title: Credits
          description: What the generation would cost this workspace.
        standard_credits:
          type: integer
          title: Standard Credits
          description: List price; differs only when an override applies.
      type: object
      required:
      - model
      - type
      - credits
      - standard_credits
      title: Estimate
    GenerationError:
      properties:
        code:
          type: string
          title: Code
          examples:
          - generation_failed
        message:
          type: string
          title: Message
      type: object
      required:
      - code
      - message
      title: GenerationError
    Draft:
      properties:
        mode:
          type: string
          enum:
          - draft
          - finalize
          title: Mode
        source_generation_id:
          anyOf:
          - type: string
            maxLength: 64
          - type: 'null'
          title: Source Generation Id
      additionalProperties: false
      type: object
      required:
      - mode
      title: Draft
      description: 'Draft mode: `draft` renders a cheap preview; `finalize` renders one finished draft in full,

        named by its generation id.'
    Output:
      properties:
        type:
          type: string
          title: Type
          description: video or image
          examples:
          - video
        url:
          type: string
          title: Url
          description: Ready to download. A private file comes back signed for an hour.
        width:
          anyOf:
          - type: integer
          - type: 'null'
          title: Width
        height:
          anyOf:
          - type: integer
          - type: 'null'
          title: Height
        duration_seconds:
          anyOf:
          - type: number
          - type: 'null'
          title: Duration Seconds
      type: object
      required:
      - type
      - url
      title: Output
    ErrorBody:
      properties:
        type:
          type: string
          title: Type
          examples:
          - invalid_request_error
        code:
          type: string
          title: Code
          examples:
          - parameter_invalid
        message:
          type: string
          title: Message
      type: object
      required:
      - type
      - code
      - message
      title: ErrorBody
    Media:
      properties:
        url:
          type: string
          maxLength: 4096
          minLength: 1
          title: Url
        role:
          anyOf:
          - type: string
            maxLength: 40
          - type: 'null'
          title: Role
      additionalProperties: false
      type: object
      required:
      - url
      title: Media
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    CreatedGeneration:
      properties:
        id:
          type: string
          title: Id
          examples:
          - gen_01JB4Z6Q1V5T8R2N3M4K5J6H7G
        object:
          type: string
          const: generation
          title: Object
          default: generation
        type:
          anyOf:
          - type: string
          - type: 'null'
          title: Type
          description: video or image
          examples:
          - video
        model:
          type: string
          title: Model
          examples:
          - seedance_2_0
        status:
          type: string
          enum:
          - queued
          - running
          - succeeded
          - failed
          - cancelled
          title: Status
          examples:
          - succeeded
        created_at:
          type: string
          title: Created At
        updated_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Updated At
        outputs:
          items:
            $ref: '#/components/schemas/Output'
          type: array
          title: Outputs
          description: Filled once the generation has succeeded.
        credits:
          anyOf:
          - $ref: '#/components/schemas/Credits'
          - type: 'null'
          description: Null until the first charge lands.
        error:
          anyOf:
          - $ref: '#/components/schemas/GenerationError'
          - type: 'null'
          description: Set when the generation failed.
        draft:
          anyOf:
          - $ref: '#/components/schemas/DraftInfo'
          - type: 'null'
          description: Set for a draft-mode video; null otherwise.
        metadata:
          additionalProperties:
            type: string
          type: object
          title: Metadata
          description: Your own key/value pairs, as sent.
        estimated_time_seconds:
          anyOf:
          - type: integer
          - type: 'null'
          title: Estimated Time Seconds
      type: object
      required:
      - id
      - type
      - model
      - status
      - created_at
      - outputs
      - credits
      - error
      - metadata
      title: CreatedGeneration
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GenerationInput:
      properties:
        model:
          type: string
          maxLength: 120
          minLength: 1
          title: Model
        prompt:
          anyOf:
          - type: string
            maxLength: 20000
          - type: 'null'
          title: Prompt
        negative_prompt:
          anyOf:
          - type: string
            maxLength: 20000
          - type: 'null'
          title: Negative Prompt
        images:
          items:
            $ref: '#/components/schemas/Media'
          type: array
          maxItems: 32
          title: Images
        videos:
          items:
            $ref: '#/components/schemas/Media'
          type: array
          maxItems: 8
          title: Videos
        audios:
          items:
            $ref: '#/components/schemas/Media'
          type: array
          maxItems: 8
          title: Audios
        duration_seconds:
          anyOf:
          - type: integer
          - type: 'null'
          title: Duration Seconds
        resolution:
          anyOf:
          - type: string
            maxLength: 20
          - type: 'null'
          title: Resolution
        aspect_ratio:
          anyOf:
          - type: string
            maxLength: 20
          - type: 'null'
          title: Aspect Ratio
        generate_audio:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Generate Audio
        seed:
          anyOf:
          - type: integer
          - type: 'null'
          title: Seed
        draft:
          anyOf:
          - $ref: '#/components/schemas/Draft'
          - type: 'null'
      additionalProperties: false
      type: object
      required:
      - model
      title: GenerationInput
      description: 'The request a generation is made from. This fixes the shape; `catalog.check` holds the

        values to what the model lists, and the gateway has the last word.'
    Credits:
      properties:
        charged:
          type: integer
          title: Charged
          description: 'Net credits charged: debits less refunds.'
        standard:
          type: integer
          title: Standard
          description: The same at list price, before the workspace's overrides.
      type: object
      required:
      - charged
      - standard
      title: Credits
    DraftInfo:
      properties:
        mode:
          type: string
          enum:
          - draft
          - finalize
          title: Mode
          description: 'draft: a preview render; finalize: the full render of one draft.'
      type: object
      required:
      - mode
      title: DraftInfo
    GenerationList:
      properties:
        object:
          type: string
          const: list
          title: Object
          default: list
        data:
          items:
            $ref: '#/components/schemas/Generation'
          type: array
          title: Data
        has_more:
          type: boolean
          title: Has More
      type: object
      required:
      - data
      - has_more
      title: GenerationList
    ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      type: object
      required:
      - error
      title: ErrorResponse
    Generation:
      properties:
        id:
          type: string
          title: Id
          examples:
          - gen_01JB4Z6Q1V5T8R2N3M4K5J6H7G
        object:
          type: string
          const: generation
          title: Object
          default: generation
        type:
          anyOf:
          - type: string
          - type: 'null'
          title: Type
          description: video or image
          examples:
          - video
        model:
          type: string
          title: Model
          examples:
          - seedance_2_0
        status:
          type: string
          enum:
          - queued
          - running
          - succeeded
          - failed
          - cancelled
          title: Status
          examples:
          - succeeded
        created_at:
          type: string
          title: Created At
        updated_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Updated At
        outputs:
          items:
            $ref: '#/components/schemas/Output'
          type: array
          title: Outputs
          description: Filled once the generation has succeeded.
        credits:
          anyOf:
          - $ref: '#/components/schemas/Credits'
          - type: 'null'
          description: Null until the first charge lands.
        error:
          anyOf:
          - $ref: '#/components/schemas/GenerationError'
          - type: 'null'
          description: Set when the generation failed.
        draft:
          anyOf:
          - $ref: '#/components/schemas/DraftInfo'
          - type: 'null'
          description: Set for a draft-mode video; null otherwise.
        metadata:
          additionalProperties:
            type: string
          type: object
          title: Metadata
          description: Your own key/value pairs, as sent.
      type: object
      required:
      - id
      - type
      - model
      - status
      - created_at
      - outputs
      - credits
      - error
      - metadata
      title: Generation
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Your API key, fk_live_...