Skip to main content
GET
/
chat
/
sessions
/
{chat_session_id}
/
state
Get chat session state
curl --request GET \
  --url https://app.nextbrowser.com/api/v1/chat/sessions/{chat_session_id}/state \
  --header 'Authorization: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "num_tasks": 123,
  "status": "active",
  "browser_instance_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "browser_id": "<string>",
  "proxy_settings": {},
  "browser_settings": {},
  "tasks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "finished_at": "2023-11-07T05:31:56Z",
      "done_output": "<string>",
      "structured_output": {},
      "llm_model": "<string>",
      "state": "processing",
      "task_description": "<string>",
      "output_description": "<string>",
      "output_files_path": "<string>",
      "error_message": "<string>",
      "steps": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created_at": "2023-11-07T05:31:56Z",
          "finished_at": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "status": "pending"
        }
      ]
    }
  ],
  "title": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key in the format 'x-api-key '

Path Parameters

​
chat_session_id
string<uuid>
required

The UUID of the chat session

Response

Chat session state retrieved successfully

​
id
string<uuid>

The UUID of the chat session

​
user_id
string<uuid>

The UUID of the user

​
created_at
string<date-time>

Timestamp when the chat session was created

​
finished_at
string<date-time>

Timestamp when the chat session was finished

​
num_tasks
integer

Number of tasks in the chat session

​
status
enum<string>

Current status of the chat session

Available options:
active,
completed,
failed
​
browser_instance_id
string<uuid>

The UUID of the browser instance

​
browser_id
string

The id of the browser connection

​
proxy_settings
object

Proxy settings for the browser

​
browser_settings
object

Browser settings

​
tasks
object[]

List of tasks in the chat session

​
title
string

Title of the chat session