Skip to main content
POST
Screenplay outline

Authorizations

Authorization
string
header
required

A workspace API key.

Body

application/json
title
string
required

Working title.

Required string length: 1 - 200
logline
string
required

The premise in a sentence or two.

Required string length: 1 - 1000
genre
string
required

Genre. The engine publishes the accepted set.

Required string length: 1 - 60
format
string

Defaults to feature.

Required string length: 1 - 60
targetAudience
string
Maximum string length: 200
themes
string[]
Maximum array length: 10
Maximum string length: 100
setting
string
Maximum string length: 500
projectId
string

The project to file this work under. Optional: omit it and one is created for you, and its id comes back on the response — read it from there rather than assuming. Pass the same id across calls when you want the script, the render and the thumbnail to land in one container. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200

Response

Success.

success
boolean
required
projectId
string
required

The project this work was filed under. Read it from here — a call that sent no projectId had one created, and this is where its id comes back.

Example:

"prj_9x2a4c"

credits
number
required

What this call actually cost, which is not always what was quoted.

Example:

300

outline
any
required

The three-act outline.

creditBalance
number

Your balance after the charge. Absent when billing is disabled for the workspace.

Example:

3900

{key}
any