Skip to main content
POST
/
convert
Convert a screenplay file to ScreenJSON
curl --request POST \
  --url http://localhost:8080/convert \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form format=fdx \
  --form lang=en
{}

Query Parameters

​
format
enum<string>

Input format. Required when sending a raw body; auto-detected from filename when using multipart.

Available options:
fdx,
fadein,
fountain,
pdf,
json,
yaml
​
lang
string
default:en

Primary language tag (BCP 47). Defaults to en.

Body

​
file
file
required

Screenplay source file.

​
format
enum<string>

Optional — auto-detected from filename.

Available options:
fdx,
fadein,
fountain,
pdf,
json,
yaml
​
lang
string
default:en

Primary BCP 47 language tag.

Response

ScreenJSON document

A ScreenJSON document. See the Specification tab.