Skip to main content
GET
/
v1
/
chat
/
session
/
active
Get active session
curl --request GET \
  --url https://api.osvi.ai/v1/chat/session/active \
  --header 'API-Token: <api-key>'
{
  "success": true,
  "data": {
    "id": "4718a326-417b-4dda-90d0-21fd65a11cb8",
    "chat_agent_id": 42,
    "account_id": 7,
    "customer_id": "+15551112222",
    "mode": "ai",
    "help_requested": false,
    "status": "active",
    "current_state": null,
    "metadata": {
      "input_fields": {
        "first_name": "Alex"
      },
      "state_fields": {},
      "context": [
        "Initial context for this chat"
      ]
    },
    "active_human": null,
    "created_at": "2026-06-04T11:40:25.690486Z",
    "updated_at": "2026-06-04T11:40:25.690486Z"
  }
}

Authorizations

​
API-Token
string
header
required

16-character API token associated with your OSVI account. Find it in your dashboard under Settings → API.

Query Parameters

​
customer_id
string
required

Your identifier for the customer.

Example:

"+15551112222"

​
agent_uuid
string

Optional agent filter. When provided, the response data is a single session object; when omitted, data is keyed by agent UUID.

Example:

"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og"

Response

Active session(s) found. The shape of data depends on whether agent_uuid was supplied.

​
success
boolean
Example:

true

​
data
object

A chat session record.