REST credentials: API keys and OAuth clients · FAQ
Where do I create a Casafari API key, and can I revoke it?
Create a Casafari API key in the self-serve platform's console at https://platform.casafari.com/console; the key, starting cf_sk_, is shown only once, so store it immediately.
Free allows 2 API keys and Agent 5. How to revoke or rotate a key, and whether keys expire, are not published yet; Casafari can answer (https://www.casafari.com/).
Once you have the key:
- Keep it in your server's environment or a secret store (keeping a key safe).
- Send it in the
X-API-Keyheader or asAuthorization: Bearer <api_key>, never in a URL. - Try it with a free call:
GET https://platform.casafari.com/v1/locations/search?query=Lisboncosts 0 units (first REST call).
The console also creates OAuth clients: see API key or OAuth client?.
Existing Casafari clients don't use these keys: the account owner creates API clients in Settings → API Clients on https://docs.api.casafari.com/ (existing API reference).
Related questions
- How do I authenticate with the Casafari REST API?
- Do I need an API key for Casafari MCP?
- Should I use an API key or an OAuth client for the Casafari REST API?
- How do I get an OAuth access token for the Casafari REST API with client credentials?
- Where should I keep my Casafari API key, and can I paste it into an AI assistant?