Create or replace a conversation route

curl --request POST \
  --url https://api.example.com/api/conversations/{route_name} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agent_name": "<string>",
  "execution_key": "<string>",
  "route_name": "<string>",
  "callback_url": "<string>",
  "channel": "<string>",
  "our_identity": "<string>"
}
'

import requests

url = "https://api.example.com/api/conversations/{route_name}"

payload = {
    "agent_name": "<string>",
    "execution_key": "<string>",
    "route_name": "<string>",
    "callback_url": "<string>",
    "channel": "<string>",
    "our_identity": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_name: '<string>',
    execution_key: '<string>',
    route_name: '<string>',
    callback_url: '<string>',
    channel: '<string>',
    our_identity: '<string>'
  })
};

fetch('https://api.example.com/api/conversations/{route_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/conversations/{route_name}",
  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_name' => '<string>',
    'execution_key' => '<string>',
    'route_name' => '<string>',
    'callback_url' => '<string>',
    'channel' => '<string>',
    'our_identity' => '<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/conversations/{route_name}"

	payload := strings.NewReader("{\n  \"agent_name\": \"<string>\",\n  \"execution_key\": \"<string>\",\n  \"route_name\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"our_identity\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.example.com/api/conversations/{route_name}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_name\": \"<string>\",\n  \"execution_key\": \"<string>\",\n  \"route_name\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"our_identity\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/conversations/{route_name}")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_name\": \"<string>\",\n  \"execution_key\": \"<string>\",\n  \"route_name\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"our_identity\": \"<string>\"\n}"

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

{
  "data": "<unknown>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

conversations

Create or replace a conversation route

Create a conversation route from its flat parameters — an UPSERT, so this is the create path AND the edit path for a route of that name.

execution_key is the api-key identity the turn runs AS; the caller must be allowed to delegate it and it must be usable by a tokenless fire, both decided BEFORE the write so a refusal leaves any existing row untouched. agent_name must merely EXIST — the key’s live grants bound the turn at fire. A channel row’s our_identity is stored canonicalized and must not already be routed on that channel. An api row’s callback_secret is minted here and returned ONCE. Returns {"created", "route_name", "route", "callback_secret"}.

POST

api

conversations

{route_name}

Create or replace a conversation route

curl --request POST \
  --url https://api.example.com/api/conversations/{route_name} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agent_name": "<string>",
  "execution_key": "<string>",
  "route_name": "<string>",
  "callback_url": "<string>",
  "channel": "<string>",
  "our_identity": "<string>"
}
'

import requests

url = "https://api.example.com/api/conversations/{route_name}"

payload = {
    "agent_name": "<string>",
    "execution_key": "<string>",
    "route_name": "<string>",
    "callback_url": "<string>",
    "channel": "<string>",
    "our_identity": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_name: '<string>',
    execution_key: '<string>',
    route_name: '<string>',
    callback_url: '<string>',
    channel: '<string>',
    our_identity: '<string>'
  })
};

fetch('https://api.example.com/api/conversations/{route_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/conversations/{route_name}",
  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_name' => '<string>',
    'execution_key' => '<string>',
    'route_name' => '<string>',
    'callback_url' => '<string>',
    'channel' => '<string>',
    'our_identity' => '<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/conversations/{route_name}"

	payload := strings.NewReader("{\n  \"agent_name\": \"<string>\",\n  \"execution_key\": \"<string>\",\n  \"route_name\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"our_identity\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.example.com/api/conversations/{route_name}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_name\": \"<string>\",\n  \"execution_key\": \"<string>\",\n  \"route_name\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"our_identity\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/conversations/{route_name}")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_name\": \"<string>\",\n  \"execution_key\": \"<string>\",\n  \"route_name\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"channel\": \"<string>\",\n  \"our_identity\": \"<string>\"\n}"

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

{
  "data": "<unknown>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

x-api-key

string

header

required

Path Parameters

route_name

string

required

Body

application/json

The client-facing create/edit body for a conversation route: the fields a caller supplies.

Binds an agent_name to an execution_key the turn runs AS (bound with pass-role at create). api rows carry an https callback_url; channel rows carry the registry channel plus the our_identity the medium is texted at (N rows may share a channel, each its own identity). The server-derived callback_secret and execution_key_fingerprint are deliberately absent; :class:ConversationRoute is this shape plus those. Frozen.

agent_name

string

required

Minimum string length: 1

door

enum<string>

required

Available options:

api,

channel

execution_key

string

required

The api-key user_id the turn runs AS; its live stored grants authorize the agent run and every tool call the turn makes.

Minimum string length: 1

route_name

string

required

callback_url

string | null

channel

string | null

our_identity

string | null

Response

Success.

data

any

required

Get a conversation route Delete a conversation route

HTTP API

CLI

Settings

Conversation bridge

Python SDK

Catalog

Studio SDK

Create or replace a conversation route

Authorizations

Path Parameters

Body

Response