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 '
{
  "door": "api",
  "execution_key": "<string>",
  "route_name": "<string>",
  "target_name": "<string>",
  "callback_url": "<string>",
  "cancel_expr": {
    "content": "<string>",
    "id": "<string>",
    "kwargs": {}
  },
  "channel": null,
  "extras_expr": {
    "content": "<string>",
    "id": "<string>",
    "kwargs": {}
  },
  "initial_mode": "agent",
  "locale": "<string>",
  "our_identity": null,
  "overlap": {
    "deliver": "one",
    "running": "continue",
    "settle_seconds": 0
  },
  "reply_expr": {
    "content": "<string>",
    "id": "<string>",
    "kwargs": {}
  },
  "reply_texts": {
    "error": "<string>",
    "pairing_code": "<string>",
    "pairing_code_invalid": "<string>",
    "pairing_link_unavailable": "<string>",
    "pairing_linked": "<string>",
    "pairing_not_linked": "<string>",
    "pairing_unlink_unavailable": "<string>",
    "pairing_unlinked": "<string>",
    "rejected_could_not_receive": "<string>",
    "rejected_too_large": "<string>",
    "rejected_unsupported_type": "<string>",
    "slow_down": "<string>"
  },
  "resume_expr": {
    "content": "<string>",
    "id": "<string>",
    "kwargs": {}
  },
  "start_expr": {
    "content": "<string>",
    "id": "<string>",
    "kwargs": {}
  },
  "turns_per_hour_override": 1
}
'

import requests

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

payload = {
    "door": "api",
    "execution_key": "<string>",
    "route_name": "<string>",
    "target_name": "<string>",
    "callback_url": "<string>",
    "cancel_expr": {
        "content": "<string>",
        "id": "<string>",
        "kwargs": {}
    },
    "channel": None,
    "extras_expr": {
        "content": "<string>",
        "id": "<string>",
        "kwargs": {}
    },
    "initial_mode": "agent",
    "locale": "<string>",
    "our_identity": None,
    "overlap": {
        "deliver": "one",
        "running": "continue",
        "settle_seconds": 0
    },
    "reply_expr": {
        "content": "<string>",
        "id": "<string>",
        "kwargs": {}
    },
    "reply_texts": {
        "error": "<string>",
        "pairing_code": "<string>",
        "pairing_code_invalid": "<string>",
        "pairing_link_unavailable": "<string>",
        "pairing_linked": "<string>",
        "pairing_not_linked": "<string>",
        "pairing_unlink_unavailable": "<string>",
        "pairing_unlinked": "<string>",
        "rejected_could_not_receive": "<string>",
        "rejected_too_large": "<string>",
        "rejected_unsupported_type": "<string>",
        "slow_down": "<string>"
    },
    "resume_expr": {
        "content": "<string>",
        "id": "<string>",
        "kwargs": {}
    },
    "start_expr": {
        "content": "<string>",
        "id": "<string>",
        "kwargs": {}
    },
    "turns_per_hour_override": 1
}
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({
    door: 'api',
    execution_key: '<string>',
    route_name: '<string>',
    target_name: '<string>',
    callback_url: '<string>',
    cancel_expr: {content: '<string>', id: '<string>', kwargs: {}},
    channel: null,
    extras_expr: {content: '<string>', id: '<string>', kwargs: {}},
    initial_mode: 'agent',
    locale: '<string>',
    our_identity: null,
    overlap: {deliver: 'one', running: 'continue', settle_seconds: 0},
    reply_expr: {content: '<string>', id: '<string>', kwargs: {}},
    reply_texts: {
      error: '<string>',
      pairing_code: '<string>',
      pairing_code_invalid: '<string>',
      pairing_link_unavailable: '<string>',
      pairing_linked: '<string>',
      pairing_not_linked: '<string>',
      pairing_unlink_unavailable: '<string>',
      pairing_unlinked: '<string>',
      rejected_could_not_receive: '<string>',
      rejected_too_large: '<string>',
      rejected_unsupported_type: '<string>',
      slow_down: '<string>'
    },
    resume_expr: {content: '<string>', id: '<string>', kwargs: {}},
    start_expr: {content: '<string>', id: '<string>', kwargs: {}},
    turns_per_hour_override: 1
  })
};

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([
    'door' => 'api',
    'execution_key' => '<string>',
    'route_name' => '<string>',
    'target_name' => '<string>',
    'callback_url' => '<string>',
    'cancel_expr' => [
        'content' => '<string>',
        'id' => '<string>',
        'kwargs' => [
                
        ]
    ],
    'channel' => null,
    'extras_expr' => [
        'content' => '<string>',
        'id' => '<string>',
        'kwargs' => [
                
        ]
    ],
    'initial_mode' => 'agent',
    'locale' => '<string>',
    'our_identity' => null,
    'overlap' => [
        'deliver' => 'one',
        'running' => 'continue',
        'settle_seconds' => 0
    ],
    'reply_expr' => [
        'content' => '<string>',
        'id' => '<string>',
        'kwargs' => [
                
        ]
    ],
    'reply_texts' => [
        'error' => '<string>',
        'pairing_code' => '<string>',
        'pairing_code_invalid' => '<string>',
        'pairing_link_unavailable' => '<string>',
        'pairing_linked' => '<string>',
        'pairing_not_linked' => '<string>',
        'pairing_unlink_unavailable' => '<string>',
        'pairing_unlinked' => '<string>',
        'rejected_could_not_receive' => '<string>',
        'rejected_too_large' => '<string>',
        'rejected_unsupported_type' => '<string>',
        'slow_down' => '<string>'
    ],
    'resume_expr' => [
        'content' => '<string>',
        'id' => '<string>',
        'kwargs' => [
                
        ]
    ],
    'start_expr' => [
        'content' => '<string>',
        'id' => '<string>',
        'kwargs' => [
                
        ]
    ],
    'turns_per_hour_override' => 1
  ]),
  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  \"door\": \"api\",\n  \"execution_key\": \"<string>\",\n  \"route_name\": \"<string>\",\n  \"target_name\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"cancel_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"channel\": null,\n  \"extras_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"initial_mode\": \"agent\",\n  \"locale\": \"<string>\",\n  \"our_identity\": null,\n  \"overlap\": {\n    \"deliver\": \"one\",\n    \"running\": \"continue\",\n    \"settle_seconds\": 0\n  },\n  \"reply_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"reply_texts\": {\n    \"error\": \"<string>\",\n    \"pairing_code\": \"<string>\",\n    \"pairing_code_invalid\": \"<string>\",\n    \"pairing_link_unavailable\": \"<string>\",\n    \"pairing_linked\": \"<string>\",\n    \"pairing_not_linked\": \"<string>\",\n    \"pairing_unlink_unavailable\": \"<string>\",\n    \"pairing_unlinked\": \"<string>\",\n    \"rejected_could_not_receive\": \"<string>\",\n    \"rejected_too_large\": \"<string>\",\n    \"rejected_unsupported_type\": \"<string>\",\n    \"slow_down\": \"<string>\"\n  },\n  \"resume_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"start_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"turns_per_hour_override\": 1\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  \"door\": \"api\",\n  \"execution_key\": \"<string>\",\n  \"route_name\": \"<string>\",\n  \"target_name\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"cancel_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"channel\": null,\n  \"extras_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"initial_mode\": \"agent\",\n  \"locale\": \"<string>\",\n  \"our_identity\": null,\n  \"overlap\": {\n    \"deliver\": \"one\",\n    \"running\": \"continue\",\n    \"settle_seconds\": 0\n  },\n  \"reply_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"reply_texts\": {\n    \"error\": \"<string>\",\n    \"pairing_code\": \"<string>\",\n    \"pairing_code_invalid\": \"<string>\",\n    \"pairing_link_unavailable\": \"<string>\",\n    \"pairing_linked\": \"<string>\",\n    \"pairing_not_linked\": \"<string>\",\n    \"pairing_unlink_unavailable\": \"<string>\",\n    \"pairing_unlinked\": \"<string>\",\n    \"rejected_could_not_receive\": \"<string>\",\n    \"rejected_too_large\": \"<string>\",\n    \"rejected_unsupported_type\": \"<string>\",\n    \"slow_down\": \"<string>\"\n  },\n  \"resume_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"start_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"turns_per_hour_override\": 1\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  \"door\": \"api\",\n  \"execution_key\": \"<string>\",\n  \"route_name\": \"<string>\",\n  \"target_name\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"cancel_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"channel\": null,\n  \"extras_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"initial_mode\": \"agent\",\n  \"locale\": \"<string>\",\n  \"our_identity\": null,\n  \"overlap\": {\n    \"deliver\": \"one\",\n    \"running\": \"continue\",\n    \"settle_seconds\": 0\n  },\n  \"reply_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"reply_texts\": {\n    \"error\": \"<string>\",\n    \"pairing_code\": \"<string>\",\n    \"pairing_code_invalid\": \"<string>\",\n    \"pairing_link_unavailable\": \"<string>\",\n    \"pairing_linked\": \"<string>\",\n    \"pairing_not_linked\": \"<string>\",\n    \"pairing_unlink_unavailable\": \"<string>\",\n    \"pairing_unlinked\": \"<string>\",\n    \"rejected_could_not_receive\": \"<string>\",\n    \"rejected_too_large\": \"<string>\",\n    \"rejected_unsupported_type\": \"<string>\",\n    \"slow_down\": \"<string>\"\n  },\n  \"resume_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"start_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"turns_per_hour_override\": 1\n}"

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

{
  "data": {
    "callback_secret": "<string>",
    "created": true,
    "route": {
      "door": "api",
      "execution_key": "<string>",
      "execution_key_fingerprint": "<string>",
      "route_name": "<string>",
      "target_kind": "agent",
      "target_name": "<string>",
      "callback_url": "<string>",
      "cancel_expr": {},
      "channel": null,
      "extras_expr": {},
      "initial_mode": "agent",
      "locale": "<string>",
      "our_identity": null,
      "overlap": {
        "deliver": "one",
        "running": "continue",
        "settle_seconds": 0
      },
      "reply_expr": {},
      "reply_texts": {
        "error": "<string>",
        "pairing_code": "<string>",
        "pairing_code_invalid": "<string>",
        "pairing_link_unavailable": "<string>",
        "pairing_linked": "<string>",
        "pairing_not_linked": "<string>",
        "pairing_unlink_unavailable": "<string>",
        "pairing_unlinked": "<string>",
        "rejected_could_not_receive": "<string>",
        "rejected_too_large": "<string>",
        "rejected_unsupported_type": "<string>",
        "slow_down": "<string>"
      },
      "resume_expr": {},
      "start_expr": {},
      "turns_per_hour_override": 1
    },
    "route_name": "<string>"
  }
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

conversations

Create or replace a conversation route

Create a conversation route from its flat parameters — an UPSERT (create AND edit path).

initial_mode is the route’s default control mode (agent runs the turn, manual suppresses it for an operator to answer) when a thread carries no per-thread override.

target_name must merely EXIST — the agent (target_kind=agent) or tool (target_kind=tool) — the key’s live grants bound the turn at fire. A channel row must name a channel a plugin registered on this deployment (400 otherwise). 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 are decided at this door BEFORE the route write service runs the route’s own rules, so a refusal leaves any existing row untouched. The write service runs the target’s bind check (a refusal is a 422 carrying its lines), then renders and compiles the door jqs (start_expr/cancel_expr/resume_expr/extras_expr) and reply_expr, so an invalid one — or a text whose stored resource cannot be fetched, or that cannot be rendered — is refused at create, not at first message. A channel row’s our_identity is stored canonicalized and must not already be routed on that channel. An edit that would change the door of a route already HOLDING threads is refused: the two doors key their threads differently, so the held threads cannot be re-keyed under the new door. An api row that declares a callback_url has its callback_secret minted by the write and returned ONCE; a poll-only api row (no callback) mints none and reads its answers back from the poll door. A positive turns_per_hour_override runs this route’s per-address buckets at that rate instead of the global per_address_turns_per_hour cap; None runs them at the global rate. A reply_texts catalogue carries the route’s own words for the platform’s fixed participant replies (a failed turn, the slow-down line, the pairing replies, the inbound refusal notices), in the line’s language; None or an unset member sends the built-in English reply. A locale is the operator-declared default language templated reply parts render in when a turn supplies none; it is the last fallback under a per-turn or stored-contact locale and is stored canonicalized. None declares no route default (bare/English). An overlap policy governs how a running turn treats the newer participant messages that overlap it (learn/cancel/carry); None stores the default policy (continue/one/no window), which runs one turn per message and leaves the payload unchanged. 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 '
{
  "door": "api",
  "execution_key": "<string>",
  "route_name": "<string>",
  "target_name": "<string>",
  "callback_url": "<string>",
  "cancel_expr": {
    "content": "<string>",
    "id": "<string>",
    "kwargs": {}
  },
  "channel": null,
  "extras_expr": {
    "content": "<string>",
    "id": "<string>",
    "kwargs": {}
  },
  "initial_mode": "agent",
  "locale": "<string>",
  "our_identity": null,
  "overlap": {
    "deliver": "one",
    "running": "continue",
    "settle_seconds": 0
  },
  "reply_expr": {
    "content": "<string>",
    "id": "<string>",
    "kwargs": {}
  },
  "reply_texts": {
    "error": "<string>",
    "pairing_code": "<string>",
    "pairing_code_invalid": "<string>",
    "pairing_link_unavailable": "<string>",
    "pairing_linked": "<string>",
    "pairing_not_linked": "<string>",
    "pairing_unlink_unavailable": "<string>",
    "pairing_unlinked": "<string>",
    "rejected_could_not_receive": "<string>",
    "rejected_too_large": "<string>",
    "rejected_unsupported_type": "<string>",
    "slow_down": "<string>"
  },
  "resume_expr": {
    "content": "<string>",
    "id": "<string>",
    "kwargs": {}
  },
  "start_expr": {
    "content": "<string>",
    "id": "<string>",
    "kwargs": {}
  },
  "turns_per_hour_override": 1
}
'

import requests

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

payload = {
    "door": "api",
    "execution_key": "<string>",
    "route_name": "<string>",
    "target_name": "<string>",
    "callback_url": "<string>",
    "cancel_expr": {
        "content": "<string>",
        "id": "<string>",
        "kwargs": {}
    },
    "channel": None,
    "extras_expr": {
        "content": "<string>",
        "id": "<string>",
        "kwargs": {}
    },
    "initial_mode": "agent",
    "locale": "<string>",
    "our_identity": None,
    "overlap": {
        "deliver": "one",
        "running": "continue",
        "settle_seconds": 0
    },
    "reply_expr": {
        "content": "<string>",
        "id": "<string>",
        "kwargs": {}
    },
    "reply_texts": {
        "error": "<string>",
        "pairing_code": "<string>",
        "pairing_code_invalid": "<string>",
        "pairing_link_unavailable": "<string>",
        "pairing_linked": "<string>",
        "pairing_not_linked": "<string>",
        "pairing_unlink_unavailable": "<string>",
        "pairing_unlinked": "<string>",
        "rejected_could_not_receive": "<string>",
        "rejected_too_large": "<string>",
        "rejected_unsupported_type": "<string>",
        "slow_down": "<string>"
    },
    "resume_expr": {
        "content": "<string>",
        "id": "<string>",
        "kwargs": {}
    },
    "start_expr": {
        "content": "<string>",
        "id": "<string>",
        "kwargs": {}
    },
    "turns_per_hour_override": 1
}
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({
    door: 'api',
    execution_key: '<string>',
    route_name: '<string>',
    target_name: '<string>',
    callback_url: '<string>',
    cancel_expr: {content: '<string>', id: '<string>', kwargs: {}},
    channel: null,
    extras_expr: {content: '<string>', id: '<string>', kwargs: {}},
    initial_mode: 'agent',
    locale: '<string>',
    our_identity: null,
    overlap: {deliver: 'one', running: 'continue', settle_seconds: 0},
    reply_expr: {content: '<string>', id: '<string>', kwargs: {}},
    reply_texts: {
      error: '<string>',
      pairing_code: '<string>',
      pairing_code_invalid: '<string>',
      pairing_link_unavailable: '<string>',
      pairing_linked: '<string>',
      pairing_not_linked: '<string>',
      pairing_unlink_unavailable: '<string>',
      pairing_unlinked: '<string>',
      rejected_could_not_receive: '<string>',
      rejected_too_large: '<string>',
      rejected_unsupported_type: '<string>',
      slow_down: '<string>'
    },
    resume_expr: {content: '<string>', id: '<string>', kwargs: {}},
    start_expr: {content: '<string>', id: '<string>', kwargs: {}},
    turns_per_hour_override: 1
  })
};

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([
    'door' => 'api',
    'execution_key' => '<string>',
    'route_name' => '<string>',
    'target_name' => '<string>',
    'callback_url' => '<string>',
    'cancel_expr' => [
        'content' => '<string>',
        'id' => '<string>',
        'kwargs' => [
                
        ]
    ],
    'channel' => null,
    'extras_expr' => [
        'content' => '<string>',
        'id' => '<string>',
        'kwargs' => [
                
        ]
    ],
    'initial_mode' => 'agent',
    'locale' => '<string>',
    'our_identity' => null,
    'overlap' => [
        'deliver' => 'one',
        'running' => 'continue',
        'settle_seconds' => 0
    ],
    'reply_expr' => [
        'content' => '<string>',
        'id' => '<string>',
        'kwargs' => [
                
        ]
    ],
    'reply_texts' => [
        'error' => '<string>',
        'pairing_code' => '<string>',
        'pairing_code_invalid' => '<string>',
        'pairing_link_unavailable' => '<string>',
        'pairing_linked' => '<string>',
        'pairing_not_linked' => '<string>',
        'pairing_unlink_unavailable' => '<string>',
        'pairing_unlinked' => '<string>',
        'rejected_could_not_receive' => '<string>',
        'rejected_too_large' => '<string>',
        'rejected_unsupported_type' => '<string>',
        'slow_down' => '<string>'
    ],
    'resume_expr' => [
        'content' => '<string>',
        'id' => '<string>',
        'kwargs' => [
                
        ]
    ],
    'start_expr' => [
        'content' => '<string>',
        'id' => '<string>',
        'kwargs' => [
                
        ]
    ],
    'turns_per_hour_override' => 1
  ]),
  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  \"door\": \"api\",\n  \"execution_key\": \"<string>\",\n  \"route_name\": \"<string>\",\n  \"target_name\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"cancel_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"channel\": null,\n  \"extras_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"initial_mode\": \"agent\",\n  \"locale\": \"<string>\",\n  \"our_identity\": null,\n  \"overlap\": {\n    \"deliver\": \"one\",\n    \"running\": \"continue\",\n    \"settle_seconds\": 0\n  },\n  \"reply_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"reply_texts\": {\n    \"error\": \"<string>\",\n    \"pairing_code\": \"<string>\",\n    \"pairing_code_invalid\": \"<string>\",\n    \"pairing_link_unavailable\": \"<string>\",\n    \"pairing_linked\": \"<string>\",\n    \"pairing_not_linked\": \"<string>\",\n    \"pairing_unlink_unavailable\": \"<string>\",\n    \"pairing_unlinked\": \"<string>\",\n    \"rejected_could_not_receive\": \"<string>\",\n    \"rejected_too_large\": \"<string>\",\n    \"rejected_unsupported_type\": \"<string>\",\n    \"slow_down\": \"<string>\"\n  },\n  \"resume_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"start_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"turns_per_hour_override\": 1\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  \"door\": \"api\",\n  \"execution_key\": \"<string>\",\n  \"route_name\": \"<string>\",\n  \"target_name\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"cancel_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"channel\": null,\n  \"extras_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"initial_mode\": \"agent\",\n  \"locale\": \"<string>\",\n  \"our_identity\": null,\n  \"overlap\": {\n    \"deliver\": \"one\",\n    \"running\": \"continue\",\n    \"settle_seconds\": 0\n  },\n  \"reply_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"reply_texts\": {\n    \"error\": \"<string>\",\n    \"pairing_code\": \"<string>\",\n    \"pairing_code_invalid\": \"<string>\",\n    \"pairing_link_unavailable\": \"<string>\",\n    \"pairing_linked\": \"<string>\",\n    \"pairing_not_linked\": \"<string>\",\n    \"pairing_unlink_unavailable\": \"<string>\",\n    \"pairing_unlinked\": \"<string>\",\n    \"rejected_could_not_receive\": \"<string>\",\n    \"rejected_too_large\": \"<string>\",\n    \"rejected_unsupported_type\": \"<string>\",\n    \"slow_down\": \"<string>\"\n  },\n  \"resume_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"start_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"turns_per_hour_override\": 1\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  \"door\": \"api\",\n  \"execution_key\": \"<string>\",\n  \"route_name\": \"<string>\",\n  \"target_name\": \"<string>\",\n  \"callback_url\": \"<string>\",\n  \"cancel_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"channel\": null,\n  \"extras_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"initial_mode\": \"agent\",\n  \"locale\": \"<string>\",\n  \"our_identity\": null,\n  \"overlap\": {\n    \"deliver\": \"one\",\n    \"running\": \"continue\",\n    \"settle_seconds\": 0\n  },\n  \"reply_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"reply_texts\": {\n    \"error\": \"<string>\",\n    \"pairing_code\": \"<string>\",\n    \"pairing_code_invalid\": \"<string>\",\n    \"pairing_link_unavailable\": \"<string>\",\n    \"pairing_linked\": \"<string>\",\n    \"pairing_not_linked\": \"<string>\",\n    \"pairing_unlink_unavailable\": \"<string>\",\n    \"pairing_unlinked\": \"<string>\",\n    \"rejected_could_not_receive\": \"<string>\",\n    \"rejected_too_large\": \"<string>\",\n    \"rejected_unsupported_type\": \"<string>\",\n    \"slow_down\": \"<string>\"\n  },\n  \"resume_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"start_expr\": {\n    \"content\": \"<string>\",\n    \"id\": \"<string>\",\n    \"kwargs\": {}\n  },\n  \"turns_per_hour_override\": 1\n}"

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

{
  "data": {
    "callback_secret": "<string>",
    "created": true,
    "route": {
      "door": "api",
      "execution_key": "<string>",
      "execution_key_fingerprint": "<string>",
      "route_name": "<string>",
      "target_kind": "agent",
      "target_name": "<string>",
      "callback_url": "<string>",
      "cancel_expr": {},
      "channel": null,
      "extras_expr": {},
      "initial_mode": "agent",
      "locale": "<string>",
      "our_identity": null,
      "overlap": {
        "deliver": "one",
        "running": "continue",
        "settle_seconds": 0
      },
      "reply_expr": {},
      "reply_texts": {
        "error": "<string>",
        "pairing_code": "<string>",
        "pairing_code_invalid": "<string>",
        "pairing_link_unavailable": "<string>",
        "pairing_linked": "<string>",
        "pairing_not_linked": "<string>",
        "pairing_unlink_unavailable": "<string>",
        "pairing_unlinked": "<string>",
        "rejected_could_not_receive": "<string>",
        "rejected_too_large": "<string>",
        "rejected_unsupported_type": "<string>",
        "slow_down": "<string>"
      },
      "resume_expr": {},
      "start_expr": {},
      "turns_per_hour_override": 1
    },
    "route_name": "<string>"
  }
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Authorizations

x-api-key

string

header

required

Path Parameters

route_name

string

required

Body

application/json

ApiConversationRouteCreate
ChannelConversationRouteCreate

An api route: answers by signed callback to callback_url when set, else by the poll door.

door

string

required

Allowed value: "api"

execution_key

string

required

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

Minimum string length: 1

route_name

string

required

Pattern: ^[a-z0-9-]+$

target_kind

enum<string>

required

Available options:

agent,

tool

target_name

string

required

Minimum string length: 1

callback_url

string | null

Pattern: ^[hH][tT][tT][pP][sS]://[^/?#@]+(?:[/?#]|$)

cancel_expr

TemplatedText · object | null

A renderable text: its source plus the parameters its render takes.

EXACTLY ONE source is set — content (the text inline) or id (the id of a stored resource holding the text); neither and both are refused at construction. kwargs are the render parameters for the TEXT and apply either way, so moving a text from inline to stored (or back) leaves its parameters untouched.

Show child attributes

channel

null

extras_expr

TemplatedText · object | null

A renderable text: its source plus the parameters its render takes.

Show child attributes

initial_mode

enum<string>

default:agent

Available options:

agent,

manual

locale

string | null

our_identity

null

overlap

OverlapPolicy · object

How a route treats a running turn and the newer participant messages that overlap it.

Governs participant MESSAGE turns on one thread only (origin="client", inbound_kind="message"); an event turn always runs as its own turn. Two knobs and a window:

running — what happens to the turn in flight when a newer message is accepted: continue leaves it running (one turn per message), cancel cancels it cooperatively in favour of the newer message.
deliver — what a turn carries: one exactly one message per turn, all every message accepted since the last turn started, in order, as one turn.
settle_seconds — a turn starts no earlier than this many seconds after its lead message was accepted, so a burst inside the window rides in one turn. 0 disables it.

The default policy (continue/one/0) runs one turn per message and leaves the payload unchanged. Frozen.

Show child attributes

reply_expr

TemplatedText · object | null

A renderable text: its source plus the parameters its render takes.

Show child attributes

reply_texts

ReplyTexts · object | null

The caller's words for the platform's fixed participant replies on one route. Frozen, strict keys.

error is sent when a turn fails and the target gave no reply; slow_down when an address is over the turn cap; pairing_linked when a pair code was redeemed and the two persons merged; pairing_unlinked when /unlink detached the address; pairing_not_linked when /unlink came from an address linked to nothing; pairing_code_invalid when a redeem was refused; pairing_code is the /link reply carrying the fresh code, a template that MUST reference {pairing_code} and may reference {expires_at} (the code's ISO-8601 expiry), with no conversion or format spec; pairing_link_unavailable when a redeem met a person being erased (its code is consumed, so the reply asks for a new one); pairing_unlink_unavailable when /unlink met the sender's person being erased; rejected_unsupported_type / rejected_too_large / rejected_could_not_receive are the notices for an inbound message the channel cannot bridge, a file over the cap, and a file the channel could not fetch. Every member but pairing_code is literal text: a { in it is drawn as written. Each is a :data:~tai42_contract.interactions.ReplyText in the line's language; absent, the built-in English reply is sent. An empty catalogue names nothing and is refused; an unknown key is refused.

Show child attributes

resume_expr

TemplatedText · object | null

A renderable text: its source plus the parameters its render takes.

Show child attributes

start_expr

TemplatedText · object | null

A renderable text: its source plus the parameters its render takes.

Show child attributes

turns_per_hour_override

integer | null

Required range: x > 0

Response

Success.

data

ConversationRouteCreateResult · object

required

The created/replaced route.

callback_secret is the api-door callback signing secret surfaced ONCE (null for a channel route); route is the stored view with its secret stripped.

Show child attributes

HTTP API

CLI

Settings

Capability map

Conversation bridge

Python SDK

Studio SDK

Create or replace a conversation route

Authorizations

Path Parameters

Body

Response