Reference

API Reference (REST)

Integrate the AI Agent Automation Platform into your own applications using our structured REST API. All requests and responses use JSON.

Introduction

The platform exposes a REST API (v1) for managing workflows, agents, schedules, documents, teams, webhooks, and more. All authenticated routes require a Bearer token obtained from the login endpoint.

Base URL

http://localhost:5000/api

Authentication

POST/auth/register

POST/auth/login

GET/auth/me

Get the current user profile.

Agents

GET/agents

List all agents for the authenticated user.

POST/agents

Create a new agent.

GET/agents/:id

Get agent details.

PUT/agents/:id

Update an agent.

DELETE/agents/:id

Delete an agent.

POST/agents/:id/run

Send a prompt directly to an agent (playground).

Agent Teams

POST/agent-teams

Create a new agent team.

GET/agent-teams

List agent teams for the user.

POST/agent-teams/:id/run

Run an agent team with an objective.

POST/agent-teams/:teamId/sessions

Create a new team session.

GET/agent-teams/sessions/:sessionId/logs

Get session message logs.

GET/agent-teams/:teamId/discovery

Get team capability discovery.

Workflows

GET/workflows

List workflows for the authenticated user.

POST/workflows

Create a new workflow.

GET/workflows/:id

Get workflow details.

PUT/workflows/:id

Update a workflow.

DELETE/workflows/:id

Delete a workflow.

GET/workflows/:id/export

Export workflow as JSON.

POST/workflows/:id/clone

Clone a workflow.

POST/workflows/:id/run

Trigger a manual workflow execution.

POST/workflows/:id/run-partial

Run a subset of workflow steps.

PUT/workflows/:id/steps

Update workflow steps.

POST/workflows/:id/add-task

Add a task to the workflow.

PUT/workflows/:id/assign-agent

Assign an agent to the workflow.

GET/workflows/:id/versions

List workflow version history.

GET/workflows/:id/versions/:versionId

Get a specific workflow version.

POST/workflows/:id/rollback/:versionId

Rollback workflow to a previous version.

POST/workflows/generate-ai

Generate a workflow from natural language.

GET/workflows/node-definitions

Get available node definitions for the builder.

Tasks

POST/tasks

Create a new task.

GET/tasks

List tasks with pagination.

GET/tasks/:id

Get task details and step results.

PUT/tasks/:id

Update a task.

DELETE/tasks/:id

Delete a task.

POST/tasks/:id/approve

Approve a pending_approval task.

POST/tasks/:id/reject

Reject a pending_approval task.

POST/tasks/:id/resume

Resume a paused task.

POST/tasks/:id/rerun-from-failed

Rerun from the failed step, preserving prior results.

Schedules

POST/schedules

Create a new schedule.

GET/schedules

List schedules for the user.

GET/schedules/:id

Get schedule details.

PUT/schedules/:id

Update a schedule.

DELETE/schedules/:id

Delete a schedule.

Documents

POST/documents/upload

Upload a document for ingestion (multipart/form-data).

GET/documents

List user documents.

GET/documents/:id

Get document metadata.

DELETE/documents/:id

Delete a document and its chunks.

POST/documents/chat

Chat with selected documents using RAG.

Webhooks

POST/webhooks

Create a webhook configuration (private).

GET/webhooks

List webhooks for the user.

DELETE/webhooks/:id

Delete a webhook configuration.

POST/webhook/:source

Public endpoint to receive webhook payloads.

POST/webhook/a2a/:teamId

Public A2A endpoint for external agent messaging.

Templates

GET/templates

List available workflow templates.

GET/templates/:id

Get template details.

GET/templates/:id/validate

Validate a template schema.

POST/templates/import/:id

Import a template as a new workflow.

Insights

GET/insights/summary

Get global insights across all workflows.

GET/insights/workflows/:workflowId

Get insights for a specific workflow.

Memory

GET/memory

List memories for the user, optionally filtered by agent.

GET/memory/agents

List agents with stored memory.

DELETE/memory/:id

Delete a memory entry.

DELETE/memory/agent/:agentId

Clear all memory for an agent.

Logs

GET/logs

List logs with filtering by level, workflow, task, date, and search.

Settings

GET/settings

Get user settings, available providers, and MCP runtime state.

PUT/settings

Update user settings (partial update supported).

System

GET/system/env

Get environment variable status for providers.

GET/system/providers

Get provider discovery with available models.

Assistant

POST/assistant/chat

Send a message to the in-app assistant.

Telemetry

GET/telemetry

Get telemetry state and local metrics.

PUT/telemetry

Enable or disable anonymous telemetry.

MCP

GET/mcp/servers

List configured MCP servers and health.

GET/mcp/tools

List tools exposed by MCP servers.

GET/mcp/health

Check MCP server health.

POST/mcp/tools/:serverId/:toolName/invoke

Invoke an MCP tool directly.

API Keys

GET/keys

List active API keys for the user.

POST/keys

Create a new API key (raw key returned once).

DELETE/keys/:id

Revoke an API key.

Public Workflow APIs

POST/workflows/public/:idOrSlug

Invoke a workflow by ID or custom slug. Auth optional per workflow settings.

Standard Error Response

error-response.json

{
  "ok": false,
  "error": "not_found"
}

Interactive Documentation

The backend does not auto-generate a Swagger UI. Use this reference along with the Postman collection included in the repository for interactive testing.