Authentication

Authenticate every protected HyperRep API request with your API key. Send the key in the X-API-KEY header.

API key header

Every API request expects this single header:

Name
X-API-KEY
Type
string
Description
Your HyperRep API key.

Example request

Use the same header on every request, including nested resources such as contacts, conversations, messages, and analytics.

Authenticated request

curl https://api.hyperrep.ai/api/v2/organizations \
  -H "X-API-KEY: your-api-key"

Example response

{
  "data": [
    {
      "organization_id": "gAAAAABexampleOrganizationIdReturnedByApi7mN4qP2xLs9dV5kTr8cY1hJ6uW3",
      "name": "Acme Roofing"
    }
  ]
}

Authorization failures

If the API key cannot be used for a request, the API returns 403 Forbidden.

Common cases include:

Name
Missing API Key
Description
The request did not include the X-API-KEY header.
Name
Invalid API Key
Description
The provided key does not match a valid HyperRep API key.
Name
API Key is inactive
Description
The key exists but is no longer active.
Name
API Key has expired
Description
The key exists but is past its expiration date.

Example error response

{
  "detail": "Invalid API Key"
}