API Reference

Machine-readable reference

The full API contract is available as an OpenAPI 3.0 document at /docs/api/openapi.yaml — every page here is rendered from it. For LLMs and coding agents, the same reference is available as a single plain-text file at /docs/llm.txt, following the emerging llms.txt convention. Paste it into your coding agent and it can write API calls for you.

Base URL

http://app.aiqaramba.com/api/v1

Authentication

All API requests require a Bearer token in the Authorization header. You can create and manage API keys from your API keys page. The examples on these pages read the key from the AIQA_API_KEY environment variable.

Authorization: Bearer YOUR_API_KEY

Errors

Every API error is returned as an RFC 7807 problem document with Content-Type: application/problem+json. The response body is a JSON object with structured fields:

• title — A short human-readable summary of the problem type, such as "Not Found".
• status — The HTTP status code, repeated from the response status line.
• detail — A human-readable explanation specific to this occurrence of the problem.
• violations — Present only on validation errors; lists each rejected field together with the reason it was rejected.

{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "the test plan failed validation",
  "violations": [
    {
      "field": "steps.login.parents",
      "message": "unknown parent label"
    }
  ]
}

Rate Limits

The API enforces rate limits per IP address. These are intentionally generous since most API usage involves creating and managing entities like projects, tests, and schedules rather than high-frequency polling. You are unlikely to hit these limits during normal usage.

• 30 requests per second per IP address, with a burst allowance of 50 requests that are processed immediately.
• 10 concurrent connections per IP address.
• HTTP 429 Too Many Requests is returned when you exceed the limit. If you do hit it, implement exponential backoff and retry after a short delay.

Resources

Browse endpoints by resource to manage projects, launch agents, run tests, and configure schedules.