List Sessions

POST/everstack.openai_agents.v1.OpenAIAgentsService/ListSessions

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)

Request Body (JSON)

Request Body

Responses

200 A successful response.

Property	Type	Description
`sessions`	`object[]`

default An unexpected error response.

Property	Type	Description
`code`	`integer`
`message`	`string`
`details`	`object[]`

Request

curl -X POST "http://localhost:8089/everstack.openai_agents.v1.OpenAIAgentsService/ListSessions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

const response = await fetch("http://localhost:8089/everstack.openai_agents.v1.OpenAIAgentsService/ListSessions", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
});
const data = await response.json();

import requests

response = requests.post(
    "http://localhost:8089/everstack.openai_agents.v1.OpenAIAgentsService/ListSessions",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
)
data = response.json()

Response

{
  "sessions": [
    {
      "id": "string",
      "provider": "string",
      "connectionId": "string",
      "conversationId": "string",
      "upstreamSessionId": "string",
      "upstreamEnvironmentId": "string",
      "sandboxId": "string",
      "model": "string",
      "environment": {
        "type": "string",
        "workspaceDirectory": "string"
      },
      "status": "string",
      "readiness": "string",
      "cleanupStatus": "string",
      "environmentCleanupStatus": "string",
      "lastError": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ]
}

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}