Skip to main content
POST
Create agent

Authorizations

Authorization
string
header
required

Access token from POST /management/v1/auth/token (publishable-key exchange) or a login session. Publishable-key tokens are agent-scoped and serve the messaging surface; login tokens also serve management.

Path Parameters

projectId
string
required
Pattern: ^[0-9a-fA-F]{24}$

Body

application/json

Create an agent. The owning project comes from the URL path.

name
string
required

Agent name

Required string length: 2 - 50
from_template
string | null

Template agent to clone the new agent from. Omit to use the default template of the environment's default category.

Pattern: ^[0-9a-fA-F]{24}$
runtime_version
string | null

Runtime build (e.g. '0.4.0') to stamp on the versions this create seeds. Omit to inherit the template's own runtime. Caller-supplied only — apollo never resolves a default from the runtime catalog.

Minimum string length: 1

Response

Successful Response

Returns the created agent.

id
string
required

Agent id

Pattern: ^[0-9a-fA-F]{24}$
project_id
string
required

Owning project id

Pattern: ^[0-9a-fA-F]{24}$
name
string
required

Agent name

created_at
string<date-time>
required

Creation timestamp

updated_at
string<date-time>
required

Last update timestamp

live_version_id
string | null

Tag of the currently deployed version; None until deployed

runtime_version
string | null

Runtime build the live version's bundle targets, e.g. '0.8.0'. None when nothing is deployed or the bundle pins no runtime

schema_version
string | null

AUI schema version of the live version's bundle. None until deployed