OpenAPI document

OpenAPI 3.1 for Gloom Datasets.

Download openapi.json. Import into Postman, Insomnia or a client generator.

GET https://api.gloom.sh/v1/datasets lists datasets. The API also serves /v1/datasets/openapi.json. Example responses are at each dataset's free sample route, such as https://api.gloom.sh/v1/datasets/gpu/sample.

Schema extensions8

x-dataset: Dataset id.
x-credit-cost: Credits per call.
x-credit-cost-history: Credits with a date range, where different.
x-credit-call-type: Call type, such as lookup, history, search or evidence.
x-credit-multiplier: Dataset class.
x-plans: Plans that can call the route.
x-asof-plans: Plans that can read point in time.
x-sample-url: Static example; no key or account. The response labels illustrative values.

The document's x-plans lists credits, rate and keys, including none: no plan. Dataset routes use different keys from the Gloom API.