curl --request POST \
  --url https://api.osvi.ai/v1/chat/session/{id}/support \
  --header 'API-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "A human agent is joining the conversation."
}
'

{
  "success": true,
  "data": {
    "state": "ok",
    "session_id": "4718a326-417b-4dda-90d0-21fd65a11cb8",
    "command": "close",
    "reply": "Of course, let me pull that up for you.",
    "active_human": "agent@yourco.com"
  }
}

Chat

Send Support / Control Command

The operator control rail for a session. Send a plain message (delivered to the customer while a human has taken over), a control command, or both.

Recognized commands:

takeover — a human operator takes over the session; the agent stops auto-replying and mode becomes support.
tell — inject operator guidance and fire an agent turn; the agent’s reply is returned. Provide the text in message.
whisper — append private operator guidance for the next agent turn; the customer never sees it.
end — hand the session back to the agent (mode returns to ai).
close — close the session permanently.

A request with only message and no command is a plain operator message, valid while the session is in support mode (after takeover).

POST

chat

session

{id}

support

curl --request POST \
  --url https://api.osvi.ai/v1/chat/session/{id}/support \
  --header 'API-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "A human agent is joining the conversation."
}
'

{
  "success": true,
  "data": {
    "state": "ok",
    "session_id": "4718a326-417b-4dda-90d0-21fd65a11cb8",
    "command": "close",
    "reply": "Of course, let me pull that up for you.",
    "active_human": "agent@yourco.com"
  }
}

Authorizations

API-Token

string

header

required

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

Path Parameters

string

required

The session UUID (from Create Session or Get Active Session).

Example:

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

Body

application/json

command

enum<string>

Control command to apply. Omit to send a plain operator message (requires the session to be in support mode).

Available options:

takeover,

tell,

whisper,

end,

close

Example:

"close"

message

string

Message text. Required for a plain operator message and for the tell command; optional context for takeover.

Example:

"A human agent is joining the conversation."

Response

Command accepted. The response data always includes state, session_id, and command; additional fields depend on the command (e.g. reply for tell, active_human for takeover).

success

boolean

Example:

true

data

object

Show child attributes

Get Active Session Inject Context