Get started in four steps.
Create an account, turn on an API, make a key and call it. The console shows the same steps on every new project.
From nothing to a first call.
Create an account
Then open Cloud. An organization and a first project are made for you.
Turn on an API
In APIs and services → Library, or by putting a bundle on the project.
Make a key
In Credentials. Copy the secret now: it is shown once.
Call it
Send the key as a Bearer token. The dashboard shows the traffic within seconds.
Send the key in a header.
Use Authorization: Bearer, or X-API-Key. The api_key parameter still works, but avoid it: addresses end up in logs.
- Paths, request bodies and responses are listed in OpenAPI
- One API’s document: /api/cloud/openapi/{code}.json
- Every API: /api/cloud/openapi.json
curl "https://cloud.broos.io/api/cloud/weather/now?lat=-15.4&lon=28.3" \ -H "Authorization: Bearer $CLOUD_KEY"The AI gateway speaks OpenAI.
Point an OpenAI client at the gateway with a key that may call AI chat.
- Chat: POST /api/cloud/v1/chat/completions
- Models: GET /api/cloud/v1/models
curl "https://cloud.broos.io/api/cloud/v1/models" \ -H "Authorization: Bearer $CLOUD_KEY"When a call is refused.
The message field says why, in a sentence.
-
401 unauthorized
No key was sent, or the key is wrong. -
403 forbidden
The project’s rules refuse it: the API is off, the budget is spent, the key expired, or the address or website isn’t allowed. -
429
The daily quota is used up until the next UTC day.
Questions when starting.
In Studio, under Cloud. Sign in and open it from the apps.
No. One project key can call every API the project has on, unless you hold it to some.
In OpenAPI at /api/cloud/openapi.json, and each API’s guide in the console’s Library.