Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.knoxcall.com/llms.txt

Use this file to discover all available pages before exploring further.

Create API Key

POST /v1/api-keys
Creates a new API key. The full key value is returned only once in the response — store it securely.

Request Body

FieldTypeRequiredDescription
namestringYesA descriptive name (e.g., “CI/CD Pipeline”, “Backend Server”)
rate_limit_requestsintegerNoMaximum requests per window for this key
rate_limit_window_secintegerNoRate limit window duration in seconds

Response

{
  "data": {
    "key_id": "tk_live_newkey789",
    "api_key": "tk_live_newkey789_a1b2c3d4e5f6g7h8i9j0...",
    "key_prefix": "tk_live_new...",
    "key_type": "standard",
    "name": "CI/CD Pipeline",
    "message": "Store this API key securely. It will not be shown again."
  },
  "meta": { "request_id": "550e8400-e29b-41d4-a716-446655440000" }
}
The api_key field contains the full key and is only returned at creation time. KnoxCall does not store the plain-text key. If you lose it, you must revoke it and create a new one.
curl -X POST https://api.knoxcall.com/v1/api-keys \
  -H "Authorization: Bearer tk_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "CI/CD Pipeline"
  }'

Errors

StatusTypeDescription
400validation_errorMissing name field