Agents API
Manage agent definitions including protocols and prompts.
List Agents
Get all agents in the project.
text
Response
json
Example
bash
Get Agent
Get a single agent by ID or slug.
text
Response
json
Example
bash
Create Agent
Create a new agent.
text
Request Body
json
| Field | Type | Required | Description |
|---|---|---|---|
settings.slug | string | Yes | URL-safe identifier |
settings.name | string | Yes | Display name |
settings.description | string | No | Agent description |
settings.format | string | Yes | interactive or generation |
protocol | string | Yes | YAML protocol definition |
prompts | array | Yes | Prompt files |
Response
json
Example
bash
Update Agent
Update an existing agent.
text
Request Body
json
All fields are optional. Only provided fields are updated.
Response
json
Example
bash
Sync Agent
The Server SDK provides a sync method that creates or updates an agent:
typescript
This is useful for CI/CD pipelines to deploy agent updates.