v3
ai-agents

Create AI agent

Create a new AI agent in the current workspace.

post/v3/ai-agents

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Headers

mentium-workspace-idstring nullable

Request body

namestring required

Agent name

descriptionstring nullable

Agent description

agent_typestring

Agent type identifier

type_configobject nullable

Type-specific configuration. Required fields are defined by the agent type registry.

workspace_phone_number_idstring nullable

Assigned workspace phone number ID (phone agents only).

modelstring required

LLM model identifier (e.g. gpt-5.5, claude-sonnet-4-6)

system_prompt_templatestring required

System prompt template with {{variables}}

user_prompt_templatestring nullable

User prompt template with {{variables}}

temperaturenumber nullable

LLM temperature (0-2)

max_tokensinteger nullable

Maximum output tokens

reasoning_effortstring nullable

Reasoning effort level for reasoning models (dynamic, depends on model)

toolsstring[]

List of tool identifiers the agent can use

tool_inputsobject nullable

Agent-side default inputs per tool identifier (tool_identifier -> {param_key -> value}). Soft defaults that travel with the agent; runtime precedence is agent < node < LLM args.

is_activeboolean

Whether the agent is active

Response

Successful Response

idstring required
namestring required
descriptionstring nullable required
agent_typestring required
type_configobject nullable required
workspace_phone_number_idstring nullable
modelstring required
system_prompt_templatestring required
user_prompt_templatestring nullable required
temperaturenumber nullable required
max_tokensinteger nullable required
reasoning_effortstring nullable required
toolsstring[] required
tool_inputsobject nullable

Agent-side default inputs per tool identifier (tool_identifier -> {param_key -> value}). Soft defaults that travel with the agent; runtime precedence is agent < node < LLM args.

automation_tools_countinteger

Number of shared HTTP automation tools bound to this agent.

is_activeboolean required
is_draftboolean
draft_of_idstring nullable
yaml_contentstring nullable
chat_historyobject[] nullable
yaml_historyobject[] nullable
created_atstring date-time required
updated_atstring date-time required
prompt_variablesstring[]

{{variable}} placeholder names found in the agent's prompts (system_prompt_template, user_prompt_template, type_config.first_message). Excludes ElevenLabs system variables (system__*) injected automatically at runtime.

has_draftboolean

True when the agent has unpublished draft changes.

live_revision_idstring nullable

The revision the agent runs

draftobject nullable

Staged draft changes that have not been published yet.

Changes

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