Introduction

The Syntheia API lets you programmatically interact with your workspaces, documents, and provisions — the same capabilities available in the Syntheia app, accessible from your own code.

What you can do

• Ingest documents — upload contracts, reports, and files into workspaces
• Query and analyse — ask questions against your document corpus and get structured answers
• Manage workspaces — create, update, and retrieve workspaces and their contents
• Manage users and permissions — administer team access programmatically

Base URL

All API requests are made to the domain where you obtained your API key. Replace your-domain.com with that host throughout these docs:

https://api.your-domain.com

Authentication

Every request requires an x-api-key header and an x-workspace-id header. See Authentication for how to generate your API key.

Rate limits

Plan	Requests / minute
Starter	60
Pro	300
Enterprise	Custom

Responses include X-RateLimit-Remaining and X-RateLimit-Reset headers so you can track usage.

Versioning

The current API version is v1. Breaking changes will be announced with a deprecation period before a new version is introduced.

Need help?

• Browse the API Reference for full endpoint documentation
• Jump straight into the Quickstart to make your first request
• Contact support at support@your-domain.com