Skip to main content
POST
Screenplay outline

Authorizations

Authorization
string
header
required

A workspace API key.

Headers

idempotency-key
string

Stable retry key for this logical paid call. Reuse it after a timeout to receive the original result without duplicate work or spend.

Required string length: 1 - 255
x-sigmora-quote-only
string

Send 1 to get the price, balance and budget verdict without running anything.

Allowed value: "1"
x-sigmora-max-credits
string

The approved price; a call that would cost more is refused and nothing is charged.

Pattern: ^\d+$

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
enum<string>
required

Screenplay genre. Every accepted value is listed below.

Available options:
drama,
thriller,
comedy,
sci_fi,
horror,
documentary,
action,
romance
projectId
string
required

The existing project to file this work under. Create it with POST /v1/projects, then reuse its id across related calls. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200
format
enum<string>

Production format. Defaults to feature.

Available options:
feature,
short,
series_episode,
web_series
targetAudience
string

Intended viewers, used to set tone and content boundaries.

Maximum string length: 200
themes
string[]

Up to ten ideas the story should explore, e.g. grief, ambition, belonging.

Maximum array length: 10
Maximum string length: 100
setting
string

Where and when the story takes place.

Maximum string length: 500

Response

Success.

success
boolean
required
credits
number
required

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

Example:

300

outline
object
required

The three-act outline. The text is under result.

projectId
string

The existing project this work was filed under. It matches the projectId supplied by the caller after workspace ownership was verified.

Example:

"prj_9x2a4c"

creditBalance
number

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

Example:

3900

{key}
any