API Reference

Techniques

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Runs

Nested technique run endpoints.

Start a technique run

client.techniques.runs.create(stringtechniqueID, RunCreateParams { inputs, mode, callback_url, idempotency_key } body, RequestOptionsoptions?): RunCreateResponse { created_at, progress, run_id, 8 more }

POST/techniques/{techniqueId}/runs

List technique run history

client.techniques.runs.list(RunListParams { cursor, limit, project_id, 3 more } query?, RequestOptionsoptions?): TechniqueRunsCursorPage<RunListResponse { created_at, progress, project_id, 12 more } >

GET/technique-runs

Get a technique run

client.techniques.runs.retrieve(stringrunID, RunRetrieveParams { techniqueId } params, RequestOptionsoptions?): RunRetrieveResponse { created_at, progress, run_id, 8 more }

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

ModelsExpand Collapse

RunCreateResponse { created_at, progress, run_id, 8 more }

created_at: number

progress: number

run_id: string

Run identifier

status: "pending" | "running" | "completed" | "failed"

One of the following:

"pending"

"running"

"completed"

"failed"

charged_cost?: number

Cost charged in USD

minimum0

completed_at?: number

error_code?: string

Machine-readable run error code

error_message?: string

Human-readable run error message

outputs?: Array<Output>

output_id: string

Run output identifier

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

Run output media type

One of the following:

"imageUrl"

"videoUrl"

"audioUrl"

"text"

"documentUrl"

url: string

Run output URL or text content

minLength1

poll_url?: string

URL to poll pending/running runs or fetch completed/failed run details.

formaturi

started_at?: number

RunListResponse { created_at, progress, project_id, 12 more }

created_at: number

progress: number

project_id: string

Project identifier

run_id: string

Run identifier

status: "pending" | "running" | "completed" | "failed"

One of the following:

"pending"

"running"

"completed"

"failed"

technique: Technique { name, technique_id }

name: string

Technique name

technique_id: string

Technique identifier

technique_run_id: string

Run identifier

workspace_id: string

Workspace identifier

charged_cost?: number

Cost charged in USD

minimum0

completed_at?: number

error_code?: string

Machine-readable run error code

error_message?: string

Human-readable run error message

outputs?: Array<Output>

output_id: string

Run output identifier

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

Run output media type

One of the following:

"imageUrl"

"videoUrl"

"audioUrl"

"text"

"documentUrl"

url: string

Run output URL or text content

minLength1

poll_url?: string

URL to poll pending/running runs or fetch completed/failed run details.

formaturi

started_at?: number

RunRetrieveResponse { created_at, progress, run_id, 8 more }

created_at: number

progress: number

run_id: string

Run identifier

status: "pending" | "running" | "completed" | "failed"

One of the following:

"pending"

"running"

"completed"

"failed"

charged_cost?: number

Cost charged in USD

minimum0

completed_at?: number

error_code?: string

Machine-readable run error code

error_message?: string

Human-readable run error message

outputs?: Array<Output>

output_id: string

Run output identifier

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

Run output media type

One of the following:

"imageUrl"

"videoUrl"

"audioUrl"

"text"

"documentUrl"

url: string

Run output URL or text content

minLength1

poll_url?: string

URL to poll pending/running runs or fetch completed/failed run details.

formaturi

started_at?: number