Docfiy REST API introduction

The Docfiy REST API lets you manage documentation sites, publish content, trigger deployments, and integrate search and assistant features into your product.

Base URL: https://api.docfiy.com

Core endpoints

List sites: List all docs sites in your organization.
Get site: Fetch site metadata and status.
Publish content: Upload MDX content and docs.json.
Search documentation: Keyword or semantic search over site content.
Assistant: Ask questions grounded in your documentation.

Common use cases

CI/CD publishing: Push doc updates from your pipeline with Publish content, then call POST /api/v1/sites/{slug}/deploy/trigger.
In-product help: Embed search and assistant with Search documentation and Assistant.
Workspace automation: List and monitor sites programmatically with List sites.

Authentication

API keys grant access to your organization. Store them securely and rotate them if exposed.

Include your API key on every request:

curl https://api.docfiy.com/api/v1/orgs/{orgId}/sites \
  -H "Authorization: Bearer YOUR_API_KEY"

You can create API keys in the Docfiy dashboard under Settings → API keys (coming soon) or use your deployment key from the worker environment.

Public tenant endpoints (/api/sites/{slug}/search and /api/sites/{slug}/assistant) do not require an API key and are scoped to a single published site.

Rate limits

Plan	Requests / minute
Free	60
Pro	300
Enterprise	Custom

Next steps

Quickstart — create your first site
Publish content — API publishing guide

⌘I