Models

Run a model or API capability

Executes the selected catalog capability. Capability-specific fields must match the live schema returned by the model detail endpoint or Store. Asynchronous capabilities can be polled with GET /v1/run/{id}.

post/v1/run

Request

  • Base URL: https://api.sandbase.ai
  • URL: https://api.sandbase.ai/v1/run
  • Auth: HTTP bearer

Request body

modelstring required

Current model or API capability identifier from the SandBase catalog.

mode'auto' | 'sync' | 'async' | 'stream'

Execution mode when supported by the selected capability. Auto uses the capability's configured default.

streamboolean

Requests streaming output. Equivalent to mode stream and valid only for a capability that supports streaming.

webhook_urlstring uri

Optional public HTTPS callback URL for asynchronous image, video, or audio tasks. It is validated only for those tasks and ignored for other execution types.

Response

Capability completed synchronously, or a streaming response started

idstring required

Opaque execution identifier. Use exactly as returned; no prefix is guaranteed.

modelstring required
status'pending' | 'running' | 'completed' | 'failed' | 'timeout' required

A stored completed task can temporarily be reported as running while output transfer is still pending.

usageobject

Model-specific public usage details when available; omitted for models that do not report them.

Changes

No recorded changes to this operation across all 1 revision of this API.