API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Techniques

Technique catalog endpoints.

Get a technique

GET/techniques/{techniqueId}

List techniques

GET/techniques

ModelsExpand Collapse

TechniqueRetrieveResponse object { inputs, name, outputs, 3 more }

inputs: array of object { id, name, type, 3 more }

id: string

Technique input or output identifier

name: string

Technique input or output display name

type: "imageUrl" or "videoUrl" or "audioUrl" or 2 more

Technique input or output media type

One of the following:

"imageUrl"

"videoUrl"

"audioUrl"

"text"

"documentUrl"

description: optional string

Technique input or output description

specified_aspect_ratio: optional string

Required aspect ratio

specified_duration: optional number

Required duration in seconds

name: string

Technique name

outputs: array of object { id, name, type, 3 more }

id: string

Technique input or output identifier

name: string

Technique input or output display name

type: "imageUrl" or "videoUrl" or "audioUrl" or 2 more

Technique input or output media type

One of the following:

"imageUrl"

"videoUrl"

"audioUrl"

"text"

"documentUrl"

description: optional string

Technique input or output description

specified_aspect_ratio: optional string

Required aspect ratio

specified_duration: optional number

Required duration in seconds

run_cost: number

technique_id: string

Technique identifier

description: optional string

Technique description

TechniqueListResponse object { inputs, name, outputs, 3 more }

inputs: array of object { id, name, type, 3 more }

id: string

Technique input or output identifier

name: string

Technique input or output display name

type: "imageUrl" or "videoUrl" or "audioUrl" or 2 more

Technique input or output media type

One of the following:

"imageUrl"

"videoUrl"

"audioUrl"

"text"

"documentUrl"

description: optional string

Technique input or output description

specified_aspect_ratio: optional string

Required aspect ratio

specified_duration: optional number

Required duration in seconds

name: string

Technique name

outputs: array of object { id, name, type, 3 more }

id: string

Technique input or output identifier

name: string

Technique input or output display name

type: "imageUrl" or "videoUrl" or "audioUrl" or 2 more

Technique input or output media type

One of the following:

"imageUrl"

"videoUrl"

"audioUrl"

"text"

"documentUrl"

description: optional string

Technique input or output description

specified_aspect_ratio: optional string

Required aspect ratio

specified_duration: optional number

Required duration in seconds

run_cost: number

technique_id: string

Technique identifier

description: optional string

Technique description

TechniquesRuns

Nested technique run endpoints.

Start a technique run

POST/techniques/{techniqueId}/runs

Get a technique run

GET/techniques/{techniqueId}/runs/{runId}

ModelsExpand Collapse

RunCreateResponse object { created_at, progress, run_id, 8 more }

created_at: number

progress: number

run_id: string

Run identifier

status: "pending" or "running" or "completed" or "failed"

One of the following:

"pending"

"running"

"completed"

"failed"

charged_cost: optional number

completed_at: optional number

error_code: optional string

Machine-readable run error code

error_message: optional string

Human-readable run error message

outputs: optional array of object { output_id, type, url }

output_id: string

Run output identifier

type: "imageUrl" or "videoUrl" or "audioUrl" or 2 more

Run output media type

One of the following:

"imageUrl"

"videoUrl"

"audioUrl"

"text"

"documentUrl"

url: string

Run output URL

formaturi

poll_url: optional string

formaturi

started_at: optional number

RunRetrieveResponse object { created_at, progress, run_id, 8 more }

created_at: number

progress: number

run_id: string

Run identifier

status: "pending" or "running" or "completed" or "failed"

One of the following:

"pending"

"running"

"completed"

"failed"

charged_cost: optional number

completed_at: optional number

error_code: optional string

Machine-readable run error code

error_message: optional string

Human-readable run error message

outputs: optional array of object { output_id, type, url }

output_id: string

Run output identifier

type: "imageUrl" or "videoUrl" or "audioUrl" or 2 more

Run output media type

One of the following:

"imageUrl"

"videoUrl"

"audioUrl"

"text"

"documentUrl"

url: string

Run output URL

formaturi

poll_url: optional string

formaturi

started_at: optional number