Skip to main content
POST
/
v1
/
chat
/
inbound
Send a chat message
curl --request POST \
  --url https://api.osvi.ai/v1/chat/inbound \
  --header 'API-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_uuid": "agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og",
  "customer_id": "+15551112222",
  "content": "Hi, I need help.",
  "session_id": "4718a326-417b-4dda-90d0-21fd65a11cb8"
}
'
{
  "success": true,
  "data": {
    "session_id": "4718a326-417b-4dda-90d0-21fd65a11cb8",
    "reply": "Sure — I can help with that. What's your order number?",
    "state": "default",
    "mode": "ai",
    "help_requested": false
  }
}

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 agent handling the conversation.

Example:

"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og"

​
customer_id
string
required

Your identifier for the customer sending the message. Used to resolve the active session when session_id is omitted.

Example:

"+15551112222"

​
content
string
required

The customer's message text.

Example:

"Hi, I need help."

​
session_id
string

Optional session UUID to route the message to. If omitted, the engine resolves the active/new session for the customer + agent.

Example:

"4718a326-417b-4dda-90d0-21fd65a11cb8"

Response

Message processed and agent reply returned

​
success
boolean
Example:

true

​
data
object