Skip to main content
POST
Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.
Create a custom agent. Configurations stick until deleted. Use PATCH to flip is_active rather than re-creating to preserve audit history.

Request body

CustomAgentRequest
string
required
Human-readable agent name (≤128 chars). Minimum length: 1. Maximum length: 128.
string,null
Free-form description (≤4 KB). Surfaces in the dashboard list view. Maximum length: 4096.
string,null
Text appended to the platform’s default system prompt for this agent’s runs (≤16 KB). Use to give the agent persistent persona or domain-specific instructions. Maximum length: 16384.
string
Tag for this agent’s runs; default ‘custom’. Free-form. Default: 'custom'. Maximum length: 64.
string[]
Skill IDs or names to register on each run (≤100 entries). Maximum items: 100.
string[]
Allow-list of tool names this agent may use; empty = full default tool set. Useful for sandboxing untrusted prompts. Maximum items: 100.
object
Params merged into every /trigger call invoking this agent.
object
Optional trigger metadata — e.g. {type: 'scheduled', cron: '0 9 * * *'}. Free-form; the worker reads documented keys.

Response

CustomAgentSummary
string
required
string
required
string,null
required
string,null
required
string
required
string[]
required
string[]
required
object
required
object
required
boolean
required
boolean
required
string
required
string
required

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on September 21, 2026