Help center

API Overview

What is the clarife API?

The clarife API gives developers, AI agents, and automation tools access to the clarife platform. You can create and update documents, upload media, manage shares, and react to events via webhooks - all with a simple REST interface.

  • REST API - Standard HTTP endpoints with JSON payloads. Works with any language or tool.
  • MCP Server - Model Context Protocol endpoint for Claude Desktop, Cursor, and other AI assistants.
  • Webhooks - Real-time event notifications delivered to your server when things change.
  • Automation - First-class support for n8n, Make, and Zapier via HTTP modules.

Who is it for?

  • Developers building custom integrations or internal tools
  • AI agents that create and manage documentation autonomously
  • Automation platforms (n8n, Make, Zapier) connecting clarife to your workflow
  • Teams that need programmatic control over their documentation pipeline

Plan Requirements

⚠️ Warning: The API is available on Pro and Business plans only. Free plan users cannot create API keys.

FeatureProBusiness
Rate limit100 req/min500 req/min
API keys520
Webhook subscriptions320
MCP accessYesYes

Base URL

All API requests use the following base URL:

https://my.clarife.app/api/v1

Quick Start

Step 1 - Create an API key

Go to Settings > API in your clarife dashboard. Click Create API key, name it, and select the scopes you need.

Step 2 - Copy the key

Your key starts with clrf_. Copy it immediately - it is only shown once.

Step 3 - Make your first request

bash
curl https://my.clarife.app/api/v1/documents \
  -H "Authorization: Bearer clrf_your_key_here"

Step 4 - Check the response

json
{
  "data": [
    {
      "id": "d1a2b3c4-...",
      "title": "Getting Started Guide",
      "created_at": "2026-03-15T10:30:00Z"
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

Response Format

All endpoints return JSON. Single resources are wrapped in data:

json
{ "data": { "id": "...", "title": "..." } }

Lists include pagination metadata:

json
{ "data": [...], "total": 42, "limit": 50, "offset": 0 }

Errors return an error message and machine-readable code:

json
{ "error": "Document not found", "code": "NOT_FOUND" }

What's Next?