Before you start
You need a Gomry account and an organization with a payment method. Cloud is postpaid and metered: there is no free tier, and an organization with no card on file is refused at the gateway withbilling_required before any work is done. See Billing for why the card comes first.
Make your first request
1
Create a project
A project is the unit of isolation and of spend: keys, enabled APIs, usage and the monthly budget cap all belong to one. Most teams run one per environment —
production and staging — because that is the boundary you want a budget and a key revocation to respect.2
Enable the API on that project
Open Services, pick the one you want and turn it on for the project. Enabling is separate from key scopes on purpose: a key minted with a broad scope still cannot reach an API this project never enabled.
3
Mint a key
Grant it only the scopes you will call. The plaintext key is shown once and never again — store it in your secret manager now. Set a monthly budget on the project at the same time: it is the ceiling on everything this key can spend.
4
Call the API
Send the key as a bearer token. Endpoints take and return JSON. Most are
POST; the ones that read or stop work already started are GET and DELETE.Request
Reading the response
Every response carries anx-request-id header. Log it: it is the one identifier that ties your call to our records of it, and the first thing support will ask for.
Every response body also tells you what it metered — fetches here, pages for an extraction. That field is the quantity that reaches your invoice, in the same payload as the result, so you never have to infer what you were charged.
Response