Skip to content

MAUQ API

Open interactive API docs Open ReDoc

Base URL

https://api.mauq.xyz/v1

Authentication

Authenticated routes use an HTTP bearer token:

Authorization: Bearer YOUR_API_TOKEN

Tokens belong to a single user_id, usually a Discord user ID.

API tokens are not currently self-service. The only way to request one is through the MAUQ support server. Open a private support ticket and include your intended use case and Discord user ID. Do not request or share API tokens in a public channel.

Permissions and ownership

Resource ownership and token permissions solve different problems:

  • Ownership determines whose queue, rules, blacklist, codes, or settings consume storage limits.
  • Permissions determine whether a token may manage another owner's resource or use administrative routes.

An administrator or service token acting for another user does not move that resource into the service account's quota.

Rate-limit headers

Authenticated responses include:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 99

After the allowance is exhausted, the API responds with 429 and a Retry-After header. Clients should wait for that duration instead of retrying immediately.

Errors

Expected validation, authorization, conflict, and limit failures use normal HTTP status codes. Unexpected server failures return a safe response with a Sentry event ID when capture succeeds:

{
  "detail": "Internal server error",
  "error_id": "0123456789abcdef0123456789abcdef"
}

The event ID is safe to include in a support request. It does not grant access to Sentry.