curl --request POST \
--url https://api.vaquill.ai/workspace/v1/matters/{matterId}/drafts/{draftId}/improvements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"instructions": "House paper. Cap liability at 12 months of fees; never accept uncapped indemnity.",
"category": "commercial",
"tone": "protective"
}
'import requests
url = "https://api.vaquill.ai/workspace/v1/matters/{matterId}/drafts/{draftId}/improvements"
payload = {
"instructions": "House paper. Cap liability at 12 months of fees; never accept uncapped indemnity.",
"category": "commercial",
"tone": "protective"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
instructions: 'House paper. Cap liability at 12 months of fees; never accept uncapped indemnity.',
category: 'commercial',
tone: 'protective'
})
};
fetch('https://api.vaquill.ai/workspace/v1/matters/{matterId}/drafts/{draftId}/improvements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vaquill.ai/workspace/v1/matters/{matterId}/drafts/{draftId}/improvements"
payload := strings.NewReader("{\n \"instructions\": \"House paper. Cap liability at 12 months of fees; never accept uncapped indemnity.\",\n \"category\": \"commercial\",\n \"tone\": \"protective\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "op_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"type": "matrix.run",
"status": "succeeded",
"createdAt": "2026-08-19T14:32:10Z",
"completedAt": "2026-08-19T14:32:10Z",
"matterId": "mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"resource": {
"kind": "matrix",
"id": "mtx_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"url": "https://storage.vaquill.ai/exports/msa-acme-v3-redline.docx?signature=..."
},
"progress": {
"done": 24,
"total": 128,
"unit": "cells"
},
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}{
"type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential carries matters:read. This operation needs matters:write.",
"instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}{
"type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential carries matters:read. This operation needs matters:write.",
"instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}{
"type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential carries matters:read. This operation needs matters:write.",
"instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}{
"type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential carries matters:read. This operation needs matters:write.",
"instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"errors": [
{
"location": "<string>",
"message": "<string>",
"type": "<string>"
}
],
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}{
"type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential carries matters:read. This operation needs matters:write.",
"instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}{
"type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential carries matters:read. This operation needs matters:write.",
"instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}{
"type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential carries matters:read. This operation needs matters:write.",
"instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}Revise a draft into a new one
Queue a revision. 202 with an operation whose resource is a NEW draft.
The improvement never overwrites its source, which is the internal pipeline’s behaviour and the right one to publish: the run takes minutes and costs money, and a customer that dislikes the result still holds the draft it started from.
curl --request POST \
--url https://api.vaquill.ai/workspace/v1/matters/{matterId}/drafts/{draftId}/improvements \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"instructions": "House paper. Cap liability at 12 months of fees; never accept uncapped indemnity.",
"category": "commercial",
"tone": "protective"
}
'import requests
url = "https://api.vaquill.ai/workspace/v1/matters/{matterId}/drafts/{draftId}/improvements"
payload = {
"instructions": "House paper. Cap liability at 12 months of fees; never accept uncapped indemnity.",
"category": "commercial",
"tone": "protective"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
instructions: 'House paper. Cap liability at 12 months of fees; never accept uncapped indemnity.',
category: 'commercial',
tone: 'protective'
})
};
fetch('https://api.vaquill.ai/workspace/v1/matters/{matterId}/drafts/{draftId}/improvements', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vaquill.ai/workspace/v1/matters/{matterId}/drafts/{draftId}/improvements"
payload := strings.NewReader("{\n \"instructions\": \"House paper. Cap liability at 12 months of fees; never accept uncapped indemnity.\",\n \"category\": \"commercial\",\n \"tone\": \"protective\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"id": "op_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"type": "matrix.run",
"status": "succeeded",
"createdAt": "2026-08-19T14:32:10Z",
"completedAt": "2026-08-19T14:32:10Z",
"matterId": "mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"resource": {
"kind": "matrix",
"id": "mtx_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"url": "https://storage.vaquill.ai/exports/msa-acme-v3-redline.docx?signature=..."
},
"progress": {
"done": 24,
"total": 128,
"unit": "cells"
},
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}{
"type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential carries matters:read. This operation needs matters:write.",
"instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}{
"type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential carries matters:read. This operation needs matters:write.",
"instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}{
"type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential carries matters:read. This operation needs matters:write.",
"instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}{
"type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential carries matters:read. This operation needs matters:write.",
"instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"errors": [
{
"location": "<string>",
"message": "<string>",
"type": "<string>"
}
],
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}{
"type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential carries matters:read. This operation needs matters:write.",
"instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}{
"type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential carries matters:read. This operation needs matters:write.",
"instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}{
"type": "https://vaquill.ai/docs/workspace-api/errors/insufficient-scope",
"title": "Insufficient scope",
"status": 403,
"detail": "This credential carries matters:read. This operation needs matters:write.",
"instance": "/workspace/v1/matters/mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6",
"requestId": "req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
}Authorizations
Workspace credential issued from the automation console at /automation. Send it as Authorization: Bearer vq_ws_.... This is NOT a Data API key: a vq_key_ credential is refused here and names the other product in the error.
Headers
A unique value of your choosing, so a retried launch returns the FIRST operation instead of starting a second billable job. Reusing one with a different body is refused. Retrying with the same key and the same body is free and is the intended way to recover from a timeout.
Path Parameters
mat_ identifier of the matter to work inside. Everything in this API hangs off a matter, and the matter in the path is what the authorization boundary is checked against. Take it from GET /v1/matters.
drf_ identifier of the draft. Take it from the matter's draft list.
Body
Revise an existing draft into a NEW one.
The improvement never overwrites its source. That is the internal pipeline's behaviour and it is the right one to publish: the run takes minutes and costs money, and a customer that dislikes the result still has the draft it started from.
What to fix, in your own words. Optional: the pipeline runs its own analysis first and an instruction only steers it.
40000"House paper. Cap liability at 12 months of fees; never accept uncapped indemnity."
Override the category. Defaults to the source draft's own, so supply this only when the source was misclassified. A source whose category we no longer draft falls back to custom rather than refusing the revision.
1 - 64"commercial"
How protective the revised language should be.
protective, balanced, permissive "protective"
Response
Successful Response
One long-running operation, whatever kind of work it is.
Readable for OPERATION_RETENTION_DAYS after creation, per AIP-151.
Public identifier, op_ followed by 32 hex characters. Poll GET /v1/operations/{operationId} with it.
"op_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
What kind of work this is, for example matrix.run or draft.generate.
"matrix.run"
One of five values: queued, running, succeeded, failed, cancelled. There is no sixth and there are no synonyms. Stop polling once it is succeeded, failed or cancelled.
queued, running, succeeded, failed, cancelled "succeeded"
When the operation was accepted (RFC 3339).
"2026-08-19T14:32:10Z"
When the operation reached a terminal status (RFC 3339). Present if and only if the status is terminal.
"2026-08-19T14:32:10Z"
mat_ identifier of the matter this work belongs to, when it belongs to one.
"mat_9f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
What the operation produced. Absent until the underlying job row exists, which an idempotent replay can briefly observe, so treat absence as 'not yet' rather than 'never'.
Show child attributes
Show child attributes
Why the work failed. Present only when status is failed. Partial success is succeeded with progress.done < progress.total, never an error.
Show child attributes
Show child attributes
How far along the work is, when the underlying job reports it. Absent does not mean no progress.
Show child attributes
Show child attributes
The X-Request-ID of the request that created this operation. Quote it in a support ticket.
"req_5f2c8b1e4a7d43c9b6e0f1a2c3d4e5f6"
Was this page helpful?

