Skip to content
UltimateTeam.ai Docs

List browser sessions

GET
/api/v1/browser-sessions
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/browser-sessions?page=1&limit=20' \
  --header 'X-API-Key: <X-API-Key>'

Returns a paginated, filterable list of browser sessions for the authenticated tenant.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
page
Page

Page number (1-indexed)

integer
default: 1 >= 1

Page number (1-indexed)

limit
Limit

Items per page (max 100)

integer
default: 20 >= 1 <= 100

Items per page (max 100)

agent_role
Any of:
string

Filter by agent role (e.g. ‘cro’)

tier
Any of:
string

Filter by tier (research, account, payment)

status
Any of:
string

Filter by status (pending, running, completed, failed, timeout)

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
SessionListResponse

Response for GET /api/v1/browser-sessions.

Attributes: data: List of session summaries. meta: Pagination metadata.

object
data
required
Data
Array<object>
SessionListItem

Summary of a single browser session for list views.

Attributes: id: Session UUID. agent_role: Which agent ran the session. tier: Autonomy tier. task: Browsing objective description. target_url: Starting URL. status: Current lifecycle status. credits_consumed: Credits used. duration_ms: Session duration in milliseconds. created_at: When the session was requested.

object
agent_role
required
Agent Role
string
created_at
Any of:
string
credits_consumed
Credits Consumed
integer
0
duration_ms
Any of:
integer
id
required
Id
string
status
required
Status
string
target_url
required
Target Url
string
task
required
Task
string
tier
required
Tier
string
meta
required
SessionListMeta

Pagination metadata for session list responses.

Attributes: total: Total matching sessions. page: Current page number. limit: Items per page.

object
limit
required
Limit
integer
page
required
Page
integer
total
required
Total
integer
Example
{
  "data": [
    {
      "credits_consumed": 0
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}