curl --request PUT \
--url https://api.example.com/api/conversations/{route_name}/thread/mode \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"thread_id": "<string>"
}
'import requests
url = "https://api.example.com/api/conversations/{route_name}/thread/mode"
payload = { "thread_id": "<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({thread_id: '<string>'})
};
fetch('https://api.example.com/api/conversations/{route_name}/thread/mode', 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}/thread/mode",
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([
'thread_id' => '<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}/thread/mode"
payload := strings.NewReader("{\n \"thread_id\": \"<string>\"\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/conversations/{route_name}/thread/mode")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"thread_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/conversations/{route_name}/thread/mode")
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 \"thread_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"mode": "<string>",
"route_name": "<string>",
"source": "<string>",
"thread_id": "<string>"
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Set a conversation thread's control mode
Set the per-thread mode override for thread_id on route_name to mode (one
of agent/manual), returning {"route_name", "thread_id", "mode", "source"} with
source always thread — a set writes an override.
This is the door an EXTERNAL/programmatic caller names a thread through; an agent flipping
its OWN live conversation uses the set_conversation_mode builtin instead, which reads
the current thread from the turn context rather than naming it.
Caller authority is the door’s grantable write action. The thread-belongs-to-route
guard is the thread delete’s: a route-keyed id off the route is a 400, a person thread off
the named route a 404. An unknown route is a loud 404; a blank thread_id or a mode
outside the vocabulary is a 400.
curl --request PUT \
--url https://api.example.com/api/conversations/{route_name}/thread/mode \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"thread_id": "<string>"
}
'import requests
url = "https://api.example.com/api/conversations/{route_name}/thread/mode"
payload = { "thread_id": "<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({thread_id: '<string>'})
};
fetch('https://api.example.com/api/conversations/{route_name}/thread/mode', 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}/thread/mode",
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([
'thread_id' => '<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}/thread/mode"
payload := strings.NewReader("{\n \"thread_id\": \"<string>\"\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/conversations/{route_name}/thread/mode")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"thread_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/conversations/{route_name}/thread/mode")
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 \"thread_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"mode": "<string>",
"route_name": "<string>",
"source": "<string>",
"thread_id": "<string>"
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Path Parameters
Body
The mode-set door's JSON body {thread_id, mode}. thread_id holds at least one
non-whitespace character and mode is one of the control-mode vocabulary.
Spec metadata only — the door parses this body at the HTTP edge.
Response
Success.
A per-thread mode override write; source is always thread.
Show child attributes
Show child attributes

