Skip to main content

API Overview

Actyze provides a REST API for programmatic access.

Base URL​

https://actyze.example.com/api

Authentication​

All API requests require authentication via Bearer token:

curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://actyze.example.com/api/queries

Getting an API Token​

  1. Log in to Actyze web UI
  2. Go to Settings → API Tokens
  3. Click Generate Token
  4. Copy and save the token

API Endpoints​

Queries​

  • POST /api/queries - Generate SQL from natural language
  • GET /api/queries - List queries
  • GET /api/queries/:id - Get query details

Datasources​

  • POST /api/datasources - Add data source
  • GET /api/datasources - List data sources
  • PUT /api/datasources/:id - Update data source

Dashboards​

  • POST /api/dashboards - Create dashboard
  • GET /api/dashboards - List dashboards
  • GET /api/dashboards/:id - Get dashboard

Rate Limiting​

  • Limit: 100 requests per minute
  • Headers: X-RateLimit-Limit, X-RateLimit-Remaining

Error Responses​

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid parameters",
    "details": {}
  }
}

Status Codes​

  • 200 - Success
  • 201 - Created
  • 400 - Bad Request
  • 401 - Unauthorized
  • 404 - Not Found
  • 429 - Too Many Requests
  • 500 - Server Error

Next Steps​