API Reference
Authentication
API authentication
API Keys
All requests require an API key in the Authorization header:
Authorization: Bearer kw_live_abc123...Creating an API Key
- Log in to your Kapwork account
- Navigate to Settings → API Keys
- Click Create New Key
- Name the key (e.g., "Production")
- Store the key immediately—it is displayed only once
Usage
Environment Variable
export KAPWORK_API_KEY="kw_live_abc123..."In Requests
curl "https://api.kapwork.com/v1/vendors" \
-H "Authorization: Bearer $KAPWORK_API_KEY"Key Format
kw_live_<48 random characters>Example:
kw_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4Security
Key Security
- Do not commit API keys to version control
- Use environment variables in applications
- Rotate keys if compromise is suspected
- Use separate keys for development and production
Key Management
Viewing Keys
View all API keys in Settings → API Keys.
Revoking Keys
- Navigate to Settings → API Keys
- Locate the key
- Click Revoke
Revoked keys are immediately invalidated.
Usage Statistics
View usage statistics per key in the Kapwork dashboard.
Rate Limiting
Beta Period
Rate limiting is not enforced during the beta period. Fair use is expected. Limits may be introduced in the future.
Error Responses
Missing Authorization Header
{
"statusCode": 401,
"message": "Missing Authorization header",
"error": "Unauthorized"
}Invalid API Key
{
"statusCode": 401,
"message": "Invalid or revoked API key",
"error": "Unauthorized"
}