Create or replace a conversation target config
curl --request PUT \
--url https://api.example.com/api/conversation-configs/{target_kind}/{target_name} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"target_name": "<string>",
"greeting_template": "<string>",
"multichannel": false,
"state_binding": {
"states": [
{
"state": "<string>",
"subject_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"input_injections": [
{
"into": "<string>",
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
],
"scope_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"templates": [
"<string>"
],
"updates": [
{
"adapter": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"op_id": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
]
}
]
}
}
'import requests
url = "https://api.example.com/api/conversation-configs/{target_kind}/{target_name}"
payload = {
"target_name": "<string>",
"greeting_template": "<string>",
"multichannel": False,
"state_binding": { "states": [
{
"state": "<string>",
"subject_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"input_injections": [
{
"into": "<string>",
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
],
"scope_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"templates": ["<string>"],
"updates": [
{
"adapter": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"op_id": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
]
}
] }
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
target_name: '<string>',
greeting_template: '<string>',
multichannel: false,
state_binding: {
states: [
{
state: '<string>',
subject_expr: {content: '<string>', id: '<string>', kwargs: {}},
input_injections: [
{
into: '<string>',
jq: {content: '<string>', id: '<string>', kwargs: {}},
template_jq: '<string>'
}
],
scope_expr: {content: '<string>', id: '<string>', kwargs: {}},
templates: ['<string>'],
updates: [
{
adapter: {content: '<string>', id: '<string>', kwargs: {}},
jq: {content: '<string>', id: '<string>', kwargs: {}},
op_id: {content: '<string>', id: '<string>', kwargs: {}},
template_jq: '<string>'
}
]
}
]
}
})
};
fetch('https://api.example.com/api/conversation-configs/{target_kind}/{target_name}', 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.example.com/api/conversation-configs/{target_kind}/{target_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'target_name' => '<string>',
'greeting_template' => '<string>',
'multichannel' => false,
'state_binding' => [
'states' => [
[
'state' => '<string>',
'subject_expr' => [
'content' => '<string>',
'id' => '<string>',
'kwargs' => [
]
],
'input_injections' => [
[
'into' => '<string>',
'jq' => [
'content' => '<string>',
'id' => '<string>',
'kwargs' => [
]
],
'template_jq' => '<string>'
]
],
'scope_expr' => [
'content' => '<string>',
'id' => '<string>',
'kwargs' => [
]
],
'templates' => [
'<string>'
],
'updates' => [
[
'adapter' => [
'content' => '<string>',
'id' => '<string>',
'kwargs' => [
]
],
'jq' => [
'content' => '<string>',
'id' => '<string>',
'kwargs' => [
]
],
'op_id' => [
'content' => '<string>',
'id' => '<string>',
'kwargs' => [
]
],
'template_jq' => '<string>'
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.example.com/api/conversation-configs/{target_kind}/{target_name}"
payload := strings.NewReader("{\n \"target_name\": \"<string>\",\n \"greeting_template\": \"<string>\",\n \"multichannel\": false,\n \"state_binding\": {\n \"states\": [\n {\n \"state\": \"<string>\",\n \"subject_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"input_injections\": [\n {\n \"into\": \"<string>\",\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ],\n \"scope_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"templates\": [\n \"<string>\"\n ],\n \"updates\": [\n {\n \"adapter\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"op_id\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ]\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<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.put("https://api.example.com/api/conversation-configs/{target_kind}/{target_name}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"target_name\": \"<string>\",\n \"greeting_template\": \"<string>\",\n \"multichannel\": false,\n \"state_binding\": {\n \"states\": [\n {\n \"state\": \"<string>\",\n \"subject_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"input_injections\": [\n {\n \"into\": \"<string>\",\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ],\n \"scope_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"templates\": [\n \"<string>\"\n ],\n \"updates\": [\n {\n \"adapter\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"op_id\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ]\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/conversation-configs/{target_kind}/{target_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"target_name\": \"<string>\",\n \"greeting_template\": \"<string>\",\n \"multichannel\": false,\n \"state_binding\": {\n \"states\": [\n {\n \"state\": \"<string>\",\n \"subject_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"input_injections\": [\n {\n \"into\": \"<string>\",\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ],\n \"scope_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"templates\": [\n \"<string>\"\n ],\n \"updates\": [\n {\n \"adapter\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"op_id\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ]\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"config": {
"target_kind": "agent",
"target_name": "<string>",
"greeting_template": "<string>",
"multichannel": false,
"state_binding": {
"states": [
{
"state": "<string>",
"subject_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"input_injections": [
{
"into": "<string>",
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
],
"scope_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"templates": [
"<string>"
],
"updates": [
{
"adapter": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"op_id": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
]
}
]
}
},
"created": true,
"target_kind": "<string>",
"target_name": "<string>"
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}conversations
Create or replace a conversation target config
Create or replace the per-target config for (target_kind, target_name) — an
UPSERT, so this is the create path AND the edit path for a config of that key.
The target must merely EXIST — the agent (target_kind=agent) or tool
(target_kind=tool) — exactly as the route create checks it. greeting_template
may reference at most the {pairing_code} placeholder and a blank template is refused
(null = no greeting), both enforced by the model. No key is bound and no authority
delegated: this is inert operator config. Returns
{"created", "target_kind", "target_name", "config"}.
PUT
/
api
/
conversation-configs
/
{target_kind}
/
{target_name}
Create or replace a conversation target config
curl --request PUT \
--url https://api.example.com/api/conversation-configs/{target_kind}/{target_name} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"target_name": "<string>",
"greeting_template": "<string>",
"multichannel": false,
"state_binding": {
"states": [
{
"state": "<string>",
"subject_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"input_injections": [
{
"into": "<string>",
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
],
"scope_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"templates": [
"<string>"
],
"updates": [
{
"adapter": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"op_id": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
]
}
]
}
}
'import requests
url = "https://api.example.com/api/conversation-configs/{target_kind}/{target_name}"
payload = {
"target_name": "<string>",
"greeting_template": "<string>",
"multichannel": False,
"state_binding": { "states": [
{
"state": "<string>",
"subject_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"input_injections": [
{
"into": "<string>",
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
],
"scope_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"templates": ["<string>"],
"updates": [
{
"adapter": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"op_id": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
]
}
] }
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
target_name: '<string>',
greeting_template: '<string>',
multichannel: false,
state_binding: {
states: [
{
state: '<string>',
subject_expr: {content: '<string>', id: '<string>', kwargs: {}},
input_injections: [
{
into: '<string>',
jq: {content: '<string>', id: '<string>', kwargs: {}},
template_jq: '<string>'
}
],
scope_expr: {content: '<string>', id: '<string>', kwargs: {}},
templates: ['<string>'],
updates: [
{
adapter: {content: '<string>', id: '<string>', kwargs: {}},
jq: {content: '<string>', id: '<string>', kwargs: {}},
op_id: {content: '<string>', id: '<string>', kwargs: {}},
template_jq: '<string>'
}
]
}
]
}
})
};
fetch('https://api.example.com/api/conversation-configs/{target_kind}/{target_name}', 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.example.com/api/conversation-configs/{target_kind}/{target_name}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'target_name' => '<string>',
'greeting_template' => '<string>',
'multichannel' => false,
'state_binding' => [
'states' => [
[
'state' => '<string>',
'subject_expr' => [
'content' => '<string>',
'id' => '<string>',
'kwargs' => [
]
],
'input_injections' => [
[
'into' => '<string>',
'jq' => [
'content' => '<string>',
'id' => '<string>',
'kwargs' => [
]
],
'template_jq' => '<string>'
]
],
'scope_expr' => [
'content' => '<string>',
'id' => '<string>',
'kwargs' => [
]
],
'templates' => [
'<string>'
],
'updates' => [
[
'adapter' => [
'content' => '<string>',
'id' => '<string>',
'kwargs' => [
]
],
'jq' => [
'content' => '<string>',
'id' => '<string>',
'kwargs' => [
]
],
'op_id' => [
'content' => '<string>',
'id' => '<string>',
'kwargs' => [
]
],
'template_jq' => '<string>'
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.example.com/api/conversation-configs/{target_kind}/{target_name}"
payload := strings.NewReader("{\n \"target_name\": \"<string>\",\n \"greeting_template\": \"<string>\",\n \"multichannel\": false,\n \"state_binding\": {\n \"states\": [\n {\n \"state\": \"<string>\",\n \"subject_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"input_injections\": [\n {\n \"into\": \"<string>\",\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ],\n \"scope_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"templates\": [\n \"<string>\"\n ],\n \"updates\": [\n {\n \"adapter\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"op_id\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ]\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<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.put("https://api.example.com/api/conversation-configs/{target_kind}/{target_name}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"target_name\": \"<string>\",\n \"greeting_template\": \"<string>\",\n \"multichannel\": false,\n \"state_binding\": {\n \"states\": [\n {\n \"state\": \"<string>\",\n \"subject_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"input_injections\": [\n {\n \"into\": \"<string>\",\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ],\n \"scope_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"templates\": [\n \"<string>\"\n ],\n \"updates\": [\n {\n \"adapter\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"op_id\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ]\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/conversation-configs/{target_kind}/{target_name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"target_name\": \"<string>\",\n \"greeting_template\": \"<string>\",\n \"multichannel\": false,\n \"state_binding\": {\n \"states\": [\n {\n \"state\": \"<string>\",\n \"subject_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"input_injections\": [\n {\n \"into\": \"<string>\",\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ],\n \"scope_expr\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"templates\": [\n \"<string>\"\n ],\n \"updates\": [\n {\n \"adapter\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"jq\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"op_id\": {\n \"content\": \"<string>\",\n \"id\": \"<string>\",\n \"kwargs\": {}\n },\n \"template_jq\": \"<string>\"\n }\n ]\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"config": {
"target_kind": "agent",
"target_name": "<string>",
"greeting_template": "<string>",
"multichannel": false,
"state_binding": {
"states": [
{
"state": "<string>",
"subject_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"input_injections": [
{
"into": "<string>",
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
],
"scope_expr": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"templates": [
"<string>"
],
"updates": [
{
"adapter": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"jq": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"op_id": {
"content": "<string>",
"id": "<string>",
"kwargs": {}
},
"template_jq": "<string>"
}
]
}
]
}
},
"created": true,
"target_kind": "<string>",
"target_name": "<string>"
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Body
application/json
Per-target configuration for the conversation bridge, keyed by
(target_kind, target_name) — the agent or tool an inbound turn is routed to.
multichannel opts the target into person linking; greeting_template is the
first-contact greeting, which may reference at most the {pairing_code} placeholder
(minted at greeting time). The row carries no server-derived fields, so it IS its own
create payload — no Create/stored split. An unknown {...} placeholder is refused so
a typo cannot render literally; a blank template string is refused, because None is
the explicit spelling for "no greeting". Frozen.
Available options:
agent, tool Minimum string length:
1The optional binding a door carries: one or more :class:StateAttach entries. Frozen.
The same shape is stored on PresetBody/PresetSeed, TargetConversationConfig,
HookRegister and ScheduleCreate, deposited on ToolInvocation through the
ambient dispatch context, and repeated per node by a flow engine.
Show child attributes
Show child attributes
Response
Success.
The created/replaced per-target conversation config.
Show child attributes
Show child attributes