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

# Generation Status

> Poll a font generation job and retrieve the generated TTF file

Fetch the current status of a font generation job. Poll this endpoint until `status` is `succeeded`, `failed`, or `cancelled`.

When `status` is `succeeded`, `ttf_url` contains the generated TTF download URL.


## OpenAPI

````yaml api-reference/font-generation-openapi.json GET /v1/font-generations/{jobId}
openapi: 3.1.0
info:
  title: Mixfont Font Generation API
  description: Generate TTF font files from a text prompt or a public reference image.
  version: 1.0.0
servers:
  - url: https://api.mixfont.com
security: []
paths:
  /v1/font-generations/{jobId}:
    get:
      summary: Get font generation status
      description: >-
        Fetch the current status of a font generation job. Poll this endpoint
        until the job reaches `succeeded`, `failed`, or `cancelled`.
      operationId: getFontGeneration
      parameters:
        - name: jobId
          in: path
          required: true
          description: Generation id returned by the create endpoint.
          schema:
            type: string
          example: 7d58a66d-f129-4f9a-bf9a-4f2c6d0c3e4d
      responses:
        '200':
          description: Current generation status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FontGenerationResponse'
              example:
                id: 7d58a66d-f129-4f9a-bf9a-4f2c6d0c3e4d
                name: Nebula Sans
                ttf_url: >-
                  https://static.mixfont.com/uploads/generated/7d58a66d-f129-4f9a-bf9a-4f2c6d0c3e4d/font.ttf
                status: succeeded
                input_type: text
                glyph_set: standard
                progress_percent: 100
                created_at: '2026-06-02T21:12:42.000Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/LoadInternalError'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    FontGenerationResponse:
      type: object
      required:
        - id
        - name
        - ttf_url
        - status
        - input_type
        - glyph_set
        - progress_percent
        - created_at
      properties:
        id:
          type: string
          description: Generation id.
        name:
          type: string
          description: Generated font display name.
        ttf_url:
          type:
            - string
            - 'null'
          format: uri
          description: >-
            Download URL for the generated TTF file. This is `null` until the
            job succeeds.
        status:
          $ref: '#/components/schemas/GenerationStatus'
        input_type:
          $ref: '#/components/schemas/GenerationInputType'
        glyph_set:
          $ref: '#/components/schemas/GenerationGlyphSet'
        progress_percent:
          type: number
          minimum: 0
          maximum: 100
          description: Approximate job progress percentage.
        error:
          type: string
          description: >-
            Error message. Present only when `status` is `failed` and an error
            message is available.
        created_at:
          type: string
          format: date-time
          description: ISO timestamp for when the generation was created.
    GenerationStatus:
      type: string
      enum:
        - preparing
        - queued
        - running
        - succeeded
        - cancelled
        - failed
    GenerationInputType:
      type: string
      enum:
        - text
        - image
    GenerationGlyphSet:
      type: string
      enum:
        - standard
        - extended
      default: standard
      description: >-
        `standard` generates 72 glyphs to support English with basic letters,
        numbers, and punctuation. `extended` generates 319 glyphs to support all
        Latin languages, including special characters, costs more credits, and
        may take 2-3 minutes to complete.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Error message describing what went wrong.
  responses:
    BadRequest:
      description: Invalid request body or parameter
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: prompt is required.
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Unauthorized.
    NotFound:
      description: Generation not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Font generation not found.
    LoadInternalError:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Failed to load font generation.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````