Authentication

The Sidecar CX API uses API keys to authenticate requests. You can view and manage API keys in the Sidecar CX Applications dashboard under Account Settings as an administrator to your account.

Your API keys carry many privileges, so take great care to ensure you keep your keys secured. Do not share your API keys in publicly accessible areas such as GitHub, client-side code, mobile applications, and so-forth. These keys are intended to be utilized on a back-end server.

Authentication to the Sidecar CX is performed via bearer auth by adding an additional Authorization header to the request with the value Bearer <API key>. The API key is utilized as a bearer token.

Authenticating with curl
Click to copy
curl --request GET \
  --url https://api.sidecarcx.com/v1/accounts/:accountID/applications/:applicationID/ai-agents \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

All API requests must be made over HTTPS. Requests made over HTTP or without authentication will fail. Any 401 error codes in the response are an indicator that the request was not authenticated. Check that the Authorization header was properly passed in with the appropriate API key as a bearer token. If you generated a new token for your Application, all previously generated tokens will no longer be valid.