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",
  "idempotency_key": "wh-2f8a1c-attempt-1",
  "input_fields": {
    "first_name": "Alex"
  },
  "state_fields": {},
  "context": [
    "Customer called in about a refund yesterday."
  ],
  "type": "message",
  "interaction_id": "b6a3e6c2-2d61-4a4b-9c9a-5a2d9f6a2b10",
  "option_id": "opt_confirm",
  "response": {
    "kind": "selection",
    "value": "opt_confirm"
  },
  "supported_interactions": [
    {
      "tool_type": "ui_buttons",
      "schema_version": 2
    }
  ]
}
'

import requests

url = "https://api.osvi.ai/v1/chat/inbound"

payload = {
    "agent_uuid": "agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og",
    "customer_id": "+15551112222",
    "content": "Hi, I need help.",
    "session_id": "4718a326-417b-4dda-90d0-21fd65a11cb8",
    "idempotency_key": "wh-2f8a1c-attempt-1",
    "input_fields": { "first_name": "Alex" },
    "state_fields": {},
    "context": ["Customer called in about a refund yesterday."],
    "type": "message",
    "interaction_id": "b6a3e6c2-2d61-4a4b-9c9a-5a2d9f6a2b10",
    "option_id": "opt_confirm",
    "response": {
        "kind": "selection",
        "value": "opt_confirm"
    },
    "supported_interactions": [
        {
            "tool_type": "ui_buttons",
            "schema_version": 2
        }
    ]
}
headers = {
    "API-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'API-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_uuid: 'agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og',
    customer_id: '+15551112222',
    content: 'Hi, I need help.',
    session_id: '4718a326-417b-4dda-90d0-21fd65a11cb8',
    idempotency_key: 'wh-2f8a1c-attempt-1',
    input_fields: {first_name: 'Alex'},
    state_fields: {},
    context: ['Customer called in about a refund yesterday.'],
    type: 'message',
    interaction_id: 'b6a3e6c2-2d61-4a4b-9c9a-5a2d9f6a2b10',
    option_id: 'opt_confirm',
    response: {kind: 'selection', value: 'opt_confirm'},
    supported_interactions: [{tool_type: 'ui_buttons', schema_version: 2}]
  })
};

fetch('https://api.osvi.ai/v1/chat/inbound', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.osvi.ai/v1/chat/inbound",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'agent_uuid' => 'agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og',
    'customer_id' => '+15551112222',
    'content' => 'Hi, I need help.',
    'session_id' => '4718a326-417b-4dda-90d0-21fd65a11cb8',
    'idempotency_key' => 'wh-2f8a1c-attempt-1',
    'input_fields' => [
        'first_name' => 'Alex'
    ],
    'state_fields' => [
        
    ],
    'context' => [
        'Customer called in about a refund yesterday.'
    ],
    'type' => 'message',
    'interaction_id' => 'b6a3e6c2-2d61-4a4b-9c9a-5a2d9f6a2b10',
    'option_id' => 'opt_confirm',
    'response' => [
        'kind' => 'selection',
        'value' => 'opt_confirm'
    ],
    'supported_interactions' => [
        [
                'tool_type' => 'ui_buttons',
                'schema_version' => 2
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "API-Token: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.osvi.ai/v1/chat/inbound"

	payload := strings.NewReader("{\n  \"agent_uuid\": \"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og\",\n  \"customer_id\": \"+15551112222\",\n  \"content\": \"Hi, I need help.\",\n  \"session_id\": \"4718a326-417b-4dda-90d0-21fd65a11cb8\",\n  \"idempotency_key\": \"wh-2f8a1c-attempt-1\",\n  \"input_fields\": {\n    \"first_name\": \"Alex\"\n  },\n  \"state_fields\": {},\n  \"context\": [\n    \"Customer called in about a refund yesterday.\"\n  ],\n  \"type\": \"message\",\n  \"interaction_id\": \"b6a3e6c2-2d61-4a4b-9c9a-5a2d9f6a2b10\",\n  \"option_id\": \"opt_confirm\",\n  \"response\": {\n    \"kind\": \"selection\",\n    \"value\": \"opt_confirm\"\n  },\n  \"supported_interactions\": [\n    {\n      \"tool_type\": \"ui_buttons\",\n      \"schema_version\": 2\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("API-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.osvi.ai/v1/chat/inbound")
  .header("API-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_uuid\": \"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og\",\n  \"customer_id\": \"+15551112222\",\n  \"content\": \"Hi, I need help.\",\n  \"session_id\": \"4718a326-417b-4dda-90d0-21fd65a11cb8\",\n  \"idempotency_key\": \"wh-2f8a1c-attempt-1\",\n  \"input_fields\": {\n    \"first_name\": \"Alex\"\n  },\n  \"state_fields\": {},\n  \"context\": [\n    \"Customer called in about a refund yesterday.\"\n  ],\n  \"type\": \"message\",\n  \"interaction_id\": \"b6a3e6c2-2d61-4a4b-9c9a-5a2d9f6a2b10\",\n  \"option_id\": \"opt_confirm\",\n  \"response\": {\n    \"kind\": \"selection\",\n    \"value\": \"opt_confirm\"\n  },\n  \"supported_interactions\": [\n    {\n      \"tool_type\": \"ui_buttons\",\n      \"schema_version\": 2\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.osvi.ai/v1/chat/inbound")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["API-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_uuid\": \"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og\",\n  \"customer_id\": \"+15551112222\",\n  \"content\": \"Hi, I need help.\",\n  \"session_id\": \"4718a326-417b-4dda-90d0-21fd65a11cb8\",\n  \"idempotency_key\": \"wh-2f8a1c-attempt-1\",\n  \"input_fields\": {\n    \"first_name\": \"Alex\"\n  },\n  \"state_fields\": {},\n  \"context\": [\n    \"Customer called in about a refund yesterday.\"\n  ],\n  \"type\": \"message\",\n  \"interaction_id\": \"b6a3e6c2-2d61-4a4b-9c9a-5a2d9f6a2b10\",\n  \"option_id\": \"opt_confirm\",\n  \"response\": {\n    \"kind\": \"selection\",\n    \"value\": \"opt_confirm\"\n  },\n  \"supported_interactions\": [\n    {\n      \"tool_type\": \"ui_buttons\",\n      \"schema_version\": 2\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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
  }
}

{
  "success": true,
  "accepted": true,
  "data": {
    "state": "accepted",
    "turn_id": "turn_9f3d2a1b",
    "session_id": "4718a326-417b-4dda-90d0-21fd65a11cb8",
    "idempotency_key": "wh-2f8a1c-attempt-1"
  }
}

{
  "success": false,
  "error": "agent_not_found"
}

{
  "success": false,
  "error": "agent_not_found"
}

{
  "success": false,
  "error": "agent_not_found"
}

{
  "success": false,
  "error": "idempotency_key_reused",
  "data": {
    "state": "error",
    "turn_id": "turn_9f3d2a1b",
    "session_id": "4718a326-417b-4dda-90d0-21fd65a11cb8"
  }
}

{
  "success": false,
  "error": "idempotency_key_reused",
  "data": {
    "state": "error",
    "turn_id": "turn_9f3d2a1b",
    "session_id": "4718a326-417b-4dda-90d0-21fd65a11cb8"
  }
}

{
  "success": false,
  "error": "Python engine returned 422 for POST /v1/chat/session/{id}/support",
  "upstream_body": {
    "state": "rejected",
    "reason": "tell_not_allowed_during_takeover"
  }
}

{
  "success": false,
  "error": "idempotency_key_reused",
  "data": {
    "state": "error",
    "turn_id": "turn_9f3d2a1b",
    "session_id": "4718a326-417b-4dda-90d0-21fd65a11cb8"
  }
}

Chat

Send Message

Sends an inbound customer message into the chat engine and returns the agent’s reply synchronously.

session_id is optional. If omitted, the engine resolves the customer’s active session for this agent (creating or resuming as needed), so a typical integration only needs agent_uuid, customer_id, and content.

For a customer answering an interactive message the agent sent, see Interactive messages. For fire-and-forget delivery instead of waiting on this response, use Send Message (Async).

POST

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",
  "idempotency_key": "wh-2f8a1c-attempt-1",
  "input_fields": {
    "first_name": "Alex"
  },
  "state_fields": {},
  "context": [
    "Customer called in about a refund yesterday."
  ],
  "type": "message",
  "interaction_id": "b6a3e6c2-2d61-4a4b-9c9a-5a2d9f6a2b10",
  "option_id": "opt_confirm",
  "response": {
    "kind": "selection",
    "value": "opt_confirm"
  },
  "supported_interactions": [
    {
      "tool_type": "ui_buttons",
      "schema_version": 2
    }
  ]
}
'

import requests

url = "https://api.osvi.ai/v1/chat/inbound"

payload = {
    "agent_uuid": "agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og",
    "customer_id": "+15551112222",
    "content": "Hi, I need help.",
    "session_id": "4718a326-417b-4dda-90d0-21fd65a11cb8",
    "idempotency_key": "wh-2f8a1c-attempt-1",
    "input_fields": { "first_name": "Alex" },
    "state_fields": {},
    "context": ["Customer called in about a refund yesterday."],
    "type": "message",
    "interaction_id": "b6a3e6c2-2d61-4a4b-9c9a-5a2d9f6a2b10",
    "option_id": "opt_confirm",
    "response": {
        "kind": "selection",
        "value": "opt_confirm"
    },
    "supported_interactions": [
        {
            "tool_type": "ui_buttons",
            "schema_version": 2
        }
    ]
}
headers = {
    "API-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'API-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_uuid: 'agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og',
    customer_id: '+15551112222',
    content: 'Hi, I need help.',
    session_id: '4718a326-417b-4dda-90d0-21fd65a11cb8',
    idempotency_key: 'wh-2f8a1c-attempt-1',
    input_fields: {first_name: 'Alex'},
    state_fields: {},
    context: ['Customer called in about a refund yesterday.'],
    type: 'message',
    interaction_id: 'b6a3e6c2-2d61-4a4b-9c9a-5a2d9f6a2b10',
    option_id: 'opt_confirm',
    response: {kind: 'selection', value: 'opt_confirm'},
    supported_interactions: [{tool_type: 'ui_buttons', schema_version: 2}]
  })
};

fetch('https://api.osvi.ai/v1/chat/inbound', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.osvi.ai/v1/chat/inbound",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'agent_uuid' => 'agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og',
    'customer_id' => '+15551112222',
    'content' => 'Hi, I need help.',
    'session_id' => '4718a326-417b-4dda-90d0-21fd65a11cb8',
    'idempotency_key' => 'wh-2f8a1c-attempt-1',
    'input_fields' => [
        'first_name' => 'Alex'
    ],
    'state_fields' => [
        
    ],
    'context' => [
        'Customer called in about a refund yesterday.'
    ],
    'type' => 'message',
    'interaction_id' => 'b6a3e6c2-2d61-4a4b-9c9a-5a2d9f6a2b10',
    'option_id' => 'opt_confirm',
    'response' => [
        'kind' => 'selection',
        'value' => 'opt_confirm'
    ],
    'supported_interactions' => [
        [
                'tool_type' => 'ui_buttons',
                'schema_version' => 2
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "API-Token: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.osvi.ai/v1/chat/inbound"

	payload := strings.NewReader("{\n  \"agent_uuid\": \"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og\",\n  \"customer_id\": \"+15551112222\",\n  \"content\": \"Hi, I need help.\",\n  \"session_id\": \"4718a326-417b-4dda-90d0-21fd65a11cb8\",\n  \"idempotency_key\": \"wh-2f8a1c-attempt-1\",\n  \"input_fields\": {\n    \"first_name\": \"Alex\"\n  },\n  \"state_fields\": {},\n  \"context\": [\n    \"Customer called in about a refund yesterday.\"\n  ],\n  \"type\": \"message\",\n  \"interaction_id\": \"b6a3e6c2-2d61-4a4b-9c9a-5a2d9f6a2b10\",\n  \"option_id\": \"opt_confirm\",\n  \"response\": {\n    \"kind\": \"selection\",\n    \"value\": \"opt_confirm\"\n  },\n  \"supported_interactions\": [\n    {\n      \"tool_type\": \"ui_buttons\",\n      \"schema_version\": 2\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("API-Token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.osvi.ai/v1/chat/inbound")
  .header("API-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_uuid\": \"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og\",\n  \"customer_id\": \"+15551112222\",\n  \"content\": \"Hi, I need help.\",\n  \"session_id\": \"4718a326-417b-4dda-90d0-21fd65a11cb8\",\n  \"idempotency_key\": \"wh-2f8a1c-attempt-1\",\n  \"input_fields\": {\n    \"first_name\": \"Alex\"\n  },\n  \"state_fields\": {},\n  \"context\": [\n    \"Customer called in about a refund yesterday.\"\n  ],\n  \"type\": \"message\",\n  \"interaction_id\": \"b6a3e6c2-2d61-4a4b-9c9a-5a2d9f6a2b10\",\n  \"option_id\": \"opt_confirm\",\n  \"response\": {\n    \"kind\": \"selection\",\n    \"value\": \"opt_confirm\"\n  },\n  \"supported_interactions\": [\n    {\n      \"tool_type\": \"ui_buttons\",\n      \"schema_version\": 2\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.osvi.ai/v1/chat/inbound")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["API-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_uuid\": \"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og\",\n  \"customer_id\": \"+15551112222\",\n  \"content\": \"Hi, I need help.\",\n  \"session_id\": \"4718a326-417b-4dda-90d0-21fd65a11cb8\",\n  \"idempotency_key\": \"wh-2f8a1c-attempt-1\",\n  \"input_fields\": {\n    \"first_name\": \"Alex\"\n  },\n  \"state_fields\": {},\n  \"context\": [\n    \"Customer called in about a refund yesterday.\"\n  ],\n  \"type\": \"message\",\n  \"interaction_id\": \"b6a3e6c2-2d61-4a4b-9c9a-5a2d9f6a2b10\",\n  \"option_id\": \"opt_confirm\",\n  \"response\": {\n    \"kind\": \"selection\",\n    \"value\": \"opt_confirm\"\n  },\n  \"supported_interactions\": [\n    {\n      \"tool_type\": \"ui_buttons\",\n      \"schema_version\": 2\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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
  }
}

{
  "success": true,
  "accepted": true,
  "data": {
    "state": "accepted",
    "turn_id": "turn_9f3d2a1b",
    "session_id": "4718a326-417b-4dda-90d0-21fd65a11cb8",
    "idempotency_key": "wh-2f8a1c-attempt-1"
  }
}

{
  "success": false,
  "error": "agent_not_found"
}

{
  "success": false,
  "error": "agent_not_found"
}

{
  "success": false,
  "error": "agent_not_found"
}

{
  "success": false,
  "error": "idempotency_key_reused",
  "data": {
    "state": "error",
    "turn_id": "turn_9f3d2a1b",
    "session_id": "4718a326-417b-4dda-90d0-21fd65a11cb8"
  }
}

{
  "success": false,
  "error": "idempotency_key_reused",
  "data": {
    "state": "error",
    "turn_id": "turn_9f3d2a1b",
    "session_id": "4718a326-417b-4dda-90d0-21fd65a11cb8"
  }
}

{
  "success": false,
  "error": "Python engine returned 422 for POST /v1/chat/session/{id}/support",
  "upstream_body": {
    "state": "rejected",
    "reason": "tell_not_allowed_during_takeover"
  }
}

{
  "success": false,
  "error": "idempotency_key_reused",
  "data": {
    "state": "error",
    "turn_id": "turn_9f3d2a1b",
    "session_id": "4718a326-417b-4dda-90d0-21fd65a11cb8"
  }
}

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

The customer's message text. Required unless type is interaction_response.

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"

idempotency_key

string

Your identifier for this exact turn. A retry with the same key returns the original result instead of running the turn twice. Can also be sent as an Idempotency-Key header instead of a body field.

Example:

"wh-2f8a1c-attempt-1"

input_fields

object

Arbitrary key-value object made available to the agent at runtime (e.g. name, account tier). Only applied when this request creates a new session.

Example:

{ "first_name": "Alex" }

state_fields

object

Initial values for the agent's configured state fields — structured values the agent's prompt and tools can read and update as the conversation continues. Only applied when this request creates a new session.

Example:

{}

context

string[]

Free-text context entries for a newly created session. Only the most recent 5 non-empty strings are retained. Only applied when this request creates a new session — use Inject Context to add context to an existing one.

Example:

[
  "Customer called in about a refund yesterday."
]

type

enum<string>

default:message

message for a normal text message (default). interaction_response to answer an interactive message the agent sent — see Interactive messages.

Available options:

message,

interaction_response

Example:

"message"

interaction_id

string<uuid>

Required when type is interaction_response. The interaction_id of the interactive message being answered.

Example:

"b6a3e6c2-2d61-4a4b-9c9a-5a2d9f6a2b10"

option_id

string

Shorthand answer for a simple option tap — the id of the selected option. Send this or response, not both. See Interactive messages.

Example:

"opt_confirm"

response

object

Structured answer to a pending interactive message. Send this or option_id, never both. See Interactive messages.

Show child attributes

supported_interactions

object[]

Declares which interactive message types your client can render, so the agent only offers ones you can display. See Interactive messages.

Show child attributes

Example:

[
  {
    "tool_type": "ui_buttons",
    "schema_version": 2
  }
]

Response

Message processed and agent reply returned. data.state can also be merged when your message was folded into another turn already in flight for the session — in that case reply is null and no separate reply is produced for this request.

success

boolean

Example:

true

data

object

Show child attributes

Get Started

Going Deeper

API Reference

Send Message

Authorizations

Body

Response