Create an outline

Creates an outline, either from a topic (prompt) or from an existing video (videoId). Send exactly one of the two — never both. An outline is a stored, editable resource: generate chapters, review them, expand them into a script, then build a video. Counts against the account's video creation limit.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

An outline is a stored, editable plan for a video. Creating one is the first step of the
prompt → video flow, and it replaces the retired
POST /gpt/generate-outline.

Send either prompt or videoId, never both:

  • prompt — a topic, 8–400 characters after trimming. Use this to build something new.
  • videoId — an existing video. Use this to plan changes against a video you already have.

The response is an empty outline with no chapters yet. Generate them with
Generate chapters.

🚧

This counts against your video creation limit

Even though no video exists yet, outline creation consumes the same 8-hour rolling quota as
POST /videos — 50 per 8 hours on free accounts, 1000 on paid, 6000 on Enterprise. A 429
here means the quota, not a rate limit.

quizSettings is optional and only shapes later quiz generation; you can also set it any time
with Update an outline.

Body Params
string
required
length between 8 and 400

Topic to generate from. Trimmed before validation; must be 8-400 characters.

string | null

Folder for the video built later. Defaults to the root.

quizSettings
object

How future quiz generation should behave. Distinct from a draft's actual quiz object.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

text/html; read the body as text and use it directly as outlineId in the calls that follow. Every other endpoint in this flow answers with JSON.

prompt/videoId sent, or prompt is outside 8-400 characters.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/html
application/json