Agents

Create Agent

Create an agent in the key's workspace and return the full record, prompts included.

Requires Idempotency-Key: a retried request with the same key returns the agent created the first time instead of a second one.

post/api/v1/agents

Request

  • Base URL: https://api.dialogbrain.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.dialogbrain.com/api/v1/agents
  • Auth: none declared

Headers

Idempotency-Keystring nullable

Request body

namestring required

Name of the AI agent (1-100 characters)

descriptionstring nullable

Optional description of what this agent does

text_engine'rule_based' | 'agentic' | 'claude_channels' | 'external_agent' nullable

Text-execution engine: 'rule_based', 'ai_assisted', 'agentic' (default), 'claude_channels', or 'external_agent' (the run is handed to an agent outside DialogBrain; needs remote_tool). Voice is derived from triggers, not engine. OMIT to use the default ('agentic').

remote_toolstring nullable

For an external_agent: the integration tool that starts the remote agent.

send_mode'auto' | 'draft' nullable

Default send mode: 'auto' or 'draft'. OMIT to use 'draft' (the default).

prompt_idinteger nullable

ID of the prompt to assign to this agent

template'dm-auto-reply' nullable

Optional template slug to instantiate the agent + its built-in trigger from (deterministic). Use 'dm-auto-reply' for the customer DM auto-reply agent (incoming DM trigger, draft mode). When set, the trigger comes from the template — you don't need agents.trigger_create. OMIT to create a plain agent (no template).

prompt_textstring nullable

The agent's persona and instructions.

model'claude-haiku-4-5-20251001' | 'claude-opus-4-6' | 'claude-sonnet-4-6' | 'claude-sonnet-5' | 'dashscope-glm-5.2' | 'dashscope-glm-5.2-nothink' | 'deepseek-v4-flash' | 'deepseek-v4-flash-nothink' | 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-4o' | 'kimi-k2.6' | 'qwen-flash' | 'qwen-plus' | 'qwen3-vl-plus' | 'qwen3.6-flash' | 'qwen3.6-plus' nullable

The model the agent runs on; omit for the platform default.

max_iterationsinteger nullable

Hard cap on agentic-loop turns per run (1-50). OMIT for the default (10).

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 5 revisions of this API.