Skip to main content
POST
3D from text

Authorizations

Authorization
string
header
required

A workspace API key.

Body

application/json
prompt
string
required
Required string length: 1 - 2000
preset
enum<string>
Available options:
turntable,
orbit,
dolly_in,
float_bob,
beauty
durationSeconds
number
Required range: 1 <= x <= 30
fps
integer
Required range: 8 <= x <= 60
width
integer
Required range: 128 <= x <= 3840
height
integer
Required range: 128 <= x <= 2160
background
enum<string>
Available options:
studio,
dark,
white,
gradient
callbackUrl
string<uri>
projectId
string

The project to file this work under. Optional: omit it and one is created for you, and its id comes back on the response — read it from there rather than assuming. Pass the same id across calls when you want the script, the render and the thumbnail to land in one container. A project this workspace does not own answers not_found; the work is never silently filed somewhere else.

Required string length: 1 - 200

Response

Success.

success
boolean
required
projectId
string
required

The project this work was filed under. Read it from here — a call that sent no projectId had one created, and this is where its id comes back.

Example:

"prj_9x2a4c"

credits
number
required

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

Example:

300

jobId
string
required

Poll GET /v1/jobs/{jobId}. When that job reports status: "done", the finished file is job.artifacts.video — an origin URL you fetch directly, not through this API.

Example:

"job_4k1b7d"

status
string
required

Acceptance, not completion. The work has not started when this returns.

Allowed value: "queued"
creditBalance
number

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

Example:

3900

{key}
any