Skip to main content
Flow AgentsVersion: v3

Create Agent

POST/agent-studio/agent

Creates a new agent with staging version. The agent will be created with an initial staging version that can later be promoted to production.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:agent-studio.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Query Parameters

sourcestring

Origin channel attributed to this write for auditing (e.g. public_api, internal)

Example:api

Body

locationIdstringrequired

Location ID

Example:C2QujeCh8ZnC7al2InWR
namestring

Name of the agent

Example:Customer Support Agent
descriptionstring

Description of the agent

Example:AI agent specialized in handling customer inquiries and support tickets
agencyIdstring

Agency ID

Example:gjL2sFNXJfJYa3d2OYSN
authorIdstring

Author ID

Example:usr_abc123def456
authorNamestring

Author name

Example:John Doe
authorEmailstring

Author email

statusstringrequired

Status of the agent

Available optionsactiveinactivearchived
Example:active
versionobjectrequired

Version data for the agent including nodes, edges, and configuration

nodesstring[]

Nodes array (deprecated, prefer using version.nodes)

Example:[]
edgesstring[]

Edges array (deprecated, prefer using version.edges)

Example:[]

Response

Agent created successfully

successbooleanrequired

Success status

Example:true
messagestringrequired

Response message

Example:Agent created successfully with staging version.
agentobjectrequired

Created agent data with metadata

versionsarrayrequired

Created versions array (initial staging version)