Models

Create a new episode for a model instance

Changed on

Create a new episode for a specific model instance. Note that the default episode is created automatically when the model instance is created. When a new episode is created, it becomes the current episode for the model instance.

post/models/i/{instance_id}/create-episode

Request

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

Path parameters

instance_idstring uuid required

ID of the model instance to create episode for

Request body

namestring required

Name of the episode to create

Response

Successfully created episode

instance_idstring uuid required

ID of the model instance this episode belongs to

episode_namestring required

Name of the episode

created_atstring date-time required

Timestamp of when the episode was created

eventsobject[] required

List of events that have occurred in the episode

parametersobject required

Learned parameters of the episode

Example response

{
  "instance_id": "123e4567-e89b-12d3-a456-426614174000",
  "episode_name": "default",
  "created_at": "2024-03-20T12:00:00Z",
  "events": [],
  "parameters": {}
}

Changes

  • 655f4be2d8f7Revision changes
    • info

      added the required property to the response with the status

  • f4bc37c876cfRevision changes
    • breaking

      added required request body

    • breaking

      removed the required property from the response with the status

    • warning

      deleted the path request parameter episode_name

    • info

      added the required property to the response with the status