Using the documentation and playground

How the Documentation tab works: the playground that sends real requests as you and charges your workspace, the code samples, search, Quincy, and the plain-text copies for AI tools.

Last updated 12 September 2026

Using the documentation and playground

These pages are the reference for the Enterprise API, and every endpoint page can send the request it describes.

The playground

Every endpoint page has a "Try it" panel. Edit the request body, or pick a file for an upload, and choose Send. The request goes to the real API as you, and the panel shows the status, the body, and the credit headers that say what it cost.

What to know before you send:

  • It is charged to your workspace, at the same tariff as any other request: one credit for a claim with inline evidence, two against a batch, and a draft review reserves and settles the same way. Uploads, listings, deletions and polls are free. The panel says the price before you send.
  • It runs as you. The documentation page holds a key of its own on its server and asks the API for a short-lived playground token beside your session, so you never paste a key of yours into a page. The token lasts an hour and is renewed when it expires.
  • It is limited per person, at the workspace's pay-as-you-go limits, on a counter of its own, so trying calls here never eats into a key's limits.
  • It shows up in usage as "API reference", on the Overview, Usage and Billing pages, so what was tried here is never confused with what your code sent.
  • Any member can use it. Creating keys is for owners and admins, but trying a request is not.
  • It is HTTP only. The MCP surface is for MCP clients, which connect with your account from the MCP servers page.

Ids you receive come back to you: after an upload, the batchId or draftId is offered on the pages that take one, so a review can be tried end to end from the documentation alone. Deleting something asks first.

If a workspace has no credits, the playground gets the same 402 your code would, with a link to the Billing page. If the token has expired, reload the page.

Code samples

Every endpoint page shows the request as curl, JavaScript and Python, generated from the body in the playground, so what you edit is what the sample sends. The language you pick is remembered across pages. Samples read the key from QUORUM_API_KEY in the environment: put a real key there rather than in your source.

Finding things

Search the documentation from the box above the contents, or press Cmd+K (Ctrl+K on Windows). Each page's headings are on the right, and every heading is a link you can share.

Quincy, in the corner of every page, has read all of this. Ask it what a field means, why a request was refused, or where a setting lives, and it can take you to the page or the control. It can also open a ticket when something is wrong.

For AI tools and scripts

  • The OpenAPI 3.0 description of the HTTP surface is at https://developer.quorumtech.ch/openapi.yaml.
  • Every page is available as plain Markdown, and an index of them for AI readers is at https://helix-support.quorumtech.ch/api/developer/llms.txt, with the whole set in one file at llms-full.txt beside it. Point a coding assistant at the index and it can read the reference the way you do.
  • The same pages are in the Quorum Help Center, where they can be searched and linked to without signing in.

Still need help?

Ask Quincy in the chat bubble below, or write to support@quorumtech.ch and we will help you directly.