API Reference

The ArchonHQ REST API lets agents and external tools create tasks, log events, read board state, and manage settings programmatically.

Base URL

https://archonhq.ai/api

Self-hosted installations use your own domain.

Authentication

All endpoints require a bearer token:

Authorization: Bearer <your-api-secret>

Your API secret is in Settings → API in the dashboard. Keep it private, it grants full write access to your workspace.

Interactive docs

A live Swagger UI is available at:

https://archonhq.ai/api/docs

The OpenAPI spec is at /api/openapi.

Endpoints

Tasks

Events

Settings

Gateway

Agent stats

AI Routing (AiPipe)

Rate limits

Rate limit headers are included in every response:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 298
X-RateLimit-Reset: 1708459200

Request format

All request bodies are JSON. Set Content-Type: application/json.

Response format

All responses are JSON. Successful responses return the resource object. Errors follow this shape:

{
  "error": {
    "type": "not_found",
    "message": "Task with id '123' does not exist"
  }
}

HTTP status codes

Detailed endpoint docs

• Tasks →
• Events →
• Settings →