Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ceibo.me/llms.txt

Use this file to discover all available pages before exploring further.

This guide takes you from no account to a successful API call.

​
1. Create a developer account

Sign up at developer.ceibo.me. Anonymous sessions can browse the dashboard, but minting and managing API keys requires a real account — keys are tied to a user for billing, attribution, and revocation.

​
2. Mint an API key

1

Open the dashboard

Once logged in, go to the API keys section.
2

Create a key

Give the key a memorable name (e.g. local-dev, staging-api). Names are unique per account.
The plaintext key is shown once. Copy it immediately and store it in a secrets manager — Ceibo never displays it again.
3

Note the constraints

Each account can have up to 5 active keys at a time. Revoke unused keys to free up slots; revocation is idempotent and the revoked_at timestamp is preserved for audit.

​
3. Make your first request

The public API lives at https://api.ceibo.me/v1. Authenticate every request with an x-api-key header. 
curl https://api.ceibo.me/v1/countries?limit=5 \
  -H "x-api-key: $CEIBO_API_KEY"
A successful response returns a paginated envelope: 
{
  "data": [
    {
      "id": 10,
      "name": "Argentina",
      "iso2": "AR",
      "iso3": "ARG",
      "continent": "South America"
    }
  ],
  "meta": { "page": 1, "limit": 5, "total": 195, "totalPages": 39 }
}

​
Next steps

Authentication

Header format, JWT vs. API keys, rotation, and tier model.

API reference

Pagination, filtering, error envelope, and every endpoint.

Manage keys

Revoke compromised keys, view usage, change tier.

Status

Health endpoint — returns 200 when the API is up.