API Overview
Introduction to our REST API
Updated 1/21/2026
API Overview
Our REST API allows you to programmatically interact with your knowledge base.
Base URL
All API requests should be made to:
https://api.yourkb.com/v1
Authentication
Include your API key in the request headers:
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.yourkb.com/v1/articles
Rate Limiting
- Free tier: 100 requests/minute
- Pro tier: 1000 requests/minute
- Enterprise: Unlimited
Response Format
All responses are JSON:
{
"success": true,
"data": { ... },
"meta": {
"page": 1,
"total": 100
}
}
Error Handling
Errors return appropriate HTTP status codes:
| Code | Meaning |
|---|---|
| 400 | Bad Request |
| 401 | Unauthorized |
| 404 | Not Found |
| 429 | Rate Limited |
| 500 | Server Error |