TyneBase API Overview

The TyneBase API enables you to programmatically access and manage your knowledge base.

Base URL

https://api.tynebase.com/v1

For tenant-specific endpoints:

https://{your-subdomain}.tynebase.com/api/v1

Authentication

All API requests require authentication using Bearer tokens:

curl -X GET "https://api.tynebase.com/v1/documents" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Obtaining API Keys

1. Navigate to Settings → API Keys
2. Click + Create API Key
3. Set permissions and expiration
4. Copy the key (shown only once)

Key Permissions

Scope	Description
documents:read	Read documents and categories
documents:write	Create, update, delete documents
users:read	Read user information
users:write	Manage users (admin only)
ai:generate	Use AI generation endpoints
search:query	Access search and RAG endpoints

Request Format

Headers

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
X-Tenant-ID: your-tenant-id (optional, for multi-tenant access)

Request Body

JSON format for POST/PUT/PATCH:

{
  "title": "API Documentation",
  "content": "# Getting Started\n\nWelcome to...",
  "category_id": "cat_abc123",
  "state": "published"
}

Response Format

All responses follow a consistent structure:

Success Response

{
  "success": true,
  "data": {
    "id": "doc_abc123",
    "title": "API Documentation",
    "created_at": "2026-01-10T14:30:00Z"
  },
  "meta": {
    "request_id": "req_xyz789"
  }
}

Error Response

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Title is required",
    "details": {
      "field": "title",
      "constraint": "required"
    }
  },
  "meta": {
    "request_id": "req_xyz789"
  }
}

Rate Limiting

Plan	Requests/minute	Requests/day
Free	60	1,000
Pro	300	10,000
Enterprise	1,000	Unlimited

Rate limit headers:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 1704891600

Pagination

List endpoints support cursor-based pagination:

GET /v1/documents?limit=20&cursor=eyJpZCI6ImRvY18xMjMifQ

Response includes pagination info:

{
  "data": [...],
  "pagination": {
    "has_more": true,
    "next_cursor": "eyJpZCI6ImRvY180NTYifQ",
    "total_count": 150
  }
}

SDKs

Official SDKs available:

• JavaScript/TypeScript: npm install @tynebase/sdk
• Python: pip install tynebase
• Go: go get github.com/tynebase/go-sdk