Skip to main content
POST
Render one frame of a shader

Authorizations

Authorization
string
header
required

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

Path Parameters

shader_id
string
required

Body

application/json

POST /v1/shaders/{id}/probe: one frame of the shader on a full-canvas shape.

width
integer
default:1280

Canvas width in px.

Required range: 16 <= x <= 8192
height
integer
default:720

Canvas height in px.

Required range: 16 <= x <= 8192
time
number
default:0

The timeline second to render.

Required range: x >= 0
params
Params · object

Param values for the frame, as an effect's shader.params takes them.

Response

Successful Response

A render job or AI task.

id
string
required

Unique job ID. Prefix indicates type: render_ or task_.

Example:

"render_01J8QR2K5VKDGN2T4FBM3CZYX7"

kind
enum<string>
required

Whether this is a render or a task.

Available options:
render,
task
Example:

"render"

workspace_id
string
required

ID of the workspace that owns this job.

Example:

"ws_01J8QR2K5VKDGN2T4FBM3CZYX8"

status
enum<string>
required

Current lifecycle state: queued → processing → completed / failed / cancelled.

Available options:
ingesting,
queued,
processing,
completed,
failed,
cancelled
Example:

"queued"

created_at
string<date-time>
required

ISO-8601 UTC timestamp when the job was created.

updated_at
string<date-time>
required

ISO-8601 UTC timestamp of the last status change.

is_preview
boolean
default:false

True for a cheap preview render. Previews are not billed and are excluded from the renders list.

Example:

false

editor_url
string | null

Open the project this job was submitted from in the authenticated console. Absent for a job with no project.

task_type
enum<string> | null

For task jobs only — the specific AI operation.

Available options:
transcribe
Example:

"transcribe"

progress_percent
integer
default:0

0–100 progress indicator updated by the render engine.

Required range: 0 <= x <= 100
Example:

0

progress_stage
enum<string> | null

Current processing phase within a job.

Available options:
downloading,
compositing,
encoding,
uploading
Example:

"compositing"

output
JobOutput · object | null

Populated once status == completed. Contains the signed artifact URL.

result
Result · object | null

Structured JSON result for tasks that return data rather than a file — transcribe returns the transcript here (text, words, utterances, and any requested analysis). Populated once status == completed; null for renders and for any job whose only artifact is the file at output.url.

Example:
error
JobError · object | null

Populated when status == failed. Contains a structured error code.

metadata
Metadata · object

Caller-supplied key-value pairs echoed back on every webhook and response.

Example:
completed_at
string<date-time> | null

ISO-8601 UTC timestamp when the job reached a terminal state.