API Overview

Summary

Welcome to the Knowledge Base API. This API provides programmatic access to our knowledge base content, enabling you to search, retrieve, and manage articles.

Base URL: https://api.example.com/v1

Version: v1.4.2

Authentication

All requests must include a valid API token in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN

Tokens are issued via the Authentication endpoint and expire after 30 days.

Rate Limits

To ensure fair usage, the API enforces the following limits:

• Standard tier: 120 requests per minute.
• Premium tier: 600 requests per minute.

When a limit is exceeded, the API returns 429 Too Many Requests with a Retry-After header indicating when to retry.

Error Handling

All error responses follow a consistent JSON schema:

{
  "error": {
    "code": "ERR_INVALID_REQUEST",
    "message": "The request parameters are invalid.",
    "details": [
      {"field": "query", "issue": "must not be empty"}
    ]
  }
}

For a complete list of error codes, see the Error Codes page.

Quick Start

Example: Search articles with a keyword.

curl -X GET "https://api.example.com/v1/articles?search=javascript" \
  -H "Authorization: Bearer YOUR_API_TOKEN"