Create an AI agent
POST/ai-agents
Create an AI agent. ⚠️ This may charge the card on file — an AI agent costs
a seat exactly as a human one does, with the same 402 /
code: seat_charge_failed behaviour and the same rollback.
Every field the console's AI agent editor offers is accepted and passed through: persona, instructions, model, language, the knowledge bases it may answer from, the inboxes it works in and its hand-off rules. Unknown fields are rejected rather than silently dropped.
Request
Responses
- 201
- 400
- 401
- 402
- 403
AI agent created.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
The request was malformed, or a parameter was rejected.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
No token, an expired token, or a credential that has been revoked.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
A plan ceiling or a locked feature stopped an otherwise valid request.
Response Headers
Correlation id for this request. Quote it when reporting a problem.
Refused. Either the credential does not hold the scope this endpoint needs (code: insufficient_scope), or the account's IP allow-list does not include the calling address (code: ip_not_allowed).
Response Headers
Correlation id for this request. Quote it when reporting a problem.