Skip to main content
POST
/
chat_sessions
Start a chat session
curl --request POST \
  --url https://api.osvi.ai/chat_sessions \
  --header 'API-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_uuid": "agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og",
  "metadata": {
    "person_name": "Jane Smith"
  }
}
'
{
  "success": true,
  "data": {
    "session_id": "4718a326-417b-4dda-90d0-21fd65a11cb8",
    "agent_name": "Support Agent",
    "started_at": "2025-12-31T11:40:25.690486",
    "welcome_message": "Hi! How can I help you today?"
  }
}

Authorizations

​
API-Token
string
header
required

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

Body

application/json
​
agent_uuid
string
required

Unique identifier of the OSVI agent to chat with.

Example:

"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og"

​
metadata
object

Optional session metadata made available to the agent.

Response

Session started successfully

​
success
boolean
Example:

true

​
data
object