Antimatter

GET/api/studio/projects/{id}Signed in session

Another account's project is the same 404 as one that does not exist. The signed in account.

Parameters

Path and query parameters
Field	Type	What it is
id (path)required	string	The project's id, stp_ followed by hex.

Answer 200

The project.

Fields of the 200 answer
Field	Type	What it is
id	string
object	string	One of "studio.project".
doc_id	string	The document's own id (Project.id), unique per owner.
name	string
aspect	string	One of "16:9", "9:16", "1:1".
version	integer	Moves on by one with every write; a write names the version it read.
bytes	integer
org_id	integer or null
created_at	integer
updated_at	integer
project	object	The editor's own Project document (lib/studio/timeline.ts), held to the same schema: every clip names an asset the document carries, or none for a title.
project.idrequired	string	At most 100 characters.
project.namerequired	string	At most 500 characters.
project.aspectrequired	string	One of "16:9", "9:16", "1:1".
project.budgetMicrosrequired	number or null
project.assetsrequired	array of object
project.assets[].idrequired	string	At most 100 characters.
project.assets[].kindrequired	string	One of "video", "audio", "image".
project.assets[].namerequired	string	At most 500 characters.
project.assets[].mimerequired	string	At most 200 characters.
project.assets[].durationrequired	number	At least 0.
project.assets[].width	number
project.assets[].height	number
project.assets[].hasAudio	boolean
project.assets[].sourcerequired	string	One of "import", "generated", "speech", "image", "frame".
project.assets[].model	string	At most 200 characters.
project.assets[].prompt	string	At most 20000 characters.
project.assets[].micros	number	At least 0.
project.assets[].job	object
project.assets[].job.idrequired	string	At most 120 characters.
project.assets[].job.statusrequired	string	One of "queued", "in_progress", "completed", "failed", "cancelled".
project.assets[].job.progressrequired	number or null
project.assets[].job.error	string	At most 2000 characters.
project.assets[].job.expiresAt	number or null
project.assets[].renderMs	number	At least 0.
project.assets[].shootout	string	At most 100 characters.
project.assets[].seed	integer	From 0 to 2147483647.
project.assets[].variation	string	At most 100 characters.
project.assets[].asked	object
project.assets[].asked.camerarequired	string or null
project.assets[].asked.path	object
project.assets[].asked.refs	array of string
project.assets[].asked.end	string	At most 100 characters.
project.assets[].asked.negative	string	At most 2000 characters.
project.assets[].category	string	One of "Characters", "Locations", "Products".
project.assets[].character	object
project.assets[].character.idrequired	string
project.assets[].character.namerequired	string	At most 80 characters.
project.assets[].stored	string
project.assets[].from	object
project.assets[].from.assetIdrequired	string	At most 100 characters.
project.assets[].from.taskrequired	string	One of "speech", "lipsync", "talking", "edit", "extend", "upscale", "motion", "enlarge", "inpaint".
project.assets[].reverseOf	object
project.assets[].reverseOf.assetIdrequired	string	At most 100 characters.
project.assets[].reverseOf.fromrequired	number	At least 0.
project.assets[].reverseOf.torequired	number	At least 0.
project.assets[].forShot	string	At most 100 characters.
project.assets[].tags	array of string
project.assets[].beats	object
project.assets[].beats.bpmrequired	number	From 0 to 1000.
project.assets[].beats.atrequired	array of number
project.assets[].motion	object
project.assets[].motion.fpsrequired	number	At most 120.
project.assets[].motion.xrequired	array of number
project.assets[].motion.yrequired	array of number
project.assets[].draft	boolean
project.assets[].rating	1 or -1
project.assets[].lastFrameOf	string	At most 100 characters.
project.assets[].createdAtrequired	number
project.clipsrequired	array of object
project.clips[].idrequired	string	At most 100 characters.
project.clips[].trackrequired	string	One of "title", "overlay", "video", "caption", "voice", "music", "effects".
project.clips[].assetIdrequired	string or null
project.clips[].startrequired	number	At least 0.
project.clips[].inrequired	number	At least 0.
project.clips[].durationrequired	number
project.clips[].speedrequired	number
project.clips[].volumerequired	number	At least 0.
project.clips[].look	string	At most 100 characters.
project.clips[].pan	object
project.clips[].pan.xrequired	number
project.clips[].pan.yrequired	number
project.clips[].transition	object
project.clips[].transition.kindrequired	string	One of "cut", "crossfade", "dip-black", "dip-white", "whip".
project.clips[].transition.durationrequired	number	At least 0.
project.clips[].text	string	At most 2000 characters.
project.clips[].style	string	One of "cinema", "lower-third", "bold", "minimal", "clean", "boxed", "karaoke", "large".
project.clips[].enter	string	One of "none", "fade", "type", "slide".
project.clips[].exit	string	One of "none", "fade", "type", "slide".
project.clips[].place	object
project.clips[].place.xrequired	number	From -1 to 1.
project.clips[].place.yrequired	number	From -1 to 1.
project.clips[].place.scalerequired	number	From 0.1 to 4.
project.clips[].opacity	number	From 0 to 1.
project.clips[].placeKeys	array of object
project.clips[].placeKeys[].srequired	number
project.clips[].placeKeys[].xrequired	number	From -1 to 1.
project.clips[].placeKeys[].yrequired	number	From -1 to 1.
project.clips[].placeKeys[].scalerequired	number	From 0.1 to 4.
project.clips[].placeKeys[].opacity	number	From 0 to 1.
project.clips[].volumeKeys	array of object
project.clips[].volumeKeys[].srequired	number
project.clips[].volumeKeys[].vrequired	number	From 0 to 1.
project.clips[].adjust	object
project.clips[].adjust.exposure	number	From -2 to 2.
project.clips[].adjust.contrast	number	From 0.5 to 1.5.
project.clips[].adjust.saturation	number	From 0 to 2.
project.clips[].ramp	array of object
project.clips[].ramp[].urequired	number	From 0 to 1.
project.clips[].ramp[].vrequired	number	From 0.25 to 4.
project.clips[].panKeys	array of object
project.clips[].panKeys[].srequired	number
project.clips[].panKeys[].xrequired	number	From -1 to 1.
project.clips[].panKeys[].yrequired	number	From -1 to 1.
project.clips[].chroma	object
project.clips[].chroma.colorrequired	string
project.clips[].chroma.tolerancerequired	number	From 0 to 1.
project.clips[].chroma.softnessrequired	number	From 0 to 1.
project.clips[].chroma.spillrequired	number	From 0 to 1.
project.clips[].stabilize	number	From 0 to 1.

Errors

401OpenAI shaped error.
404OpenAI shaped error.
429OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.