> ## Documentation Index
> Fetch the complete documentation index at: https://vaquill.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Drive the Vaquill Legal Workspace from your own backend, with no browser

The Workspace API lets your systems do the work your team does in Vaquill: create clients and matters, upload documents, run contract review against a playbook, generate and revise drafts, compare versions, build matrices, and pull the results back out as files.

It is a different product from the [Legal Data API](/docs/api-guide/overview), and the two share nothing.

| | Legal Data API | Legal Workspace API |
| - | - | - |
| What it serves | US and Indian statutes, regulations, constitutions, court rules | **Your own matters and documents** |
| Base URL | `https://api.vaquill.ai/api/v1` | `https://api.vaquill.ai/workspace/v1` |
| Credential | `vq_key_...` | `vq_ws_...` |
| Errors | Vaquill error object | [RFC 9457 problem+json](/docs/workspace-api/concepts/errors) |
| Reference | The **Data API Reference** tab | The **Workspace Reference** tab |

<Warning>
  The two credentials are not interchangeable. A `vq_key_` sent to a Workspace route is refused with a `wrong-product-credential` error that names the other product, and vice versa.
</Warning>

## What you can do

Every capability has a page. This is all of them, in the order they appear in the sidebar.

<CardGroup cols={2}>
  <Card title="Clients and matters" icon="folder" href="/docs/workspace-api/clients-and-matters">
    Create and manage the client, matter and folder structure everything else hangs off.
  </Card>

  <Card title="Documents" icon="file" href="/docs/workspace-api/documents">
    Upload at any size, poll ingestion, read extracted text, download the original bytes, delete.
  </Card>

  <Card title="Drafting" icon="pen-nib" href="/docs/workspace-api/drafting">
    Generate a draft, revise it, apply a template, export it.
  </Card>

  <Card title="The draft lifecycle" icon="arrows-rotate" href="/docs/workspace-api/draft-lifecycle">
    Import a document as a draft, copy it, file it into a matter, and undo a delete.
  </Card>

  <Card title="Authoring templates" icon="file-pen" href="/docs/workspace-api/template-authoring">
    Create, import, edit, copy and retire the boilerplate your drafting runs on.
  </Card>

  <Card title="Contract review" icon="clipboard-check" href="/docs/workspace-api/review-and-playbooks">
    Run a playbook against a contract and get clauses, redlines, missing clauses and negotiation priorities.
  </Card>

  <Card title="Playbook extraction" icon="file-import" href="/docs/workspace-api/playbook-extraction">
    Read your negotiating positions out of a contract you already signed.
  </Card>

  <Card title="NDA triage" icon="traffic-light" href="/docs/workspace-api/nda-triage">
    Screen an inbound NDA against ten criteria and your own playbook, for a green, yellow or red answer.
  </Card>

  <Card title="Compliance checks" icon="shield-check" href="/docs/workspace-api/compliance">
    Check a DPA, a privacy policy or a security plan against one regulation's requirement checklist.
  </Card>

  <Card title="Compare" icon="code-compare" href="/docs/workspace-api/compare">
    Diff two versions of a document and export a redline.
  </Card>

  <Card title="Matrices" icon="table-cells" href="/docs/workspace-api/matrices">
    Ask the same questions across hundreds of documents and get cited answers.
  </Card>

  <Card title="Matter analysis" icon="magnifying-glass-chart" href="/docs/workspace-api/matter-analysis">
    A fact ledger, a narrative summary and a timeline, across every document in a matter.
  </Card>

  <Card title="Research and chat" icon="magnifying-glass" href="/docs/workspace-api/research">
    Ask legal questions from your own backend and get grounded, cited answers.
  </Card>

  <Card title="Workflows" icon="diagram-project" href="/docs/workspace-api/workflows">
    Run multi-step pipelines over a set of documents and collect their artifacts.
  </Card>
</CardGroup>

Two more pages are about driving and undoing all of the above rather than about one capability.

<CardGroup cols={2}>
  <Card title="Cleaning up" icon="trash" href="/docs/workspace-api/cleanup">
    Every delete this API publishes, what each takes with it, and what refuses.
  </Card>

  <Card title="MCP server" icon="plug" href="/docs/workspace-api/mcp">
    Every operation is also an MCP tool, so an AI agent can drive the same surface.
  </Card>
</CardGroup>

## How it is shaped

Three properties are worth knowing before you write any code, because they apply to the whole surface.

**Your organization is never something you send.** It comes from the credential. There is no `organizationId` parameter anywhere, and a request that tries to name one is rejected. Every read and write is confined to the organization that owns the credential.

**Long operations return a job, not a result.** Anything that takes more than a few seconds answers `202` with an operation id. You poll one endpoint, `GET /v1/operations/{operationId}`, for every kind of work. See [Operations](/docs/workspace-api/concepts/operations).

**Polling is the only completion signal.** There are no webhooks today. Each `202` carries a `Retry-After` telling you how long to wait, and the operation resource carries honest progress.

## Get started

<CardGroup cols={2}>
  <Card title="Quickstart" icon="bolt" href="/docs/workspace-api/quickstart">
    Upload a contract and review it, end to end.
  </Card>

  <Card title="Authentication" icon="key" href="/docs/workspace-api/authentication">
    Create a credential and understand scopes.
  </Card>

  <Card title="Operations" icon="clock" href="/docs/workspace-api/concepts/operations">
    The job envelope every long call returns, and how to poll it well.
  </Card>

  <Card title="Errors" icon="triangle-exclamation" href="/docs/workspace-api/concepts/errors">
    The problem+json shape and what each type means.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.