AI Agent Automation
Reference

API Reference (REST)

Integrate the AI Agent Automation Platform into your own applications using our structured REST API.

Introduction

The platform exposes a versioned REST API (v1) for managing workflows, agents, schedules, and documents. All requests and responses use JSON.

Base URL

http://localhost:5000/api/v1

Workflows

GET/workflows
List all workflow definitions.
POST/workflows
Create a new workflow definition.
GET/workflows/:id
Get details of a specific workflow.
POST/workflows/run
Trigger a manual execution of a workflow.

Agents

GET/agents
List all registered agent profiles.
POST/agents
Register or update an agent profile.
POST/agents/chat
Send a direct prompt to an agent.

Documents (RAG)

POST/documents/upload
Upload and ingest a PDF or text file.
GET/documents/:id
Get ingestion status and metadata.
POST/documents/query
Perform semantic search across documents.

Standard Error Response

error-response.json
{
  "success": false,
  "error": {
    "code": "WORKFLOW_NOT_FOUND",
    "message": "The requested workflow ID does not exist.",
    "details": { "workflow_id": "wf_123" }
  }
}

Interactive Documentation

The backend automatically generates a Swagger / OpenAPI UI. When the server is running in development mode, you can access it at http://localhost:5000/api-docs to test endpoints directly.