Documentation

Technical documentation for the autonomous agentic system that powers Aimee AI Tools Knowledge Base

Available Documentation

Agentic System ⭐

How our autonomous AI agents work together to discover and organize tools

System Architecture

Interactive diagrams showing system components and data flow

API Reference

Complete task-oriented API documentation with examples

Task-Oriented API Reference

Clean, technology-agnostic API endpoints for interacting with our autonomous agent system, pipeline management, and background job processing

API Base URL

https://your-domain.com/api/

All endpoints are relative to this base URL

Task Management API

Create, monitor, and manage individual agent tasks

Create Scraping Task

POST

/api/tasks/scraping

Request Body

{
  "source": "test-source",
  "url": "https://example.com",
  "priority": "medium"
}

Response

{
  "taskId": "scraping-1234567890-abc123",
  "taskType": "scraping",
  "status": "started",
  "statusEndpoint": "/api/tasks/scraping-1234567890-abc123/status",
  "cancelEndpoint": "/api/tasks/scraping-1234567890-abc123/cancel"
}

Check Task Status

GET

/api/tasks/{taskId}/status

Response

{
  "taskId": "scraping-1234567890-abc123",
  "taskType": "scraping",
  "status": "running",
  "progress": 45,
  "currentStep": "scraping",
  "duration": 12000,
  "eventsCount": 3,
  "latestEvents": [
    {
      "type": "progress",
      "message": "Scraping website for tools...",
      "timestamp": 1234567890
    }
  ]
}

Cancel Task

DELETE

/api/tasks/{taskId}/cancel

Response

{
  "message": "Task cancelled successfully",
  "taskId": "scraping-1234567890-abc123",
  "taskType": "scraping",
  "cancellationResult": {
    "wasCancelled": true,
    "wasRunning": true
  }
}

API Design Principles

What makes our task-oriented API different

Technology Agnostic

No technology details in URLs - /api/tasks/scraping instead of /api/langgraph/scrape

Task-Oriented

Organized by what you want to accomplish, not how it's implemented

Universal Status

Consistent status checking across all task types with the same endpoint pattern

Scalable

Easy to add new agent types without breaking existing client integrations