Skip to main content

API Overview

Documentation​

Interactive API documentation is available at /api/docs using Swagger UI. You can explore all endpoints, view request/response schemas, and test API calls directly from your browser.

API Keys​

API keys allow programmatic access to qui without using session cookies. Create and manage them in Settings → API Keys.

Include your API key in the X-API-Key header:

curl -H "X-API-Key: YOUR_API_KEY_HERE" \
  http://localhost:7476/api/instances

Security Notes​

  • API keys are shown only once when created - save them securely
  • Each key can be individually revoked without affecting others
  • Keys have the same permissions as the main user account