SoulFire LogoSoulFire

List instances

Lists all instances the current user has permission to view. Only instances where the user has READ_INSTANCE permission are returned. Returns summary information for each instance.

GET
/v1/instances

Lists all instances the current user has permission to view. Only instances where the user has READ_INSTANCE permission are returned. Returns summary information for each instance.

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://127.0.0.1:38765/v1/instances"
{
  "instances": [
    {
      "id": "string",
      "friendly_name": "string",
      "icon": "string",
      "state": "STARTING",
      "instance_permissions": [
        {
          "instance_permission": "INSTANCE_COMMAND_EXECUTION",
          "granted": true
        }
      ]
    }
  ]
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}
{
  "code": 0,
  "grpc-code": "string",
  "message": "string",
  "stack-trace": "string",
  "details": [
    {}
  ]
}

How is this page?

Change instance state POST

Changes the lifecycle state of an instance. Used to start, pause, resume, or stop bot sessions. The operation blocks until the state transition is complete.

Create instance POST

Creates a new instance with the given friendly name. The instance starts in STOPPED state with default configuration.