Escalation
Escalate to ticketing integration
Escalate a completed conversation to an external ticketing integration (Plain, Pylon, or Linear). Creates a ticket with the conversation transcript and AI-generated summary.
Can only be called once per conversation. Subsequent calls return 409 Conflict.
POST
/
v0
/
chat
/
{conversation_id}
/
escalate
Escalate to ticketing integration
curl --request POST \
--url https://api.getdecimal.ai/v0/chat/{conversation_id}/escalate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"integration": "plain",
"email": "jsmith@example.com",
"name": "<string>",
"title": "<string>",
"summary": "<string>",
"additional_fields": {
"label_type_ids": [
"<string>"
],
"priority": 123
}
}
'import requests
url = "https://api.getdecimal.ai/v0/chat/{conversation_id}/escalate"
payload = {
"integration": "plain",
"email": "jsmith@example.com",
"name": "<string>",
"title": "<string>",
"summary": "<string>",
"additional_fields": {
"label_type_ids": ["<string>"],
"priority": 123
}
}
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({
integration: 'plain',
email: 'jsmith@example.com',
name: '<string>',
title: '<string>',
summary: '<string>',
additional_fields: {label_type_ids: ['<string>'], priority: 123}
})
};
fetch('https://api.getdecimal.ai/v0/chat/{conversation_id}/escalate', 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.getdecimal.ai/v0/chat/{conversation_id}/escalate",
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([
'integration' => 'plain',
'email' => 'jsmith@example.com',
'name' => '<string>',
'title' => '<string>',
'summary' => '<string>',
'additional_fields' => [
'label_type_ids' => [
'<string>'
],
'priority' => 123
]
]),
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.getdecimal.ai/v0/chat/{conversation_id}/escalate"
payload := strings.NewReader("{\n \"integration\": \"plain\",\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"summary\": \"<string>\",\n \"additional_fields\": {\n \"label_type_ids\": [\n \"<string>\"\n ],\n \"priority\": 123\n }\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.getdecimal.ai/v0/chat/{conversation_id}/escalate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"integration\": \"plain\",\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"summary\": \"<string>\",\n \"additional_fields\": {\n \"label_type_ids\": [\n \"<string>\"\n ],\n \"priority\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getdecimal.ai/v0/chat/{conversation_id}/escalate")
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 \"integration\": \"plain\",\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"summary\": \"<string>\",\n \"additional_fields\": {\n \"label_type_ids\": [\n \"<string>\"\n ],\n \"priority\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"ticket_id": "<string>",
"ticket_url": "<string>"
}{
"error": {
"message": "<string>",
"retryable": true
}
}{
"error": {
"message": "<string>",
"retryable": true
}
}{
"error": {
"message": "<string>",
"retryable": true
}
}{
"error": {
"message": "<string>",
"retryable": true
}
}{
"error": {
"message": "<string>",
"retryable": true
}
}{
"error": {
"message": "<string>",
"retryable": true
}
}{
"error": {
"message": "<string>",
"retryable": true
}
}Authorizations
API token with sk-de- prefix.
Created in the Decimal dashboard under Settings → API Tokens.
Path Parameters
Conversation ID (returned by POST /v0/chat).
Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
Available options:
plain Customer email for the ticket.
Minimum string length:
1Customer name for the ticket.
Minimum string length:
1Ticket title. Auto-generated from conversation if omitted.
Ticket summary. Auto-generated from conversation if omitted.
Show child attributes
Show child attributes
Response
Escalation successful.
Previous
Get current token infoReturns information about the authenticated API token and organization.
Next
⌘I
Escalate to ticketing integration
curl --request POST \
--url https://api.getdecimal.ai/v0/chat/{conversation_id}/escalate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"integration": "plain",
"email": "jsmith@example.com",
"name": "<string>",
"title": "<string>",
"summary": "<string>",
"additional_fields": {
"label_type_ids": [
"<string>"
],
"priority": 123
}
}
'import requests
url = "https://api.getdecimal.ai/v0/chat/{conversation_id}/escalate"
payload = {
"integration": "plain",
"email": "jsmith@example.com",
"name": "<string>",
"title": "<string>",
"summary": "<string>",
"additional_fields": {
"label_type_ids": ["<string>"],
"priority": 123
}
}
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({
integration: 'plain',
email: 'jsmith@example.com',
name: '<string>',
title: '<string>',
summary: '<string>',
additional_fields: {label_type_ids: ['<string>'], priority: 123}
})
};
fetch('https://api.getdecimal.ai/v0/chat/{conversation_id}/escalate', 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.getdecimal.ai/v0/chat/{conversation_id}/escalate",
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([
'integration' => 'plain',
'email' => 'jsmith@example.com',
'name' => '<string>',
'title' => '<string>',
'summary' => '<string>',
'additional_fields' => [
'label_type_ids' => [
'<string>'
],
'priority' => 123
]
]),
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.getdecimal.ai/v0/chat/{conversation_id}/escalate"
payload := strings.NewReader("{\n \"integration\": \"plain\",\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"summary\": \"<string>\",\n \"additional_fields\": {\n \"label_type_ids\": [\n \"<string>\"\n ],\n \"priority\": 123\n }\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.getdecimal.ai/v0/chat/{conversation_id}/escalate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"integration\": \"plain\",\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"summary\": \"<string>\",\n \"additional_fields\": {\n \"label_type_ids\": [\n \"<string>\"\n ],\n \"priority\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getdecimal.ai/v0/chat/{conversation_id}/escalate")
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 \"integration\": \"plain\",\n \"email\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"summary\": \"<string>\",\n \"additional_fields\": {\n \"label_type_ids\": [\n \"<string>\"\n ],\n \"priority\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"ticket_id": "<string>",
"ticket_url": "<string>"
}{
"error": {
"message": "<string>",
"retryable": true
}
}{
"error": {
"message": "<string>",
"retryable": true
}
}{
"error": {
"message": "<string>",
"retryable": true
}
}{
"error": {
"message": "<string>",
"retryable": true
}
}{
"error": {
"message": "<string>",
"retryable": true
}
}{
"error": {
"message": "<string>",
"retryable": true
}
}{
"error": {
"message": "<string>",
"retryable": true
}
}