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

# 4. Follow progress

> Free. Poll every 5 to 10 seconds.



## OpenAPI

````yaml https://lavendly.ai/openapi.json get /v1/workflows/{id}/generation-status
openapi: 3.1.0
info:
  title: Lavendly API
  version: 1.1.0
  description: >-
    The Lavendly v1 API: build a video from shots, price it, generate the
    scenes, render the film, and publish it. Authenticate with a Bearer API key
    (lv_...) from Settings > API. Rate limits are per account per minute: 20
    writes, 60 render polls, 120 other reads; a 429 carries Retry-After and
    retry_after_ms. Errors are { error: { code, message } }; 5xx adds a ref. The
    same API is an MCP server at https://mcp.lavendly.ai/mcp and in the
    @lavendly/mcp npm package.
  contact:
    name: Lavendly
    email: hello@lavendly.ai
servers:
  - url: https://lavendly.ai/api
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Create to publish
    description: The main loop, in order.
  - name: Workflows
  - name: Edit
  - name: Audio
  - name: Assets
  - name: Renders
  - name: Account
  - name: Single clips
paths:
  /v1/workflows/{id}/generation-status:
    parameters:
      - name: id
        in: path
        required: true
        description: Workflow id
        schema:
          type: string
    get:
      tags:
        - Create to publish
      summary: 4. Follow progress
      description: Free. Poll every 5 to 10 seconds.
      operationId: getGenerationStatus
      responses:
        '200':
          description: Status
          content:
            application/json:
              schema:
                type: object
                properties:
                  workflow_id:
                    type: string
                  phase:
                    type: string
                    enum:
                      - idle
                      - queued
                      - scripting
                      - generating_images
                      - generating_clips
                      - voice
                      - stitching
                      - uploading
                      - running
                      - done
                      - failed
                      - needs_browser
                  progress:
                    type: number
                    description: 0 to 1
                  progress_message:
                    type: string
                  seconds_since_update:
                    type:
                      - integer
                      - 'null'
                  stalled:
                    type: boolean
                  needs_browser:
                    type: boolean
                  job_id:
                    type:
                      - string
                      - 'null'
                  artifacts:
                    type: array
                    description: Scene clips finished so far
                  video_url:
                    type:
                      - string
                      - 'null'
                  hint:
                    type: string
        '401':
          $ref: '#/components/responses/E401'
components:
  responses:
    E401:
      description: Missing or revoked key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: unauthenticated
              message: ...
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            ref:
              type: string
              description: '5xx only: quote to support'
            retry_after_ms:
              type: integer
              description: 429 rate_limited only
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key from Settings > API, e.g. lv_...

````