Skip to content

Overview

The Qualia API, defined in protobuf as qualia.v1. Every resource lives under /v1/accounts/{account}, where {account} is your account id, a lowercase UUID.

Base URL: https://dev-api.qualiastudios.dev

Authenticate with an API key in the X-API-Key header. Create one in Settings in the Qualia dashboard. GET calls need the key’s data:read scope; every other call needs data:write.

Every call is also served over Connect at POST /qualia.v1.<Service>/<Method>.

A call the API refuses returns the gRPC code name in upper case, for example {"code": "NOT_FOUND", "message": "…", "retryable": false, "details": []}. Another account’s resources answer NOT_FOUND. retryable is true for ABORTED, UNAVAILABLE, RESOURCE_EXHAUSTED, DEADLINE_EXCEEDED and CANCELED.

A request the gateway stops before it reaches the API has a different body: {"detail": "…"}. For example: a missing or invalid API key (401), a key without the scope or the resources the call needs (403 or 404), an environment closed to you (403), or a body over the size limit (413). Read code if the body has one, otherwise detail.

Information

  • OpenAPI version: 3.0.3

Security scheme type: apiKey

Header parameter name: X-API-Key