Inferences

Get inference run

Changed on

Get the status and results of an inference run.

get/v1/workspaces/{workspace_id}/inferences/{inference_id}

Request

  • Base URL: https://api.app.layer.ai/api
  • URL: https://api.app.layer.ai/api/v1/workspaces/{workspace_id}/inferences/{inference_id}
  • 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:read)

Path parameters

workspace_idstring uuid required

Id of the workspace that owns the resource.

inference_idstring uuid required

Id of the generation.

Response

Successful Response

inference_idstring uuid required

Unique identifier for this forge run.

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

Suggested polling interval in seconds. Present while IN_PROGRESS.

completed_atstring date-time nullable

Completion timestamp. Present only on COMPLETE.

actual_price_creative_unitsnumber nullable

Actual Creative Units charged. Present only on COMPLETE.

errorstring nullable

Error message. Present only on FAILED.

error_codestring nullable

Machine-readable error code. Present only on FAILED. Balance-related values: INSUFFICIENT_BALANCE (the workspace ran out of Creative Units — top up and resubmit), BALANCE_UNAVAILABLE (the balance could not be verified, retry later) and USAGE_LIMIT_EXCEEDED (the member is past their usage limit: ask a workspace admin for more, or wait for it to reset).

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

  • fd6ada247c87Revision changes
    • info

      added the optional property ///// to the response with the status