API Overview
Integrate Keva into your applications with our REST API
The Keva API is a RESTful interface that allows you to programmatically manage tickets, approvals, knowledge base entries, customers, and workflows. Use it to build custom integrations, automate workflows, and connect Keva with your existing tools.
Base URL
All API requests should be made to:
https://app.keva.support/api/v1Authentication
The API uses Bearer token authentication. Include your API key in the Authorization header:
curl https://app.keva.support/api/v1/tickets \
-H "Authorization: Bearer keva_live_your_api_key"API keys are prefixed with keva_live_ to identify them. Generate keys in Settings > API Keys.
Request Format
- All requests must use HTTPS
- Request bodies should be JSON with
Content-Type: application/json - Query parameters are used for filtering and pagination
Response Format
All responses return JSON. Successful responses include a data field:
{
"data": { ... },
"pagination": {
"page": 1,
"perPage": 20,
"total": 150
}
}Error responses include an error field:
{
"error": "Invalid API key"
}Rate Limiting
API requests are rate limited to 100 requests per minute per API key. When exceeded, you'll receive a 429 Too Many Requests response.
Rate limit headers are included in responses:
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640995200Pagination
List endpoints support pagination with these query parameters:
| Parameter | Default | Max | Description |
|---|---|---|---|
page | 1 | - | Page number |
per_page | 20 | 100 | Items per page |
Available Endpoints
| Resource | Description |
|---|---|
| Tickets | Create and manage support tickets |
| Approvals | Review and decide on AI-proposed actions |
| Knowledge Base | Manage KB entries |
| Customers | Customer profiles and data |
| Workflows | Automation workflows |
| Webhooks | Receive real-time event notifications |
Scopes
API keys can be limited to specific scopes:
| Scope | Description |
|---|---|
tickets:read | Read ticket data |
tickets:write | Create and update tickets |
kb:read | Read knowledge base entries |
kb:write | Create and update KB entries |
customers:read | Read customer profiles |
customers:write | Create and update customers |
workflows:read | Read workflows |
workflows:write | Create and update workflows |
SDKs
Official SDKs are coming soon. In the meantime, use any HTTP client library.
Need Help?
- Check the error codes reference
- Email hello@keva.support