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

# Plan Compose Video

> **Preview** what `POST /v1/compose/video` will do for a script — the
format it routes to, the estimated cost, and the per-beat storyboard —
**without generating any media or spending a credit.** Fast (one LLM
call). Use it to show the plan + cost and confirm before committing.

`ready: false` with `missingInputs` / `blockers` tells you exactly what to
supply before dispatching. Accepts the same steering fields as
`/v1/compose/video` (`format`, `direction`, `sections`, `inputs`,
`aspectRatio`).


Preview what a compose call will do — the format it routes to, the estimated cost, and the per-beat storyboard — **without generating anything or spending a credit.** Fast (one LLM call).

Call this first to show the user the plan + cost and confirm before committing. `ready: false` with `missingInputs` / `blockers` tells you exactly what to supply. Accepts the same steering fields as the compose call: `format`, `direction`, `sections`, `inputs`, `aspectRatio`.


## OpenAPI

````yaml POST /v1/compose/plan
openapi: 3.1.0
info:
  title: Lamina Apps API
  version: 1.0.0
  description: >
    Professional creative content production for AI agents. Create brand-aligned
    images, videos, and designs from natural-language briefs using 30+
    specialized AI pipelines.


    Unlike raw model APIs (DALL-E, Flux, Kling), Lamina automatically applies
    brand guidelines, selects the optimal multi-model pipeline, scores output
    quality, and delivers permanent CDN-hosted URLs with composability metadata
    for chaining.


    ## Authentication

    All endpoints require an API key passed via one of these headers:

    - `x-api-key: lma_your_key` (recommended)

    - `Authorization: Bearer lma_your_key`


    API keys are workspace-scoped. Create them in **Settings -> API Keys**.


    ## Quick Start (One-Call Path)

    `POST /v1/create` with `{ "brief": "product photo of sneakers", "sync": true
    }` — returns completed output inline with CDN URL.


    ## Quick Start (Advanced)

    1. `GET /v1/apps` -- browse 30+ specialized creative apps

    2. `GET /v1/apps/{appId}` -- inspect input parameters

    3. `POST /v1/apps/{appId}/runs?webhook=<url>` -- run with your inputs

    4. Receive results via webhook, poll `GET /v1/runs/{runId}`, or stream via
    `GET /v1/runs/{runId}/stream`


    ## Rate Limits

    All `/v1/*` endpoints are currently limited to 100 requests per minute per
    IP.

    On `429`, read the `RateLimit-*` and `Retry-After` headers before retrying.


    ## How Inputs Work

    When running an app, provide inputs as a JSON object keyed by parameter
    **name** (from the app details response).


    - **text** parameters: send a string value (e.g. a prompt or description)

    - **options** parameters: send the **label** of the option (e.g.
    `"Caucasian"`), not an internal value

    - **url** parameters: send a publicly accessible URL to an image or video


    Every parameter is returned with `required: true`. Parameters with a
    `default` can safely be omitted -- the app will use the default value.


    ## Endpoint Groups

    | Group | Purpose |

    |-------|---------|

    | **Apps** | Discover and inspect available content creation apps |

    | **Runs** | Run workflows, track progress, and retrieve results |

    | **Assets** | Browse generated images, videos, and text from past
    executions |

    | **Intelligence** | Brand context, performance prediction, recommendations,
    and trends |

    | **Publishing** | Publish content to connected social channels |

    | **Content** | One-call agent operations: create, score, brief, batch |

    | **Account** | Credit balance and rate limit visibility |

    | **Templates** | Content creation templates and strategies |

    | **Webhooks** | Webhook signature verification |
servers:
  - url: https://app.uselamina.ai
    description: Production
security:
  - apiKey: []
tags:
  - name: Create
    description: Create content from briefs, run specific apps, and use templates
  - name: Discover
    description: Find and inspect available apps and their input schemas
  - name: Track
    description: Monitor execution progress, retrieve results, and browse generated assets
  - name: Intelligence
    description: >-
      Brand context, performance prediction, content recommendations, and trend
      signals
  - name: Distribute
    description: Publish content to social channels and transfer assets to CDN
  - name: Score
    description: Evaluate content quality, brand alignment, and engagement potential
  - name: Compose
    description: >-
      Turn a script into a narrated, multi-shot video — pick a format (never a
      model), preview cost, and render
  - name: Account
    description: Credit balance, rate limits, and health checks
  - name: Webhooks
    description: Webhook signature verification for secure callback handling
paths:
  /v1/compose/plan:
    post:
      tags:
        - Compose
      summary: Plan Compose Video (dry run)
      description: >
        **Preview** what `POST /v1/compose/video` will do for a script — the

        format it routes to, the estimated cost, and the per-beat storyboard —

        **without generating any media or spending a credit.** Fast (one LLM

        call). Use it to show the plan + cost and confirm before committing.


        `ready: false` with `missingInputs` / `blockers` tells you exactly what
        to

        supply before dispatching. Accepts the same steering fields as

        `/v1/compose/video` (`format`, `direction`, `sections`, `inputs`,

        `aspectRatio`).
      operationId: planComposeVideo
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComposeInput'
            example:
              script: >-
                Here's how our analytics dashboard turns raw events into
                decisions in seconds.
              aspectRatio: '16:9'
      responses:
        '200':
          description: The dry-run plan.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
              example:
                data:
                  ready: true
                  format:
                    id: motion_graphics
                    label: Motion-graphics explainer
                    available: true
                    reason: data/how-to content — clarity beats footage
                  cost:
                    tier: low
                    estimatedCredits: 35
                  estimatedDurationSec: 12
                  aspectRatio: '16:9'
                  beatCount: 3
                  beats:
                    - index: 0
                      treatment: static_card
                      effect: slide_up
                      transition: fade
                      motion: false
                      imagePrompt: Clean dashboard hero with a rising line chart
                  requiredInputs: []
                  missingInputs: []
        '400':
          description: >-
            Invalid input. `details.reason` is machine-readable (e.g.
            `SCRIPT_TOO_LONG`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComposeError'
              example:
                error: >-
                  script is too long (~160s of narration; max 90s). Shorten the
                  script.
                code: VALIDATION_ERROR
                retryable: false
                details:
                  reason: SCRIPT_TOO_LONG
                  estimatedDurationSec: 160
                  maxScriptDurationSec: 90
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    ComposeInput:
      type: object
      description: >
        Shared input for `POST /v1/compose/plan` and `POST /v1/compose/video`.
        The user picks a **format** (never a model) and steers the render via
        the **script** — `direction` + `sections` — not by naming models.
      required:
        - script
      properties:
        script:
          type: string
          maxLength: 4000
          description: >-
            The narration to speak (a hook + one insight + a CTA). Its spoken
            length must be ≤ the `maxScriptDurationSec` capability (~90s).
        title:
          type: string
          description: Video title.
        generationBrief:
          type: string
          description: One-paragraph visual brief for the shots.
        format:
          type: string
          description: >-
            A format id from `GET /v1/compose/formats`. Omit to auto-route the
            script to the best available format.
        direction:
          type: string
          description: >-
            Free-text creative direction ("open on the product, fast cuts, end
            on the logo") — steers the render without naming models.
        sections:
          type: array
          description: Structured per-span storyboard hints, for a prescriptive caller.
          items:
            type: object
            required:
              - hint
            properties:
              text:
                type: string
                description: The span of narration this hint applies to.
              hint:
                type: string
                description: What to show / how to treat this span.
              mustShow:
                type: boolean
                description: Hard requirement for this beat.
        inputs:
          type: object
          description: >-
            A format's required inputs, keyed by input key (e.g. a
            `presenterImage` key mapping to an https URL). See each format's
            `inputs` in `GET /v1/compose/formats`.
        aspectRatio:
          type: string
          enum:
            - '16:9'
            - '9:16'
            - '1:1'
            - '4:5'
            - '4:3'
          default: '16:9'
        voiceId:
          type: string
          description: >-
            ElevenLabs voice id for the narration. Omit for the default voice.
            (compose/video only.)
        clipSeconds:
          type: integer
          description: Target per-clip length within the capability window.
        idempotencyKey:
          type: string
          description: >-
            Dedupe retries — a repeated key returns the same run (no double
            charge). (compose/video only.)
    ComposeError:
      type: object
      description: >
        Structured error from the compose endpoints. `details.reason` is a
        stable, machine-readable sub-code an agent can branch on to
        self-correct.
      required:
        - error
      properties:
        error:
          type: string
          description: Human-readable error message.
        code:
          type: string
          description: The /v1 error-taxonomy code (drives HTTP status + retryable).
          example: VALIDATION_ERROR
        retryable:
          type: boolean
          description: Whether retrying the same request could succeed.
        details:
          type: object
          description: >-
            Machine-readable context. Always carries `reason`; other keys depend
            on the reason.
          required:
            - reason
          properties:
            reason:
              type: string
              enum:
                - SCRIPT_REQUIRED
                - SCRIPT_TOO_LONG
                - FORMAT_UNAVAILABLE
                - MISSING_REQUIRED_INPUT
                - NO_ELIGIBLE_FORMAT
              description: Stable sub-code for the failure.
            missingInputs:
              type: array
              items:
                type: string
              description: Present for MISSING_REQUIRED_INPUT — the input keys to supply.
            maxScriptDurationSec:
              type: integer
              description: Present for SCRIPT_TOO_LONG.
            estimatedDurationSec:
              type: integer
              description: Present for SCRIPT_TOO_LONG.
          additionalProperties: true
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
          example:
            error: Invalid API key
    TooManyRequests:
      description: >-
        Rate limit exceeded. All `/v1/*` endpoints are currently limited to 100
        requests per minute per IP.
      headers:
        RateLimit-Policy:
          description: Active rate limit policy.
          schema:
            type: string
            example: 100;w=60
        RateLimit-Limit:
          description: Max requests allowed in the current window.
          schema:
            type: integer
            example: 100
        RateLimit-Remaining:
          description: Requests remaining in the current window.
          schema:
            type: integer
            example: 0
        RateLimit-Reset:
          description: Seconds until the current window resets.
          schema:
            type: integer
            example: 60
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
            example: 60
      content:
        text/plain:
          schema:
            type: string
          example: Too many requests from this IP, please try again in a minute
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: 'Workspace API key. Prefix: `lma_`. Example: `lma_abc123...`'

````