API Reference

Agents API

List agents

GET /api/agents

Returns the workspace's agents with their status, category, and bound integration.

Create an agent

POST /api/agents
Field Type Notes
name string required
category string required — one of the agent categories
integrationName string optional — system to connect

Returns 201 with the created agent. The agent starts in deploying status. Fails with 402 if your plan's agent limit is reached.

Get / update / remove an agent

GET    /api/agents/:id
PATCH  /api/agents/:id
DELETE /api/agents/:id

PATCH accepts name and status (to pause/resume). DELETE removes the agent; its historical operations remain in the activity log.

All endpoints return 404 for agents that exist but belong to another workspace — IDs are never disclosed across workspace boundaries.

Request a demo

See Anysola agents in action with your enterprise data.