curl --request DELETE \
--url https://api.hq.zone/v1/agents/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hq.zone/v1/agents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hq.zone/v1/agents/{id}', 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.hq.zone/v1/agents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hq.zone/v1/agents/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.hq.zone/v1/agents/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hq.zone/v1/agents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"aliases": [
"<string>"
],
"cautions": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"delivery_mode": "<string>",
"display_name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"instructions_is_default": true,
"is_default": true,
"languages": [
"<string>"
],
"runtime_profile": "<string>",
"slug": "<string>",
"status": "<string>",
"avatar_url": "<string>",
"description": "<string>",
"instructions": "<string>",
"model": "<string>",
"tone": "<string>",
"verbosity": "<string>"
}Disable an agent
Disables the named agent by setting its status to disabled so it no longer routes on any surface, and returns the now-disabled agent. The default agent cannot be disabled; promote another agent to default first (returns 400). Returns 404 if the agent is not in the caller’s workspace. Admin only.
curl --request DELETE \
--url https://api.hq.zone/v1/agents/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hq.zone/v1/agents/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hq.zone/v1/agents/{id}', 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.hq.zone/v1/agents/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.hq.zone/v1/agents/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.hq.zone/v1/agents/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hq.zone/v1/agents/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"aliases": [
"<string>"
],
"cautions": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"delivery_mode": "<string>",
"display_name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"instructions_is_default": true,
"is_default": true,
"languages": [
"<string>"
],
"runtime_profile": "<string>",
"slug": "<string>",
"status": "<string>",
"avatar_url": "<string>",
"description": "<string>",
"instructions": "<string>",
"model": "<string>",
"tone": "<string>",
"verbosity": "<string>"
}Authorizations
Personal Access Token. Send as Authorization: Bearer hq_pat_....
Path Parameters
Agent id
Response
The now-disabled agent
Free-form short phrases the agent should avoid talking about. Composed as "Be careful around: X, Y, Z" in the system prompt. Empty = no caution block.
True iff instructions is still the platform-seeded value
(admin hasn't customised or tailored yet). The admin UI uses
this to surface a "your agent is still on the default - click
Tailor" banner. Any PATCH that writes instructions flips
this false; the seed migrations set it true on creation.
BCP-47 language codes. The first is the default; subsequent entries are explicit fallbacks. Empty = no language pin (LLM follows the user's language).
Absolute URL of the avatar shown next to this agent's messages. NULL = use the Slack app's default icon for now (fine for legacy single-agent tenants).
Admin-editable system-prompt for this agent. NULL = use the
platform baseline only (the legacy generalist behaviour).
Plumbed through to router_client::compose_system_prompt
which sandwiches it between the Slack-formatting baseline
and the identity-pin footer.
Selected model slug (e.g. claude-opus-4-8). NULL = the runtime's
platform default. Must belong to runtime_profile (billing C).
One of formal | friendly | direct | casual (or NULL = unset
→ no tone pin in the system prompt). Orthogonal to role;
admin choice, not inferrable from "you're a CFO".
One of concise | balanced | detailed (or NULL = unset).
Drives a canonical "Default to brief / balanced / detailed
responses" sentence in the system prompt.