curl --request POST \
--url https://api.orbit.devotel.io/api/v1/agents/{id}/conversations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conversation_id": "<string>",
"messages": [
{
"role": "<string>",
"content": "<string>"
}
],
"tokens_used": 1,
"channel": "<string>",
"turn": {},
"escalated": true,
"escalation_reason": "<string>",
"escalation_category": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/{id}/conversations"
payload = {
"conversation_id": "<string>",
"messages": [
{
"role": "<string>",
"content": "<string>"
}
],
"tokens_used": 1,
"channel": "<string>",
"turn": {},
"escalated": True,
"escalation_reason": "<string>",
"escalation_category": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
conversation_id: '<string>',
messages: [{role: '<string>', content: '<string>'}],
tokens_used: 1,
channel: '<string>',
turn: {},
escalated: true,
escalation_reason: '<string>',
escalation_category: '<string>'
})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/{id}/conversations', 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.orbit.devotel.io/api/v1/agents/{id}/conversations",
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([
'conversation_id' => '<string>',
'messages' => [
[
'role' => '<string>',
'content' => '<string>'
]
],
'tokens_used' => 1,
'channel' => '<string>',
'turn' => [
],
'escalated' => true,
'escalation_reason' => '<string>',
'escalation_category' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.orbit.devotel.io/api/v1/agents/{id}/conversations"
payload := strings.NewReader("{\n \"conversation_id\": \"<string>\",\n \"messages\": [\n {\n \"role\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"tokens_used\": 1,\n \"channel\": \"<string>\",\n \"turn\": {},\n \"escalated\": true,\n \"escalation_reason\": \"<string>\",\n \"escalation_category\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.orbit.devotel.io/api/v1/agents/{id}/conversations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"conversation_id\": \"<string>\",\n \"messages\": [\n {\n \"role\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"tokens_used\": 1,\n \"channel\": \"<string>\",\n \"turn\": {},\n \"escalated\": true,\n \"escalation_reason\": \"<string>\",\n \"escalation_category\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/{id}/conversations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"conversation_id\": \"<string>\",\n \"messages\": [\n {\n \"role\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"tokens_used\": 1,\n \"channel\": \"<string>\",\n \"turn\": {},\n \"escalated\": true,\n \"escalation_reason\": \"<string>\",\n \"escalation_category\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"persisted": true,
"conversation_id": "conv_01J9Z8ABCDEF"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Persist one agent conversation (internal callback)
Persist a completed agent conversation from the agent-runtime (service-to-service internal auth). The body carries the runtime-assigned conversation_id, the role-tagged messages turn list, and optional token/cost counters plus a per-turn turn debug payload for per-conversation trace drilldown. When escalated: true in the body, the configured escalation action (status → escalated, webhooks, human-inbox transcript) is dispatched right after persistence. Idempotent fire-and-forget callback — safe to retry.
curl --request POST \
--url https://api.orbit.devotel.io/api/v1/agents/{id}/conversations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conversation_id": "<string>",
"messages": [
{
"role": "<string>",
"content": "<string>"
}
],
"tokens_used": 1,
"channel": "<string>",
"turn": {},
"escalated": true,
"escalation_reason": "<string>",
"escalation_category": "<string>"
}
'import requests
url = "https://api.orbit.devotel.io/api/v1/agents/{id}/conversations"
payload = {
"conversation_id": "<string>",
"messages": [
{
"role": "<string>",
"content": "<string>"
}
],
"tokens_used": 1,
"channel": "<string>",
"turn": {},
"escalated": True,
"escalation_reason": "<string>",
"escalation_category": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
conversation_id: '<string>',
messages: [{role: '<string>', content: '<string>'}],
tokens_used: 1,
channel: '<string>',
turn: {},
escalated: true,
escalation_reason: '<string>',
escalation_category: '<string>'
})
};
fetch('https://api.orbit.devotel.io/api/v1/agents/{id}/conversations', 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.orbit.devotel.io/api/v1/agents/{id}/conversations",
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([
'conversation_id' => '<string>',
'messages' => [
[
'role' => '<string>',
'content' => '<string>'
]
],
'tokens_used' => 1,
'channel' => '<string>',
'turn' => [
],
'escalated' => true,
'escalation_reason' => '<string>',
'escalation_category' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.orbit.devotel.io/api/v1/agents/{id}/conversations"
payload := strings.NewReader("{\n \"conversation_id\": \"<string>\",\n \"messages\": [\n {\n \"role\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"tokens_used\": 1,\n \"channel\": \"<string>\",\n \"turn\": {},\n \"escalated\": true,\n \"escalation_reason\": \"<string>\",\n \"escalation_category\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.orbit.devotel.io/api/v1/agents/{id}/conversations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"conversation_id\": \"<string>\",\n \"messages\": [\n {\n \"role\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"tokens_used\": 1,\n \"channel\": \"<string>\",\n \"turn\": {},\n \"escalated\": true,\n \"escalation_reason\": \"<string>\",\n \"escalation_category\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbit.devotel.io/api/v1/agents/{id}/conversations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"conversation_id\": \"<string>\",\n \"messages\": [\n {\n \"role\": \"<string>\",\n \"content\": \"<string>\"\n }\n ],\n \"tokens_used\": 1,\n \"channel\": \"<string>\",\n \"turn\": {},\n \"escalated\": true,\n \"escalation_reason\": \"<string>\",\n \"escalation_category\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"persisted": true,
"conversation_id": "conv_01J9Z8ABCDEF"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "<string>",
"status": 429,
"retry_after": 2
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"status": 123,
"details": {}
},
"meta": {
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"docs_url": "<string>"
}
}Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false Path Parameters
The agent id.
1Body
Runtime-assigned conversation id.
1Show child attributes
Show child attributes
Total tokens the conversation consumed.
x >= 0Channel the conversation ran on (default api).
Optional per-turn debug payload (tool_calls, retrievals, latency split, tokens, cost, model) for the debug trace view.
Set by the runtime when a configured escalation trigger fired — dispatches the escalation action after persistence.
1000100