List Sessions

GET/v1/openai-agents/sessions

Base URL *

Your instance endpoint, shown on the instance page in the dashboard. Each instance has its own host; there is no shared API host.

Authorization (Bearer token)

Responses

200 Success

Property	Type	Description
`data`	`object[]`

400 Invalid request

Property	Type	Description
`error`	`object`

403 Permission denied

Property	Type	Description
`error`	`object`

404 Not found

Property	Type	Description
`error`	`object`

500 Internal error

Property	Type	Description
`error`	`object`

503 Unavailable

Property	Type	Description
`error`	`object`

Request

curl -X GET "http://localhost:8089/v1/openai-agents/sessions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

const response = await fetch("http://localhost:8089/v1/openai-agents/sessions", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
});
const data = await response.json();

import requests

response = requests.get(
    "http://localhost:8089/v1/openai-agents/sessions",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = response.json()

Response

{
  "data": [
    {
      "id": "string",
      "provider": "string",
      "connection_id": "string",
      "conversation_id": "string",
      "upstream_session_id": "string",
      "upstream_environment_id": "string",
      "sandbox_id": "string",
      "model": "string",
      "environment": {
        "type": "none",
        "workspace_directory": "string"
      },
      "status": "string",
      "readiness": "string",
      "cleanup_status": "string",
      "environment_cleanup_status": "string",
      "last_error": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string"
  }
}