POST/v1/agents

Create an agent

Creates a new agent with its conversation behaviour and optional platform settings. Supply name and conversation_config, including first_message; language is limited to the declared language values.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

Agent configuration. Include name and conversation_config, with first_message inside conversation_config.

namestringrequired
Human-readable name of the agent.
conversation_configobjectrequired
Core conversation behaviour.
platform_settingsobjectoptional
Optional evaluation + widget configuration.
tagsarray<string>optional
Free-form labels.
enabledbooleanoptional
Whether the agent is enabled.
metadataobjectoptional
Free-form JSON metadata (no declared properties).

1 status code
201Returns the created agent object.

Error handling

name and conversation_config are required, and conversation_config.first_message is required within the conversation configuration. conversation_config.language must be one of en, es, fr, or de.