Skip to main content

API Reference

The Synjar API allows you to programmatically interact with your knowledge base. Use it to upload documents, search your knowledge base, and manage workspaces.

Interactive Docs

For an interactive API playground, visit /api/docs on your Synjar instance (e.g., https://api.synjar.com/api/docs).

Base URL​

# Cloud
https://api.synjar.com/v1

# Self-hosted
https://your-domain.com/api/v1

Authentication​

All API requests require authentication via Bearer token.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.synjar.com/v1/workspaces

Endpoints​

ResourceDescription
WorkspacesCreate and manage workspaces
DocumentsUpload, process, and manage documents
SearchSemantic search across your knowledge base
Search LinksPublic semantic search API
Instruction SetsCurated document collections for LLM context

See API Quickstart for code examples.

Rate Limits​

PlanRequests/minute
Community100
Starter500
Professional2000
EnterpriseCustom