Recommendation APIGuides
Authentication
How to authenticate Recommendation API requests.
API key authentication is required for all Recommendation API calls. The API keys are managed in the PSYKHE AI Dashboard.
We have two key types:
- Public key
- Private key
Public key
- Use the public key with:
X-PSYKHE-API-KEYheader, orpsykhe_api_keyquery parameter.- For browser/client-side calls, prefer
psykhe_api_keyquery parameter usage to avoid sending a custom auth header and reduce extra CORS preflight calls. - For server-to-server calls, prefer the
X-PSYKHE-API-KEYheader. - The public key is expected to be visible in client-side usage and acts as a partial prevention layer against bots and as well as configuration on how much data is returned.
- Recommended to rotate public keys at least monthly.
Private key
- Private keys are used for ingestion use cases.
- Private keys are not accepted in query parameters and must be sent in the header.