API Reference

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/v1

Authentication

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: 1640995200

Pagination

List endpoints support pagination with these query parameters:

ParameterDefaultMaxDescription
page1-Page number
per_page20100Items per page

Available Endpoints

ResourceDescription
TicketsCreate and manage support tickets
ApprovalsReview and decide on AI-proposed actions
Knowledge BaseManage KB entries
CustomersCustomer profiles and data
WorkflowsAutomation workflows
WebhooksReceive real-time event notifications

Scopes

API keys can be limited to specific scopes:

ScopeDescription
tickets:readRead ticket data
tickets:writeCreate and update tickets
kb:readRead knowledge base entries
kb:writeCreate and update KB entries
customers:readRead customer profiles
customers:writeCreate and update customers
workflows:readRead workflows
workflows:writeCreate and update workflows

SDKs

Official SDKs are coming soon. In the meantime, use any HTTP client library.

Need Help?