> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mage.space/llms.txt
> Use this file to discover all available pages before exploring further.

# Generate

> Submit a generation with any Mage model: the partial config body, the Idempotency-Key header, the 202 response, and every error the generate endpoint can return.

Submit a generation. The body is a partial config for the architecture in the path: it is layered onto the architecture's default config, so every field you leave out keeps its default. Each model page lists the fields its architecture accepts, with tokens and defaults; the same schema comes back from [`GET /v1/architectures`](/api/endpoints/list-architectures) as `input_schema`.

The response is the request's current state, with `status_url` to poll and `cancel_url` to stop it. Gems are charged when the request is accepted; a request that fails is refunded. See [Requests and lifecycle](/api/requests) for what happens next.

This page documents the endpoint in general. For a specific model, open its page under [Models](/api/models/overview): the playground there is filled in with that model's fields.


## OpenAPI

````yaml api/openapi.json POST /v1/{architecture}/generate
openapi: 3.1.0
info:
  title: Mage API
  version: v1
  description: >-
    Run Mage models from your own code: submit a generation, poll its status,
    download the result. Every request is paid in gems.
  contact:
    name: Mage
    url: https://www.mage.space
    email: mage@mage.space
servers:
  - url: https://api.mage.space
    description: Production
security:
  - apiKey: []
tags:
  - name: Requests
    description: Submit, poll, and cancel generations.
  - name: Catalog
    description: What the API can generate with.
  - name: Account
    description: The gems balance.
  - name: Uploads
    description: Large input files.
  - name: Image models
    description: One endpoint per image architecture.
  - name: Video models
    description: One endpoint per video architecture.
paths:
  /v1/{architecture}/generate:
    post:
      tags:
        - Requests
      summary: Generate
      description: Submit a generation with any architecture.
      operationId: generate
      parameters:
        - name: architecture
          in: path
          required: true
          description: The architecture id, from the catalog.
          schema:
            type: string
            enum:
              - mango
              - krea_2
              - minimax_h3
              - z_image
              - stable_diffusion_xl
              - kiwi
              - peach_max
              - blueberry
              - wan_22
              - wan
              - flux2
              - flux
              - chroma
              - peach
              - qwen_image
              - qwen_image_edit_plus
              - hidream
              - framepack
              - ltx_video
              - selfie
              - stable_diffusion_v15
              - stable_diffusion_v35_large
              - stable_diffusion_v35_medium
              - veo3
              - veo3_1
              - flux_kontext_dev
              - guava
              - nano_banana_v2
              - sdxl_plus
              - cherry
              - raspberry
              - grok_image
              - grok_video
              - berry
              - gpt_image_2
              - anima
              - melon
              - plum
              - lemon
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            A key of your choosing, 1 to 255 characters, scoped to your API key.
            A retried submit with the same key returns the original request with
            `200` instead of charging again. The key identifies the first
            submission made with it; later bodies are not compared. A refusal
            recorded under the key (its envelope carries `request_id`) replays
            the same way, so a new attempt needs a new key.
          schema:
            type: string
            minLength: 1
            maxLength: 255
      requestBody:
        required: true
        description: A partial config for the architecture.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateRequest'
            example:
              prompt: Editorial portrait in soft daylight, 35mm film look
      responses:
        '202':
          description: >-
            The request was accepted; poll `status_url` for the result. A
            retried submit whose `Idempotency-Key` was used before answers `200`
            with the same shape, the original request, and charges nothing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Request'
              example:
                request_id: d7e6c0f3-6699-4f6c-bb45-2ad7fd9158ff
                status: in_progress
                architecture: flux2
                model_id: flux2-dev
                created_at: '2026-09-17T14:52:48.000Z'
                updated_at: '2026-09-17T14:52:49.000Z'
                billing:
                  mode: gems
                  gems_charged: 40
                result: null
                error: null
                status_url: >-
                  https://api.mage.space/v1/requests/d7e6c0f3-6699-4f6c-bb45-2ad7fd9158ff/status
                cancel_url: >-
                  https://api.mage.space/v1/requests/d7e6c0f3-6699-4f6c-bb45-2ad7fd9158ff/cancel
        '400':
          $ref: '#/components/responses/InvalidGenerateRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/InsufficientGems'
        '403':
          $ref: '#/components/responses/GenerationForbidden'
        '404':
          description: No such architecture.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error:
                  code: architecture_not_found
                  message: >-
                    Unknown architecture `fluxx`. List architectures at GET
                    /v1/architectures.
        '410':
          $ref: '#/components/responses/ArchitectureRetired'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '451':
          $ref: '#/components/responses/ExternalContentBlock'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    GenerateRequest:
      type: object
      properties:
        prompt:
          type: string
          minLength: 1
          description: The text prompt.
        model_id:
          description: The model variant; the architecture default when omitted.
          type: string
        seed:
          description: >-
            Integer seed for reproducible output; omit or send null for a random
            seed.
          anyOf:
            - type: integer
            - type: 'null'
      required:
        - prompt
      additionalProperties: true
    Request:
      type: object
      properties:
        request_id:
          type: string
          format: uuid
          description: The request id, also the id in `status_url` and `cancel_url`.
        status:
          type: string
          enum:
            - queued
            - in_progress
            - completed
            - failed
            - cancelled
          description: >-
            `queued` and `in_progress` are live; `completed`, `failed`, and
            `cancelled` are final.
        architecture:
          type: string
          description: The architecture the request generates with.
        model_id:
          anyOf:
            - type: string
            - type: 'null'
          description: The model variant, when the architecture has variants.
        created_at:
          type: string
          format: date-time
          description: When the request was accepted.
        updated_at:
          type: string
          format: date-time
          description: When the request last changed.
        billing:
          type: object
          properties:
            mode:
              type: string
              const: gems
              description: Every API request is paid in gems.
            gems_charged:
              type: number
              description: Gems debited for the request.
            gems_refunded:
              description: Gems returned to the account; present on failed requests.
              type: number
          required:
            - mode
            - gems_charged
          additionalProperties: false
        result:
          anyOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - image
                    - video
                    - audio
                  description: The media type of the output.
                url:
                  type: string
                  format: uri
                  description: Where to download the output.
                width:
                  type: integer
                  description: Output width in pixels.
                height:
                  type: integer
                  description: Output height in pixels.
                seed:
                  type: integer
                  description: The seed the generation ran with.
                expires_at:
                  anyOf:
                    - type: string
                      format: date-time
                    - type: 'null'
                  description: >-
                    When `url` stops working: 30 days after the request for
                    temporary media, or null for permanent media.
                moderation:
                  type: object
                  properties:
                    nsfw:
                      type: boolean
                      description: Whether moderation flagged the output as NSFW.
                  required:
                    - nsfw
                  additionalProperties: false
                  description: Moderation flags on the output.
              required:
                - type
                - url
                - width
                - height
                - seed
                - expires_at
                - moderation
              additionalProperties: false
            - type: 'null'
          description: The output once `status` is `completed`, else null.
        error:
          anyOf:
            - type: object
              properties:
                code:
                  type: string
                  enum:
                    - unauthorized
                    - invalid_request
                    - invalid_config
                    - architecture_not_found
                    - architecture_retired
                    - request_not_found
                    - not_found
                    - insufficient_gems
                    - forbidden
                    - content_blocked
                    - request_finished
                    - too_many_requests
                    - generation_failed
                    - internal_error
                  description: A stable error code.
                message:
                  type: string
                  description: What went wrong, for a person.
              required:
                - code
                - message
              additionalProperties: false
            - type: 'null'
          description: Why the request failed once `status` is `failed`, else null.
        status_url:
          type: string
          format: uri
          description: Poll this URL for the request.
        cancel_url:
          type: string
          format: uri
          description: POST to this URL to stop the request.
      required:
        - request_id
        - status
        - architecture
        - model_id
        - created_at
        - updated_at
        - billing
        - result
        - error
        - status_url
        - cancel_url
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - unauthorized
                - invalid_request
                - invalid_config
                - architecture_not_found
                - architecture_retired
                - request_not_found
                - not_found
                - insufficient_gems
                - forbidden
                - content_blocked
                - request_finished
                - too_many_requests
                - generation_failed
                - internal_error
              description: A stable error code; treat an unknown code by its HTTP status.
            message:
              type: string
              description: What went wrong, for a person.
            request_id:
              description: >-
                The request the refusal belongs to, when one was recorded before
                the refusal.
              type: string
              format: uuid
            gems_required:
              description: The price of the refused generation, on `insufficient_gems`.
              type: number
            docs_url:
              description: Where to read the API reference, on `not_found`.
              type: string
              format: uri
          required:
            - code
            - message
          additionalProperties: true
          description: Further fields depend on the code.
      required:
        - error
      additionalProperties: false
  responses:
    InvalidGenerateRequest:
      description: >-
        The body is not a JSON object, sets a server-owned field, contradicts
        the architecture, breaks a field's type or token list, or breaks a model
        rule; or the `Idempotency-Key` is malformed. `invalid_config` names the
        field or the rule.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_config
              message: '`resolution` must be one of: 768P, 2K.'
    Unauthorized:
      description: The key is missing, malformed, unknown, or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: unauthorized
              message: The API key is invalid or has been revoked.
    InsufficientGems:
      description: The gems balance is below the price. `gems_required` is the price.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: insufficient_gems
              message: >-
                This generation costs 40 gems and the account balance is too
                low.
              request_id: d7e6c0f3-6699-4f6c-bb45-2ad7fd9158ff
              gems_required: 40
    GenerationForbidden:
      description: >-
        The account cannot generate (`forbidden`), or the request was blocked by
        the content policy before it ran (`content_blocked`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: content_blocked
              message: The request was blocked by Mage's content policy.
              request_id: d7e6c0f3-6699-4f6c-bb45-2ad7fd9158ff
    ArchitectureRetired:
      description: The architecture has been retired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: architecture_retired
              message: This architecture has been retired.
              request_id: d7e6c0f3-6699-4f6c-bb45-2ad7fd9158ff
    TooManyRequests:
      description: >-
        The account already has its cap of generations in flight (20 unless set
        otherwise for the account), web and API together. Wait for some to
        finish.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: too_many_requests
              message: >-
                At most 20 generations may be in flight at once for this
                account; 20 are running now.
    ExternalContentBlock:
      description: The request was blocked by an external content restriction.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: content_blocked
              message: The request was blocked by an external content restriction.
              request_id: d7e6c0f3-6699-4f6c-bb45-2ad7fd9158ff
    InternalError:
      description: >-
        Something failed on Mage's side. Retry, and contact support if it
        persists.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: internal_error
              message: >-
                Something went wrong on our side. Retry, and contact support if
                it persists.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from Settings → API, sent as `Authorization: Bearer
        mage_sk_…`. Keys are for server-side code only.

````