Base Models
Inferences

Run an inference with a base model

Changed on

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

Request

  • Base URL: https://api.app.layer.ai/api
  • URL: https://api.app.layer.ai/api/v2/workspaces/{workspace_id}/base-models/{slug}/inferences
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.app.layer.ai/authorize, token URL https://auth.app.layer.ai/oauth/token)
    • OAuth 2 (client credentials, token URL https://api.app.layer.ai/api/oauth/token, scopes: generation:write)

Path parameters

workspace_idstring uuid required

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.

Query parameters

session_namestring nullable

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

Headers

Idempotency-Keystring

Opaque key making a retry of this request return the first result. A 2xx response is replayed for 24 hours with Idempotent-Replayed: true. A 4xx releases the key. A 5xx, or a request still running, holds the key for 120 seconds, during which a retry gets 409; after that a retry executes again. The key covers the method, path, query, and byte-identical body it was first used with; reusing it for a different request is rejected with 422. Protection is best effort: if the key store is unavailable, or a record is lost early, a retry can execute again even after an earlier 409. See the Idempotency section of the API description.

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

  • 326f3bcdabccRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 2d86d473cda6Revision changes
    • info

      the endpoint scheme security serviceAccount was added to the API

    • info

      the security scope generation:write was removed from the endpoint's security scheme oauth2