List Tabs
GET /v1/browser/sessions/{session_id}/tabs
Open tabs in a browser session; page actions target the active one
Authentication
Requires authentication via: OAuth2PasswordBearer.
Parameters
| Name | In | Type | Required | Description | Constraints |
|---|---|---|---|---|---|
session_id | path | string | Yes | ||
X-API-Key | header | string | null | No | nullable |
Responses
200
Successful Response
application/json
Resolved schema:
{
"properties": {
"success": {
"type": "boolean",
"title": "Success"
},
"session_id": {
"type": "string",
"title": "Session Id"
},
"tabs": {
"items": {
"properties": {
"tab_id": {
"type": "string",
"title": "Tab Id"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"active": {
"type": "boolean",
"title": "Active",
"default": false
}
},
"type": "object",
"required": [
"tab_id"
],
"title": "BrowserTab"
},
"type": "array",
"title": "Tabs"
},
"tab_count": {
"type": "integer",
"title": "Tab Count"
},
"active_tab_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Active Tab Id"
},
"active_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Active Url"
},
"execution_time": {
"type": "number",
"title": "Execution Time"
}
},
"type": "object",
"required": [
"success",
"session_id",
"tabs",
"tab_count",
"execution_time"
],
"title": "BrowserTabsResponse",
"description": "Open tabs in a session; page actions target the active one."
}
Field details:
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
success | boolean | Yes | ||
session_id | string | Yes | ||
tabs | array<object> | Yes | ||
tabs[] | object | Yes | ||
tabs[].tab_id | string | Yes | ||
tabs[].url | string | null | No | nullable | |
tabs[].title | string | null | No | nullable | |
tabs[].active | boolean | No | default=false | |
tab_count | integer | Yes | ||
active_tab_id | string | null | No | nullable | |
active_url | string | null | No | nullable | |
execution_time | number | Yes |
400
The browser rejected the tab request as invalid (detail.code is invalid_request).
No response body.
401
No credentials, or the Bearer token / X-API-Key is invalid.
No response body.
403
The account is disabled, or a guest token was used.
No response body.
404
Session not found, expired, or not yours (not_found); the tab does not exist (tab_not_found); or this browser has no tab support (unsupported).
No response body.
409
The tab request conflicts with the session state, for example the tab limit is reached (tab_limit) or it is the last open tab (last_tab).
No response body.
422
Validation Error
application/json
Resolved schema:
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}
Field details:
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
detail | array<object> | No | ||
detail[] | object | No | ||
detail[].loc | array<string | integer> | No | ||
detail[].loc[] | string | integer | No | ||
detail[].msg | string | No | ||
detail[].type | string | No |
502
The browser service could not complete the tab request.
No response body.