Skip to main content
A short tour of the building blocks exposed by the public REST API.

Models and nodes

A model is an available AI capability. Its nodeType identifies the model family, while subModelId selects a specific variant when the family offers more than one. Use the catalog and schema endpoints before rendering an input form or submitting a run:

Standalone model runs

A run is one asynchronous model execution. Start it with POST /v1/nodes/{nodeType}/run, save the returned runId, and poll GET /v1/nodes/runs/{runId}.

States

RUNNING moves to a terminal state such as COMPLETED, FAILED, or CANCELED.

Result

Completed runs return model output plus status, error, and credit-usage details.
Treat 202 Accepted as confirmation that the job was queued, not as final output. Poll with a bounded timeout and handle every terminal state explicitly.

Credits

Each run debits credits from the authenticated user or active organization. Costs depend on the model and submitted parameters. Estimate before starting expensive jobs and show the result to the user before submission.

Webhooks

Execution surfaces that support asynchronous callbacks sign webhook deliveries with HMAC-SHA256 and retry failures with exponential backoff. Validate signatures and make receivers idempotent. See Webhooks for the complete contract.

How it fits together

1

Discover a model

List or search the catalog and choose a nodeType and, when applicable, a subModelId.
2

Inspect schema and pricing

Validate required fields and show an estimate before accepting expensive input.
3

Start and poll

Start a standalone run, persist its runId, and poll until it reaches a terminal state or your bounded timeout expires.

Quickstart

Walk through the REST API end-to-end with code samples.

Choose an endpoint

Map an integration task to the supported REST route.