Skip to main content
Use api-keys to create, list, revoke, and delete API keys for the authenticated user. Supported actions: all, list, create, revoke, delete.

​
Authentication model

API key management endpoints require a session token (JWT). You cannot manage API keys using another API key.

​
List API keys

Retrieves all API keys for the authenticated user. Both all and list return the same result.
​
resource
string
required
Must be "api-keys".
​
action
string
required
"all" or "list".

​
Response

​
success
boolean
​
data
object
const response = await ApiService.invoke<{
  api_keys: ApiKey[];
  count: number;
}>({
  resource: "api-keys",
  action: "all",
});

​
Create API key

Creates a new API key. The full key is returned once in the response and cannot be retrieved again.
​
resource
string
required
Must be "api-keys".
​
action
string
required
Must be "create".
​
data
object
required

​
Response (status 201)

​
success
boolean
​
data
object
const response = await ApiService.invoke<{ api_key: ApiKey }>(
  {
    resource: "api-keys",
    action: "create",
    data: { name: "Production" },
  },
  201
);

// Save response.api_key.key — it won't be shown again

​
Revoke API key

Revokes a key immediately. Any subsequent requests using the revoked key will return 401.
​
resource
string
required
Must be "api-keys".
​
action
string
required
Must be "revoke".
​
id
string
required
The API key ID to revoke.

​
Response

​
success
boolean
​
data
object
curl -s -X PATCH https://api.helpgenie.ai/v1/api-keys/KEY_UUID \
  -H "Authorization: Bearer <session_token>"

​
Delete API key

Permanently deletes an API key record.
​
resource
string
required
Must be "api-keys".
​
action
string
required
Must be "delete".
​
id
string
required
The API key ID to delete.

​
Response

​
success
boolean
​
data
object
curl -s -X DELETE https://api.helpgenie.ai/v1/api-keys/KEY_UUID \
  -H "Authorization: Bearer <session_token>"

​
Using API keys

Once created, pass your API key on every request: 
Authorization: Bearer hg_live_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6
or: 
X-API-Key: hg_live_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6
API keys inherit the same permissions as the user who created them.

​
Operational limits

  • Maximum 5 active keys per user.
  • Rate limit of 60 requests/minute per key.

​
Error responses

StatusCodeDescription
400VALIDATION_ERRORMaximum 5 active API keys allowed. Revoke an existing key first.
401INVALID_TOKENInvalid or revoked API key
429RATE_LIMIT_EXCEEDEDRate limit exceeded