Create an agent

curl --request POST \
  --url https://api.hq.zone/v1/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "slug": "<string>",
  "aliases": [
    "<string>"
  ],
  "avatar_url": "<string>",
  "cautions": [
    "<string>"
  ],
  "description": "<string>",
  "enabled_mcp_slugs": [
    "<string>"
  ],
  "enabled_skill_slugs": [
    "<string>"
  ],
  "instructions": "<string>",
  "languages": [
    "<string>"
  ],
  "model": "<string>",
  "runtime_profile": "<string>",
  "tone": "<string>",
  "verbosity": "<string>"
}
'

import requests

url = "https://api.hq.zone/v1/agents"

payload = {
    "display_name": "<string>",
    "slug": "<string>",
    "aliases": ["<string>"],
    "avatar_url": "<string>",
    "cautions": ["<string>"],
    "description": "<string>",
    "enabled_mcp_slugs": ["<string>"],
    "enabled_skill_slugs": ["<string>"],
    "instructions": "<string>",
    "languages": ["<string>"],
    "model": "<string>",
    "runtime_profile": "<string>",
    "tone": "<string>",
    "verbosity": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: '<string>',
    slug: '<string>',
    aliases: ['<string>'],
    avatar_url: '<string>',
    cautions: ['<string>'],
    description: '<string>',
    enabled_mcp_slugs: ['<string>'],
    enabled_skill_slugs: ['<string>'],
    instructions: '<string>',
    languages: ['<string>'],
    model: '<string>',
    runtime_profile: '<string>',
    tone: '<string>',
    verbosity: '<string>'
  })
};

fetch('https://api.hq.zone/v1/agents', 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",
  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([
    'display_name' => '<string>',
    'slug' => '<string>',
    'aliases' => [
        '<string>'
    ],
    'avatar_url' => '<string>',
    'cautions' => [
        '<string>'
    ],
    'description' => '<string>',
    'enabled_mcp_slugs' => [
        '<string>'
    ],
    'enabled_skill_slugs' => [
        '<string>'
    ],
    'instructions' => '<string>',
    'languages' => [
        '<string>'
    ],
    'model' => '<string>',
    'runtime_profile' => '<string>',
    'tone' => '<string>',
    'verbosity' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.hq.zone/v1/agents"

	payload := strings.NewReader("{\n  \"display_name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"aliases\": [\n    \"<string>\"\n  ],\n  \"avatar_url\": \"<string>\",\n  \"cautions\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\",\n  \"enabled_mcp_slugs\": [\n    \"<string>\"\n  ],\n  \"enabled_skill_slugs\": [\n    \"<string>\"\n  ],\n  \"instructions\": \"<string>\",\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"model\": \"<string>\",\n  \"runtime_profile\": \"<string>\",\n  \"tone\": \"<string>\",\n  \"verbosity\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.hq.zone/v1/agents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"aliases\": [\n    \"<string>\"\n  ],\n  \"avatar_url\": \"<string>\",\n  \"cautions\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\",\n  \"enabled_mcp_slugs\": [\n    \"<string>\"\n  ],\n  \"enabled_skill_slugs\": [\n    \"<string>\"\n  ],\n  \"instructions\": \"<string>\",\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"model\": \"<string>\",\n  \"runtime_profile\": \"<string>\",\n  \"tone\": \"<string>\",\n  \"verbosity\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hq.zone/v1/agents")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"display_name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"aliases\": [\n    \"<string>\"\n  ],\n  \"avatar_url\": \"<string>\",\n  \"cautions\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\",\n  \"enabled_mcp_slugs\": [\n    \"<string>\"\n  ],\n  \"enabled_skill_slugs\": [\n    \"<string>\"\n  ],\n  \"instructions\": \"<string>\",\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"model\": \"<string>\",\n  \"runtime_profile\": \"<string>\",\n  \"tone\": \"<string>\",\n  \"verbosity\": \"<string>\"\n}"

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>"
}

Agents

Create an agent

Creates a new agent in the caller’s workspace from the supplied slug, display name, and optional description, instructions, personality settings, aliases, runtime profile, model, avatar URL, and initial enabled skill/MCP subsets, returning the created agent. The slug and aliases must be lowercase 2-32 character handles (letters, digits, hyphens), must not use reserved words, and must not collide with another agent in the workspace; if no avatar URL is given one is generated automatically. Admin only.

POST

agents

Create an agent

curl --request POST \
  --url https://api.hq.zone/v1/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "display_name": "<string>",
  "slug": "<string>",
  "aliases": [
    "<string>"
  ],
  "avatar_url": "<string>",
  "cautions": [
    "<string>"
  ],
  "description": "<string>",
  "enabled_mcp_slugs": [
    "<string>"
  ],
  "enabled_skill_slugs": [
    "<string>"
  ],
  "instructions": "<string>",
  "languages": [
    "<string>"
  ],
  "model": "<string>",
  "runtime_profile": "<string>",
  "tone": "<string>",
  "verbosity": "<string>"
}
'

import requests

url = "https://api.hq.zone/v1/agents"

payload = {
    "display_name": "<string>",
    "slug": "<string>",
    "aliases": ["<string>"],
    "avatar_url": "<string>",
    "cautions": ["<string>"],
    "description": "<string>",
    "enabled_mcp_slugs": ["<string>"],
    "enabled_skill_slugs": ["<string>"],
    "instructions": "<string>",
    "languages": ["<string>"],
    "model": "<string>",
    "runtime_profile": "<string>",
    "tone": "<string>",
    "verbosity": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: '<string>',
    slug: '<string>',
    aliases: ['<string>'],
    avatar_url: '<string>',
    cautions: ['<string>'],
    description: '<string>',
    enabled_mcp_slugs: ['<string>'],
    enabled_skill_slugs: ['<string>'],
    instructions: '<string>',
    languages: ['<string>'],
    model: '<string>',
    runtime_profile: '<string>',
    tone: '<string>',
    verbosity: '<string>'
  })
};

fetch('https://api.hq.zone/v1/agents', 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",
  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([
    'display_name' => '<string>',
    'slug' => '<string>',
    'aliases' => [
        '<string>'
    ],
    'avatar_url' => '<string>',
    'cautions' => [
        '<string>'
    ],
    'description' => '<string>',
    'enabled_mcp_slugs' => [
        '<string>'
    ],
    'enabled_skill_slugs' => [
        '<string>'
    ],
    'instructions' => '<string>',
    'languages' => [
        '<string>'
    ],
    'model' => '<string>',
    'runtime_profile' => '<string>',
    'tone' => '<string>',
    'verbosity' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.hq.zone/v1/agents"

	payload := strings.NewReader("{\n  \"display_name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"aliases\": [\n    \"<string>\"\n  ],\n  \"avatar_url\": \"<string>\",\n  \"cautions\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\",\n  \"enabled_mcp_slugs\": [\n    \"<string>\"\n  ],\n  \"enabled_skill_slugs\": [\n    \"<string>\"\n  ],\n  \"instructions\": \"<string>\",\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"model\": \"<string>\",\n  \"runtime_profile\": \"<string>\",\n  \"tone\": \"<string>\",\n  \"verbosity\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.hq.zone/v1/agents")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"aliases\": [\n    \"<string>\"\n  ],\n  \"avatar_url\": \"<string>\",\n  \"cautions\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\",\n  \"enabled_mcp_slugs\": [\n    \"<string>\"\n  ],\n  \"enabled_skill_slugs\": [\n    \"<string>\"\n  ],\n  \"instructions\": \"<string>\",\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"model\": \"<string>\",\n  \"runtime_profile\": \"<string>\",\n  \"tone\": \"<string>\",\n  \"verbosity\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hq.zone/v1/agents")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"display_name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"aliases\": [\n    \"<string>\"\n  ],\n  \"avatar_url\": \"<string>\",\n  \"cautions\": [\n    \"<string>\"\n  ],\n  \"description\": \"<string>\",\n  \"enabled_mcp_slugs\": [\n    \"<string>\"\n  ],\n  \"enabled_skill_slugs\": [\n    \"<string>\"\n  ],\n  \"instructions\": \"<string>\",\n  \"languages\": [\n    \"<string>\"\n  ],\n  \"model\": \"<string>\",\n  \"runtime_profile\": \"<string>\",\n  \"tone\": \"<string>\",\n  \"verbosity\": \"<string>\"\n}"

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

Authorization

string

header

required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Body

application/json

display_name

string

required

slug

string

required

aliases

string[]

avatar_url

string | null

Optional avatar URL - absolute https URL only. Use the /v1/agents/{id}/avatar upload endpoint to host a file in Trove and get back a URL to put here.

cautions

string[]

description

string | null

enabled_mcp_slugs

string[] | null

enabled_skill_slugs

string[] | null

Initial enabled subsets. Pass None (default) for "all installed" - the empty-row convention in agent_skills_enabled / agent_mcp_enabled means "all the tenant has installed".

instructions

string | null

Per-agent system-prompt instructions - what the agent does, scope, tone. NULL/empty = platform-baseline behavior only.

languages

string[]

model

string | null

Optional model slug for this agent (must belong to runtime_profile). Omitted/empty = the runtime's platform default. Billing C.

runtime_profile

string

tone

string | null

Personality knobs - structured-rendering into the system prompt. See agents_api::validate_tone / validate_verbosity / normalise_cautions / normalise_languages for the rules.

verbosity

string | null

Response

The created agent

aliases

string[]

required

cautions

string[]

required

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.

created_at

string<date-time>

required

delivery_mode

string

required

display_name

string

required

string<uuid>

required

instructions_is_default

boolean

required

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.

is_default

boolean

required

languages

string[]

required

BCP-47 language codes. The first is the default; subsequent entries are explicit fallbacks. Empty = no language pin (LLM follows the user's language).

runtime_profile

string

required

slug

string

required

status

string

required

avatar_url

string | null

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).

description

string | null

instructions

string | null

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.

model

string | null

Selected model slug (e.g. claude-opus-4-8). NULL = the runtime's platform default. Must belong to runtime_profile (billing C).

tone

string | null

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".

verbosity

string | null

One of concise | balanced | detailed (or NULL = unset). Drives a canonical "Default to brief / balanced / detailed responses" sentence in the system prompt.

Authentication

Me

Agents

Conversations

Documents

Memory

Tables

Schedules

Notifications

Integrations

Billing

Tokens

Onboarding

Help

Admin

Runs

Search

Create an agent

Authorizations

Body

Response