Skip to main content
POST
/
push
curl --request POST \ --url http://localhost:8080/push \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "input_key": "screenplays/input/script.fdx", "output_key": "screenplays/output/script-v1", "document_id": "12345", "tasks": [ "convert-fdx-to-screenjson", "validate-screenjson" ] } '
{
  "job_id": "<string>",
  "status": "queued"
}

Documentation Index

Fetch the complete documentation index at: https://docs.screenjson.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
input_key
string
required
Example:

"screenplays/input/script.fdx"

​
output_key
string
required
Example:

"screenplays/output/script-v1"

​
document_id
string
required
Example:

"12345"

​
tasks
string[]
required
Example:
[
  "convert-fdx-to-screenjson",
  "validate-screenjson"
]
​
vars
object
Example:
{ "encrypt_key": "mysecretkey123" }
​
webhook
string
​
tenant_id
string

Response

Job enqueued

​
job_id
string
​
status
string
Example:

"queued"