Skip to main content
POST
Create Agent

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Body

application/json
conversation_config
AuthoredConversationalConfigAPIModel · object
required

Conversation configuration for an agent

platform_settings
AgentPlatformSettingsRequestModel · object | null

Platform settings for the agent are all settings that aren't related to the conversation orchestration and content.

workflow
AgentWorkflowRequestModel · object

Workflow for the agent. This is used to define the flow of the conversation and how the agent interacts with tools.

Example:
name
string | null

A name to make the agent easier to find

Example:

"My agent"

tags
string[] | null

Tags to help classify and filter the agent

Example:

Response

Successful Response

agent_id
string
required

ID of the created agent

main_branch_id
string
required

ID of the main branch created for the agent

initial_version_id
string
required

ID of the initial committed version