---
title: "Plan"
method: POST
path: "/v1/plan"
tags: ["generate"]
---

# Plan

`POST /v1/plan`

## Request

- Base URL: `https://api.mocapless.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mocapless.com/v1/plan`
- Auth: none declared

Turn a prompt into an editable plan, and price it. Costs nothing.

Separating planning from generation is what lets the app show the user what
it is about to make - and what it will cost - before any credit is spent.

## Headers

- `authorization` string, nullable
- `X-API-Key` string, nullable

## Request body

- PlanRequest
  - `prompt` string, required
  - `fps` integer
  - `useLlm` boolean
  - `assetId` string, nullable
  - `engine` string

## Response `200`

Successful Response

- PlanResponse
  - `script` ScriptModel, required
    - `segments` SegmentModel[], required
      - `primitive` string, required
      - `seconds` number
      - `speed` number
      - `amplitude` number
      - `style` string
      - `repeats` integer
      - `mirror` boolean
      - `turn` number
      - `params` object
    - `fps` integer
    - `loop` boolean
    - `source` string
    - `confidence` number
    - `notes` string[]
    - `prompt` string
    - `duration` number
    - `beats` object[]
    - `family` string
  - `cost` integer, required
  - `balance` integer, required
  - `affordable` boolean, required
  - `engine` string
  - `neuralAvailable` boolean
  - `notes` string[]

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/mocapless/apis/mocapless-api.md) · [All operations](https://skmtc.dev/mocapless/apis/mocapless-api/llms.txt) · [OpenAPI document](https://skmtc.dev/mocapless/apis/mocapless-api/revisions/37b479a6e615?raw)