Sign in
Base Models
Inferences

Run an inference with a base model

Start a generation with the given base model. The request body is the model's inference form (see GET /base-models/{slug}/inference-schema for its shape). Returns immediately with an inference id; poll GET /workspaces/{workspace_id}/inferences/{inference_id} for results.

post/v2/workspaces/{workspace_id}/base-models/{slug}/inferences

Path parameters

workspace_idstring uuid required

Id of the workspace that owns the resource.

Id of the workspace that owns the resource.

slugstring required

The base model, named by the id the list endpoint returns, or by its slug, display name, or alias.

The base model, named by the id the list endpoint returns, or by its slug, display name, or alias.

Query parameters

session_namestring nullable

Organize this run under a named session. A new session is created if none matches.

Organize this run under a named session. A new session is created if none matches.

Headers

Idempotency-Keystring

Opaque key making this request safe to retry. The first request with a given key executes; a later request with the same key returns that first response with Idempotent-Replayed: true instead of executing again. The key covers the method, path, query, and body it was first used with; reusing it for a different request is rejected with 422. Replayable for 24 hours.

Request body

object required

Response

Successful Response

inference_idstring uuid required

Unique identifier for this forge run.

status'in_progress' | 'complete' | 'failed' | 'cancelled' | 'deleted' required
estimated_price_creative_unitsnumber nullable

Estimated price in Creative Units.

poll_interval_secondsinteger required

Suggested polling interval in seconds.

created_atstring date-time required

Timestamp of when the run was created.

session_idstring uuid nullable

Session ID the run was added to, if a session was specified.

Changes

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