Updated October 5, 2026

OpenAPI document

The whole API as one OpenAPI 3.1 file, generated from the catalog the API runs on.

Download openapi.json. The API serves the same document at https://api.gloom.sh/v1/datasets/openapi.json. It covers Gloom Datasets only, not the rest of the Gloom API, which takes different keys.

Import it into Postman, Insomnia or a client generator. Each dataset operation also carries:

x-dataset: the dataset id.
x-credit-cost: credits per call.
x-credit-cost-history: credits with a date range, where it differs.
x-credit-call-type: lookup, history, search or evidence.
x-credit-multiplier: the dataset class.
x-plans: plans that can call it.
x-asof-plans: plans that can read point in time.
x-sample-url: the static example response, with synthetic values, no key or account.

The document's own x-plans lists each plan's credits, rate and keys, including none: an account without a plan, which has nothing.