Skip to main content
The REST API accepts an API key in the x-api-key header, the x-api-key query parameter, or the Authentication header. Create and rotate API keys from your Rapida project credentials.

Authentication parameters

string
API key sent as a request header.
string
API key sent as a query parameter.
string
API key sent as an Authentication header.
Use one authentication method per request. Prefer headers for server-side integrations because query parameters can appear in logs.

Optional headers

string
Optional user identifier to propagate with the request.
string
Optional client source identifier. SDK clients send this automatically.

Base URLs

Use the endpoint for the region where your assistant API is hosted.
Do not expose project API keys in browser or mobile clients. Send REST API requests from a trusted backend service.