Skip to Content
Quickstart

Quickstart

From zero to your first scene in four steps — using the live pipeline API, POST /v1/scenes.

1. Get an API key

Create a key in jetwild.com → Settings → Developers . Keys are prefixed by mode — jw_test_ or jw_live_. Give it the scenes:write scope so it can create scenes.

2. Create a scene

POST /v1/scenes registers a scene and returns a presigned URL to upload the master to. This is live today.

curl https://api.jetwild.com/v1/scenes \
-H "Authorization: Bearer $JETWILD_KEY" \
-H "Content-Type: application/json" \
-d '{
"filename": "midnight-heat.mp4",
"tier": "TIER_2"
}'

3. Upload the master

The response includes an uploadUrl and uploadMethod (usually PUT). Upload your file straight to it — no Jetwild auth on the upload itself.

curl -X PUT "$UPLOAD_URL" \
--upload-file ./midnight-heat.mp4

4. Read the response

Creating the scene returns the scene record plus the upload target:

{
"scene": { "id": "sc_9002", "tier": "TIER_2", "status": "QUEUED" },
"uploadUrl": "https://r2.jetwild.com/upload/...",
"uploadMethod": "PUT",
"driver": "r2"
}

Once uploaded, the scene moves through the pipeline (QUEUED → PROCESSING → READY). Poll GET /v1/scenes/{id} for status and the generated metadata.

Webhooks are coming soon

Long jobs are best handled with an event instead of polling. Webhook registration and signing are live; scene event emission is coming soon — until then, poll the scene.

Last updated on