REST API · v1

API Reference

Control your agent instance programmatically. Trigger tasks, manage agents, read memory, and receive webhooks — all via a clean REST API.

Authentication

All API requests must include your API key in the Authorization header: Authorization: Bearer da_live_xxxxxxxxxxxx

Find your API key in your dashboard under Settings → API Keys. Available on Professional and Enterprise plans.

Base URL

https://api.deployagents.co

Instance

GET
/v1/instance

Get your instance status, uptime, version, and resource usage.

POST
/v1/instance/restart

Gracefully restart your agent instance.

GET
/v1/instance/logs

Stream the last 500 lines of your instance log.

Agents

GET
/v1/agents

List all agents on your instance with their status and configuration.

POST
/v1/agents

Create a new agent with a name, model, and channel assignment.

DELETE
/v1/agents/:id

Remove an agent from your instance.

Tasks

POST
/v1/tasks

Send a task to your agent programmatically. Returns a task ID.

GET
/v1/tasks/:id

Get the result and status of a previously submitted task.

GET
/v1/tasks

List recent tasks with status, duration, and output summary.

Memory

GET
/v1/memory

Retrieve all persistent memory entries for your agent.

POST
/v1/memory

Inject a memory entry directly — useful for pre-loading context.

DELETE
/v1/memory/:id

Delete a specific memory entry by ID.

Webhooks

POST
/v1/webhooks

Register a webhook URL to receive task completion events.

GET
/v1/webhooks

List all registered webhooks.

DELETE
/v1/webhooks/:id

Remove a webhook by ID.

API access requires Professional or Enterprise

Upgrade your plan to get your API key and start automating programmatically.

Get API Access