Create Session

Create a chat session

curl --request POST \
  --url https://api.osvi.ai/v1/chat/session \
  --header 'API-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_uuid": "agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og",
  "customer_id": "+15551112222",
  "input_fields": {
    "first_name": "Alex"
  },
  "context": [
    "Initial context for this chat"
  ]
}
'

import requests

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

payload = {
    "agent_uuid": "agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og",
    "customer_id": "+15551112222",
    "input_fields": { "first_name": "Alex" },
    "context": ["Initial context for this chat"]
}
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',
    input_fields: {first_name: 'Alex'},
    context: ['Initial context for this chat']
  })
};

fetch('https://api.osvi.ai/v1/chat/session', 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/session",
  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',
    'input_fields' => [
        'first_name' => 'Alex'
    ],
    'context' => [
        'Initial context for this chat'
    ]
  ]),
  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/session"

	payload := strings.NewReader("{\n  \"agent_uuid\": \"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og\",\n  \"customer_id\": \"+15551112222\",\n  \"input_fields\": {\n    \"first_name\": \"Alex\"\n  },\n  \"context\": [\n    \"Initial context for this chat\"\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/session")
  .header("API-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_uuid\": \"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og\",\n  \"customer_id\": \"+15551112222\",\n  \"input_fields\": {\n    \"first_name\": \"Alex\"\n  },\n  \"context\": [\n    \"Initial context for this chat\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"input_fields\": {\n    \"first_name\": \"Alex\"\n  },\n  \"context\": [\n    \"Initial context for this chat\"\n  ]\n}"

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

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

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

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

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

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

POST

chat

session

Create a chat session

curl --request POST \
  --url https://api.osvi.ai/v1/chat/session \
  --header 'API-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_uuid": "agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og",
  "customer_id": "+15551112222",
  "input_fields": {
    "first_name": "Alex"
  },
  "context": [
    "Initial context for this chat"
  ]
}
'

import requests

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

payload = {
    "agent_uuid": "agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og",
    "customer_id": "+15551112222",
    "input_fields": { "first_name": "Alex" },
    "context": ["Initial context for this chat"]
}
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',
    input_fields: {first_name: 'Alex'},
    context: ['Initial context for this chat']
  })
};

fetch('https://api.osvi.ai/v1/chat/session', 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/session",
  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',
    'input_fields' => [
        'first_name' => 'Alex'
    ],
    'context' => [
        'Initial context for this chat'
    ]
  ]),
  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/session"

	payload := strings.NewReader("{\n  \"agent_uuid\": \"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og\",\n  \"customer_id\": \"+15551112222\",\n  \"input_fields\": {\n    \"first_name\": \"Alex\"\n  },\n  \"context\": [\n    \"Initial context for this chat\"\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/session")
  .header("API-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_uuid\": \"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og\",\n  \"customer_id\": \"+15551112222\",\n  \"input_fields\": {\n    \"first_name\": \"Alex\"\n  },\n  \"context\": [\n    \"Initial context for this chat\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"input_fields\": {\n    \"first_name\": \"Alex\"\n  },\n  \"context\": [\n    \"Initial context for this chat\"\n  ]\n}"

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

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

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

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

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

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

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. Must be an active, non-archived agent belonging to the account that owns the API token.

Example:

"agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og"

customer_id

string

required

Your identifier for the customer on the other side of the conversation — typically a phone number, but any stable string works. Used to resolve the active session on subsequent messages.

Example:

"+15551112222"

input_fields

object

Arbitrary key-value object describing the customer, made available to the agent at runtime (e.g. name, account tier).

Example:

{ "first_name": "Alex" }

context

string[]

Initial free-text context entries for the session. Only the most recent 5 non-empty strings are retained (FIFO). Append more later with the inject-context endpoint.

Example:

["Initial context for this chat"]

Response

Session created successfully

success

boolean

Example:

true

data

object

A chat session record.

Show child attributes

API documentation

API v1

Legacy

Webhooks

Authorizations

Body

Response