Models

Get the state of a model instance

Changed on

Retrieve the state of a specific model instance

get/models/i/{instance_id}/state

Request

  • Base URL: http://localhost:8000/v1
  • URL: http://localhost:8000/v1/models/i/{instance_id}/state
  • Auth: HTTP bearer

Path parameters

instance_idstring uuid required

ID of the model instance to retrieve state for

Response

Successfully retrieved model state. Each model has its own state, which is a dictionary of arbitrary key-value pairs. Check model-specific documentation for more details.

stateobject required

An object containing the current state of the model instance. May include arbitrary fields specific to the model. See the model documentation for more details.

Changes