Skip to content

POST /v1/agents/import - Import agent from Markdown, YAML, or JSON

POST
/v1/agents/import

Accepts agent definition in multiple formats:

  • Markdown with YAML front matter (if starts with ---)
  • Pure YAML
  • Pure JSON
  • Plain text (treated as system prompt, name auto-generated)
string

Agent imported successfully

Agent configuration for agentic loop. An agent defines the behavior and capabilities of an AI assistant.

object
capabilities

Capabilities enabled for this agent with per-agent configuration. Capabilities add tools and system prompt modifications.

Array<object>

Per-agent capability configuration

Associates a capability with an agent, including optional per-agent configuration. The config field allows the same capability to behave differently per-agent.

object
config

Per-agent configuration for this capability (capability-specific)

ref
required

Reference to the capability ID

string
created_at
required

Timestamp when the agent was created.

string format: date-time
default_model_id

Default LLM model ID for this agent. Can be overridden at the session level.

string | null
Example
model_01933b5a00007000800000000000001
description

Human-readable description of what the agent does.

string | null
id
required

External identifier (agent_<32-hex>). Shown as “id” in API. Client-supplied or auto-generated.

string
Example
agent_01933b5a000070008000000000000001
name
required

Display name of the agent.

string
status
required

Current lifecycle status of the agent.

string
Allowed values: active archived
system_prompt
required

System prompt that defines the agent’s behavior. Sent as the first message in every conversation.

string
tags

Tags for organizing and filtering agents.

Array<string>
updated_at
required

Timestamp when the agent was last updated.

string format: date-time
usage
One of:
null

Invalid format or input exceeds limits

Standard error response for API endpoints.

object
error
required

Error message describing what went wrong.

string

Internal server error

Standard error response for API endpoints.

object
error
required

Error message describing what went wrong.

string