Authentication
Get your API key
Section titled “Get your API key”- Sign in to the Gowajee dashboard as an Owner or Admin. Other roles can’t see the key.
- Open System → Developers. The page is called Developer Settings.
- In API Key, click the eye icon to show the key, then copy it.
- Store it on your server, for example as the environment variable
GOWAJEE_API_KEY.
- The key looks like
gw_followed by 32 characters. - There is one key per organization. It can see and control every campaign in your organization.
- Regenerate (same page) replaces the key. The old key stops working immediately, and requests that use it get
401. Put the new key into your systems straight after you regenerate it.
Send it with every request
Section titled “Send it with every request”Put the key in the X-API-Key header of every /api/* request:
GET /api/agent/list HTTP/1.1Host: api.voice-agent.gowajee.aiX-API-Key: gw_3f9a1c2e7b4d4e0a9c8b1f2d3e4a5b6cHeader names are case-insensitive, so x-api-key works too.
Base URL
Section titled “Base URL”https://api.voice-agent.gowajee.aiAll paths in this documentation start with /api/... and are relative to this URL. Use HTTPS only.
Authentication errors
Section titled “Authentication errors”| Situation | Status | code |
message |
|---|---|---|---|
X-API-Key header is missing |
401 |
API_KEY_REQUIRED |
API key is required |
| Key is wrong or was regenerated | 401 |
INVALID_API_KEY |
Invalid API key |
| Your organization is not allowed to make calls (only when starting a campaign) | 403 |
CALLING_NOT_ALLOWED |
Your organization is not allowed to make calls. |
The body is the usual error envelope:
{ "success": false, "statusCode": 401, "code": "INVALID_API_KEY", "message": "Invalid API key", "errors": ["Invalid API key"]}