API Reference: Agents

GET /api/v1/agents

Summary: Get Agents

Description: Get Agents

Responses

Example Usage

curl -X 'GET' \
  'http://localhost:8000/api/v1/api/v1/agents' \
  -H 'accept: application/json'

POST /api/v1/agents/templates

Summary: Create Template

Description: Create Template

Request Body

Required: Yes

• Media Type: application/json
• Schema: AgentTemplateCreate (Define in Models)

Responses

Example Usage

curl -X 'POST' \
  'http://localhost:8000/api/v1/api/v1/agents/templates' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST /api/v1/agents/instances

Summary: Create Instance

Description: Create Instance

Request Body

Required: Yes

• Media Type: application/json
• Schema: AgentInstanceCreate (Define in Models)

Responses

Example Usage

curl -X 'POST' \
  'http://localhost:8000/api/v1/api/v1/agents/instances' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{}'

PATCH /api/v1/agents/{id}/status

Summary: Update Status

Description: Update Status

Parameters

Request Body

Required: Yes

• Media Type: application/json
• Schema: AgentInstanceStatusUpdate (Define in Models)

Responses

Example Usage

curl -X 'PATCH' \
  'http://localhost:8000/api/v1/api/v1/agents/{id}/status' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{}'

PATCH /api/v1/agents/{id}/config

Summary: Update Config

Description: Update Config

Parameters

Request Body

Required: Yes

• Media Type: application/json
• Schema: AgentConfigUpdate (Define in Models)

Responses

Example Usage

curl -X 'PATCH' \
  'http://localhost:8000/api/v1/api/v1/agents/{id}/config' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{}'

POST /api/v1/agents/{id}/webhook

Summary: Webhook Receiver

Description: Webhook Receiver

Parameters

Request Body

Required: Yes

• Media Type: application/json

Responses

Example Usage

curl -X 'POST' \
  'http://localhost:8000/api/v1/api/v1/agents/{id}/webhook?token=<token>' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{}'

GET /api/v1/agents/{id}/triggers

Summary: Get Agent Triggers

Description: Get Agent Triggers

Parameters

Responses

Example Usage

curl -X 'GET' \
  'http://localhost:8000/api/v1/api/v1/agents/{id}/triggers' \
  -H 'accept: application/json'

POST /api/v1/agents/{id}/triggers

Summary: Create Agent Trigger

Description: Create Agent Trigger

Parameters

Request Body

Required: Yes

• Media Type: application/json
• Schema: AgentTriggerCreate (Define in Models)

Responses

Example Usage

curl -X 'POST' \
  'http://localhost:8000/api/v1/api/v1/agents/{id}/triggers' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{}'

DELETE /api/v1/agents/triggers/{trigger_id}

Summary: Delete Agent Trigger

Description: Delete Agent Trigger

Parameters

Responses

Example Usage

curl -X 'DELETE' \
  'http://localhost:8000/api/v1/api/v1/agents/triggers/{trigger_id}' \
  -H 'accept: application/json'

GET /api/v1/agents/{id}/telemetry

Summary: Get Telemetry

Description: Get Telemetry

Parameters

Responses

Example Usage

curl -X 'GET' \
  'http://localhost:8000/api/v1/api/v1/agents/{id}/telemetry' \
  -H 'accept: application/json'

GET /api/v1/agents/{id}/dependencies

Summary: Get Dependencies

Description: Get Dependencies

Parameters

Responses

Example Usage

curl -X 'GET' \
  'http://localhost:8000/api/v1/api/v1/agents/{id}/dependencies' \
  -H 'accept: application/json'

POST /api/v1/agents/deploy

Summary: Deploy Agent

Description: One-click agent deployment (Design Doc CUJ 1). Atomically creates: Template → Session → Instance → Locks Session → Injects initial prompt → Starts loop.

Request Body

Required: Yes

• Media Type: application/json
• Schema: DeployAgentRequest (Define in Models)

Responses

Example Usage

curl -X 'POST' \
  'http://localhost:8000/api/v1/api/v1/agents/deploy' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{}'

DELETE /api/v1/agents/{id}

Summary: Delete Agent

Description: Delete Agent

Parameters

Responses

Example Usage

curl -X 'DELETE' \
  'http://localhost:8000/api/v1/api/v1/agents/{id}' \
  -H 'accept: application/json'