Sign in
Models

Run inference

Changed on

Run inference on a specific model instance

post/models/i/{instance_id}/infer

Request

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

Path parameters

instance_idstring uuid required

ID of the model instance to run inference on

Request body

dataobject required

Model-specific data to run inference on

timestampstring date-time

Timestamp of the inference request, used to mark the event in the episode

episode_namestring

Name of the episode to run inference on

Example request

{
  "timestamp": "2024-03-20T12:00:00Z",
  "episode_name": "default"
}

Response

Successfully ran inference on the model

event_idinteger required

Unique identifier for the inference event

resultsobject required

Model-specific results of the inference

Example response

{
  "errors": [
    {
      "error": "Unauthorized",
      "message": "The request requires authentication, generate a token using the /generate-token endpoint"
    }
  ]
}

Changes