Skip to main content
GET
/
api
/
v1
/
agent-sessions
List Agent Sessions
curl --request GET \
  --url https://api.opensink.com/api/v1/agent-sessions \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "running",
      "state": {},
      "metadata": {},
      "error_message": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "trail": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key authentication

Query Parameters

​
agent_id
string<uuid>

Filter by agent ID

​
status
enum<string>

Filter by status

Available options:
running,
waiting_for_input,
processing_input,
completed,
failed
​
status_in
enum<string>[]

Filter by multiple statuses

Available options:
running,
waiting_for_input,
processing_input,
completed,
failed
​
$limit
number

Maximum items to return (default: 50, max: 100)

​
$trail
string

Pagination trail from previous response

Response

Default Response

​
items
object[]
​
trail
string | null

Pagination trail for next page