@talonic/docs 0.12.0 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/seo.js +250 -288
- package/openapi.json +250 -288
- package/package.json +1 -1
package/openapi.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Talonic API",
|
|
5
5
|
"version": "1.0.0",
|
|
6
|
-
"description": "Structure any document into schema-validated data.\n\nThe Talonic API lets you extract structured data from documents (PDFs, images,\nDOCX, CSV, plain text), manage reusable extraction schemas, track async jobs,\nand organise documents through sources.\n\n## Authentication\n\nAll requests require a Bearer token in the `Authorization` header.\nAPI keys are prefixed with `tlnc_` and scoped per customer.\n\n```\nAuthorization: Bearer tlnc_live_abc123...\n```\n\n## Async Extraction Pattern\n\nSmall documents (≤5 pages) are processed synchronously and return a `200`\nwith the extracted data immediately. Larger documents return a `202 Accepted`\nwith a `poll_url` — poll `GET /v1/documents/{id}` until `status` transitions\nto `completed`, then fetch results via `GET /v1/documents/{id}/extractions`.\n\nYou can force async processing by passing `options: {\"async\": true}` on\nany extraction request. Combine with webhooks for a fully event-driven flow:\nconfigure a webhook destination under Delivery and listen for the\n`extraction.complete` event.\n\n**Job status lifecycle:** `pending` → `processing` → `complete` | `failed`\n\n## Rate Limits\n\nRequests are metered per calendar day (UTC). Limits depend on your plan tier:\n\n| Tier | Extract | Platform | Ingest |\n|------------|---------|----------|--------|\n| Free | 50/day | 500/day | 50/day |\n| Pro | 2,000 | 10,000 | 2,000 |\n| Enterprise | Unlimited | Unlimited | Unlimited |\n\nEvery response includes rate-limit headers:\n- `X-RateLimit-Limit` — daily cap for the namespace\n- `X-RateLimit-Remaining` — requests left today\n- `X-RateLimit-Reset` — ISO 8601 timestamp when the window resets (midnight UTC)\n\n## Pagination\n\nList endpoints use cursor-based pagination. Pass `limit` (1–100, default 20),\n`cursor` (opaque token from `pagination.next_cursor`), and `order` (`asc` or `desc`, default `desc`).\n\n## Errors\n\nAll errors return a JSON body with `error` (machine-readable code) and `message`\n(human-readable explanation). Additional fields vary by error type.\n\n| Code | Error | Description |\n|------|--------------------|------------------------------------------|\n| 400 | validation_error | Request body is malformed or invalid |\n| 401 | unauthorized | Missing or invalid API key |\n| 403 | insufficient_scope | API key lacks the required scope |\n| 404 | not_found | Resource does not exist |\n| 409 | conflict | Resource state conflict |\n| 413 | payload_too_large | File exceeds 500 MB limit |\n| 422 | extraction_failed | Document could not be processed |\n| 429 | rate_limit_exceeded| Daily rate limit reached |\n| 500 | internal_error | Unexpected server error (retryable) |\n\nEvery error response follows this envelope:\n\n```json\n{\n \"statusCode\": 400,\n \"code\": \"VALIDATION_ERROR\",\n \"error\": \"Bad Request\",\n \"message\": \"name is required.\",\n \"retryable\": false,\n \"timestamp\": \"2026-04-25T14:30:00.000Z\",\n \"path\": \"/v1/schemas\"\n}\n```\n\nThe `code` field is one of: `VALIDATION_ERROR`, `AUTH_REQUIRED`, `TOKEN_EXPIRED`,\n`INSUFFICIENT_PERMISSIONS`, `RESOURCE_NOT_FOUND`, `QUOTA_EXCEEDED`,\n`INSUFFICIENT_CREDITS`, `LLM_RATE_LIMITED`, `LLM_TIMEOUT`, `LLM_UNAVAILABLE`,\n`OCR_FAILED`, `EXTRACTION_FAILED`, `EXTRACTION_TIMEOUT`, `FILE_TOO_LARGE`,\n`DUPLICATE_RESOURCE`, `DATASPACE_RUN_FAILED`, `INTERNAL_ERROR`.\n\n## Async Extraction
|
|
6
|
+
"description": "Structure any document into schema-validated data.\n\nThe Talonic API lets you extract structured data from documents (PDFs, images,\nDOCX, CSV, plain text), manage reusable extraction schemas, track async jobs,\nand organise documents through sources.\n\n## Authentication\n\nAll requests require a Bearer token in the `Authorization` header.\nAPI keys are prefixed with `tlnc_` and scoped per customer.\n\n```\nAuthorization: Bearer tlnc_live_abc123...\n```\n\n## Async Extraction Pattern\n\nSmall documents (≤5 pages) are processed synchronously and return a `200`\nwith the extracted data immediately. Larger documents return a `202 Accepted`\nwith a `poll_url` — poll `GET /v1/documents/{id}` until `status` transitions\nto `completed`, then fetch results via `GET /v1/documents/{id}/extractions`.\n\nYou can force async processing by passing `options: {\"async\": true}` on\nany extraction request. Combine with webhooks for a fully event-driven flow:\nconfigure a webhook destination under Delivery and listen for the\n`extraction.complete` event.\n\n**Job status lifecycle:** `pending` → `processing` → `complete` | `failed`\n\n## Rate Limits\n\nRequests are metered per calendar day (UTC). Limits depend on your plan tier:\n\n| Tier | Extract | Platform | Ingest |\n|------------|---------|----------|--------|\n| Free | 50/day | 500/day | 50/day |\n| Pro | 2,000 | 10,000 | 2,000 |\n| Enterprise | Unlimited | Unlimited | Unlimited |\n\nEvery response includes rate-limit headers:\n- `X-RateLimit-Limit` — daily cap for the namespace\n- `X-RateLimit-Remaining` — requests left today\n- `X-RateLimit-Reset` — ISO 8601 timestamp when the window resets (midnight UTC)\n\n## Pagination\n\nList endpoints use cursor-based pagination. Pass `limit` (1–100, default 20),\n`cursor` (opaque token from `pagination.next_cursor`), and `order` (`asc` or `desc`, default `desc`).\n\n## Errors\n\nAll errors return a JSON body with `error` (machine-readable code) and `message`\n(human-readable explanation). Additional fields vary by error type.\n\n| Code | Error | Description |\n|------|--------------------|------------------------------------------|\n| 400 | validation_error | Request body is malformed or invalid |\n| 401 | unauthorized | Missing or invalid API key |\n| 403 | insufficient_scope | API key lacks the required scope |\n| 404 | not_found | Resource does not exist |\n| 409 | conflict | Resource state conflict |\n| 413 | payload_too_large | File exceeds 500 MB limit |\n| 422 | extraction_failed | Document could not be processed |\n| 429 | rate_limit_exceeded| Daily rate limit reached |\n| 500 | internal_error | Unexpected server error (retryable) |\n\nEvery error response follows this envelope:\n\n```json\n{\n \"statusCode\": 400,\n \"code\": \"VALIDATION_ERROR\",\n \"error\": \"Bad Request\",\n \"message\": \"name is required.\",\n \"retryable\": false,\n \"timestamp\": \"2026-04-25T14:30:00.000Z\",\n \"path\": \"/v1/schemas\"\n}\n```\n\nThe `code` field is one of: `VALIDATION_ERROR`, `AUTH_REQUIRED`, `TOKEN_EXPIRED`,\n`INSUFFICIENT_PERMISSIONS`, `RESOURCE_NOT_FOUND`, `QUOTA_EXCEEDED`,\n`INSUFFICIENT_CREDITS`, `LLM_RATE_LIMITED`, `LLM_TIMEOUT`, `LLM_UNAVAILABLE`,\n`OCR_FAILED`, `EXTRACTION_FAILED`, `EXTRACTION_TIMEOUT`, `FILE_TOO_LARGE`,\n`DUPLICATE_RESOURCE`, `DATASPACE_RUN_FAILED`, `INTERNAL_ERROR`.\n\n## Async Extraction Flow\n\nDocuments ≤5 pages return results synchronously (`200`). Larger documents\n— or any request with `options: {\"async\": true}` — return `202 Accepted`.\n\n**1. Submit extraction:**\n\n```bash\ncurl -X POST https://api.talonic.com/v1/extract \\\n -H \"Authorization: Bearer tlnc_live_abc123\" \\\n -F \"file=@contract.pdf\" \\\n -F 'options={\"async\": true}'\n```\n\nResponse `202`:\n```json\n{\n \"request_id\": \"req_x7y8z9a0\",\n \"status\": \"processing\",\n \"document\": { \"id\": \"f0e1d2c3-b4a5-9687-8765-432109876543\" },\n \"poll_url\": \"/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543\"\n}\n```\n\n**2. Poll until complete:**\n\n```bash\ncurl https://api.talonic.com/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543 \\\n -H \"Authorization: Bearer tlnc_live_abc123\"\n```\n\nWhile processing: `{ \"status\": \"processing\" }`\nWhen done: `{ \"status\": \"completed\" }`\n\n**3. Retrieve results:**\n\n```bash\ncurl https://api.talonic.com/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543/extractions \\\n -H \"Authorization: Bearer tlnc_live_abc123\"\n```\n\n**Python polling example:**\n\n```python\nimport time, requests\n\nresp = requests.post(\"https://api.talonic.com/v1/extract\",\n headers={\"Authorization\": \"Bearer tlnc_live_abc123\"},\n files={\"file\": open(\"contract.pdf\", \"rb\")},\n data={\"options\": '{\"async\": true}'})\ndoc_id = resp.json()[\"document\"][\"id\"]\n\ndelay = 2\nfor _ in range(15):\n time.sleep(delay)\n doc = requests.get(f\"https://api.talonic.com/v1/documents/{doc_id}\",\n headers={\"Authorization\": \"Bearer tlnc_live_abc123\"}).json()\n if doc[\"status\"] == \"completed\":\n break\n delay = min(delay * 2, 30) # 2s, 4s, 8s, 16s, 30s cap\n\nextractions = requests.get(\n f\"https://api.talonic.com/v1/documents/{doc_id}/extractions\",\n headers={\"Authorization\": \"Bearer tlnc_live_abc123\"}).json()\nprint(extractions[\"data\"][0][\"data\"])\n```\n\nRecommended polling: 2s initial, exponential backoff (2→4→8→16→30s cap),\ntimeout after 5 minutes.\n\n**Alternative — Webhooks:** Configure a delivery destination and listen for\n`document.extracted` events. See the Delivery tag.\n\n**Job status state machine:**\n`pending` → `queued` → `processing` → `complete` | `failed`\n\n## Performance\n\n| Document size | Expected latency | Max timeout |\n|---------------|------------------|-------------|\n| 1–5 pages | Sync, <3s | 30s |\n| 6–50 pages | <30s average | 5 min |\n| 50+ pages | <5 min average | 30 min |\n\n**Uptime SLA:** 99.5% (Build), 99.9% (Scale), custom (Enterprise).\n\n**Max file size:** 500 MB. JSON request bodies (schemas, jobs): 1 MB.\n\n**Idempotency:** Pass `Idempotency-Key` header on POST requests. Keys are\nvalid for 24 hours and scoped per API key. Duplicates return the cached\nresponse with `cached: true`.\n",
|
|
7
7
|
"contact": {
|
|
8
8
|
"name": "Talonic Support",
|
|
9
9
|
"email": "support@talonic.ai",
|
|
@@ -31,170 +31,39 @@
|
|
|
31
31
|
"tags": [
|
|
32
32
|
{
|
|
33
33
|
"name": "Extract",
|
|
34
|
-
"description": "Upload a document and extract structured data in one call."
|
|
34
|
+
"description": "Upload a document and extract structured data in one call. Start here."
|
|
35
35
|
},
|
|
36
36
|
{
|
|
37
37
|
"name": "Documents",
|
|
38
|
-
"description": "Browse, inspect, and delete processed documents."
|
|
38
|
+
"description": "Browse, inspect, and delete processed documents. Includes document type classification and OCR markdown retrieval."
|
|
39
39
|
},
|
|
40
40
|
{
|
|
41
41
|
"name": "Extractions",
|
|
42
|
-
"description": "Access and
|
|
42
|
+
"description": "Access extraction results, retrieve structured data in JSON or CSV, and submit field-level corrections."
|
|
43
43
|
},
|
|
44
44
|
{
|
|
45
45
|
"name": "Schemas",
|
|
46
|
-
"description": "Create and manage reusable extraction schemas."
|
|
46
|
+
"description": "Create and manage reusable extraction schemas, schema graph classes, output dialects, and the field registry."
|
|
47
47
|
},
|
|
48
48
|
{
|
|
49
|
-
"name": "Jobs",
|
|
50
|
-
"description": "Track and
|
|
49
|
+
"name": "Jobs & Batches",
|
|
50
|
+
"description": "Track async processing jobs, poll for completion, retrieve result grids, and manage batch inference runs at 50% cost."
|
|
51
51
|
},
|
|
52
52
|
{
|
|
53
53
|
"name": "Sources",
|
|
54
|
-
"description": "
|
|
55
|
-
},
|
|
56
|
-
{
|
|
57
|
-
"name": "Dialects",
|
|
58
|
-
"description": "Manage shared dialects — named presets for output format conventions (date format, number locale, CSV delimiter, encoding, boolean rendering)."
|
|
59
|
-
},
|
|
60
|
-
{
|
|
61
|
-
"name": "Matching",
|
|
62
|
-
"description": "Reference-data matching configurations and runs. Matches extracted document fields against reference datasets with weighted field mappings."
|
|
63
|
-
},
|
|
64
|
-
{
|
|
65
|
-
"name": "Routing",
|
|
66
|
-
"description": "Document routing rules that trigger actions when classification conditions are met."
|
|
54
|
+
"description": "Create document ingest sources with dedicated API keys. Upload documents for automatic extraction."
|
|
67
55
|
},
|
|
68
56
|
{
|
|
69
57
|
"name": "Delivery",
|
|
70
|
-
"description": "Outbound delivery
|
|
71
|
-
},
|
|
72
|
-
{
|
|
73
|
-
"name": "Filter",
|
|
74
|
-
"description": "Structured filter queries over materialised document values plus omnisearch across documents, fields, and schemas."
|
|
75
|
-
},
|
|
76
|
-
{
|
|
77
|
-
"name": "Review",
|
|
78
|
-
"description": "Queue of validation records requiring human review; supports single- and batch-action approvals/rejections."
|
|
79
|
-
},
|
|
80
|
-
{
|
|
81
|
-
"name": "Quality",
|
|
82
|
-
"description": "Ground truth datasets and benchmark runs for measuring extraction accuracy."
|
|
83
|
-
},
|
|
84
|
-
{
|
|
85
|
-
"name": "Batches",
|
|
86
|
-
"description": "Batch inference runs. Extraction deferred to the provider's Message Batches API at 50% cost, 48h SLA."
|
|
87
|
-
},
|
|
88
|
-
{
|
|
89
|
-
"name": "Cases",
|
|
90
|
-
"description": "Document clusters linked through shared entity values. Cases are discovered automatically from the linking graph."
|
|
91
|
-
},
|
|
92
|
-
{
|
|
93
|
-
"name": "Document Types",
|
|
94
|
-
"description": "Canonical document type ontology and the customer's resolved types."
|
|
95
|
-
},
|
|
96
|
-
{
|
|
97
|
-
"name": "Fields",
|
|
98
|
-
"description": "Field registry — canonical field definitions discovered across the customer's documents plus cross-schema harmonization."
|
|
99
|
-
},
|
|
100
|
-
{
|
|
101
|
-
"name": "Reference Data",
|
|
102
|
-
"description": "Uploaded reference datasets (CSV/XLSX) used by matching configurations for lookups and joins."
|
|
103
|
-
},
|
|
104
|
-
{
|
|
105
|
-
"name": "Usage",
|
|
106
|
-
"description": "Aggregate and per-document API usage accounting (tokens, costs, operation types)."
|
|
107
|
-
},
|
|
108
|
-
{
|
|
109
|
-
"name": "Resolutions",
|
|
110
|
-
"description": "Resolution runs — apply field normalization, transforms, and lookup cascades to extracted data."
|
|
111
|
-
},
|
|
112
|
-
{
|
|
113
|
-
"name": "Linking",
|
|
114
|
-
"description": "Document linking graph — link keys, document links, entity graph, classification, and backfill operations."
|
|
115
|
-
},
|
|
116
|
-
{
|
|
117
|
-
"name": "N-Shot",
|
|
118
|
-
"description": "N-Shot comparison endpoints for job runs — summary, field comparisons, overrides, and judge decisions."
|
|
119
|
-
},
|
|
120
|
-
{
|
|
121
|
-
"name": "Schema Graph",
|
|
122
|
-
"description": "Schema class ontology — versioned classes, diffs with approval workflow, edges, aliases, and visualization."
|
|
123
|
-
},
|
|
124
|
-
{
|
|
125
|
-
"name": "Structuring",
|
|
126
|
-
"description": "Structuring pipeline — validation checks, approval gates with rules, result checks, pending approvals, and delivery triggers."
|
|
127
|
-
},
|
|
128
|
-
{
|
|
129
|
-
"name": "Telemetry",
|
|
130
|
-
"description": "Aggregate structuring metrics — capture hit rate, synthesize rate, strategy distribution, and tier funnel breakdowns per schema or run."
|
|
131
|
-
},
|
|
132
|
-
{
|
|
133
|
-
"name": "Validation",
|
|
134
|
-
"description": "Golden sample management and validation runs for measuring extraction accuracy against ground truth."
|
|
135
|
-
},
|
|
136
|
-
{
|
|
137
|
-
"name": "Credits",
|
|
138
|
-
"description": "Credit balance, usage history, daily breakdown, and per-request usage log."
|
|
139
|
-
},
|
|
140
|
-
{
|
|
141
|
-
"name": "Agent",
|
|
142
|
-
"description": "Workspace context snapshot and tool discovery for the embedded AI agent."
|
|
143
|
-
}
|
|
144
|
-
],
|
|
145
|
-
"x-tagGroups": [
|
|
146
|
-
{
|
|
147
|
-
"name": "Getting Started",
|
|
148
|
-
"tags": [
|
|
149
|
-
"Extract"
|
|
150
|
-
]
|
|
151
|
-
},
|
|
152
|
-
{
|
|
153
|
-
"name": "Core Resources",
|
|
154
|
-
"tags": [
|
|
155
|
-
"Documents",
|
|
156
|
-
"Extractions",
|
|
157
|
-
"Schemas",
|
|
158
|
-
"Jobs"
|
|
159
|
-
]
|
|
160
|
-
},
|
|
161
|
-
{
|
|
162
|
-
"name": "Data Pipeline",
|
|
163
|
-
"tags": [
|
|
164
|
-
"Sources",
|
|
165
|
-
"Batches",
|
|
166
|
-
"Routing",
|
|
167
|
-
"Delivery",
|
|
168
|
-
"Filter",
|
|
169
|
-
"Review"
|
|
170
|
-
]
|
|
58
|
+
"description": "Outbound delivery pipeline — routing rules, delivery destinations (webhook, SFTP,\nS3, Azure Blob, Google Drive, OneDrive), bindings, filters, and the delivery\nhistory/DLQ/events log.\n\n## Webhook Contract\n\n**Event payload:**\n```json\n{\n \"event\": {\n \"event_type\": \"document.extracted\",\n \"event_id\": \"42\",\n \"binding_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"idempotency_key\": \"c9f3a7e1b2d4f6a8e0c2d4f6a8e0c2d4\",\n \"attempt\": 1,\n \"delivered_at\": \"2026-04-25T14:30:00.000Z\"\n },\n \"payload\": { \"document_id\": \"...\", \"data\": { \"...extracted fields...\" } }\n}\n```\n\n**Event types:** `document.extracted`, `document.extraction_failed`,\n`run.dataspace.completed`, `run.dataspace.failed`, `result.dataspace.completed`,\n`result.dataspace.failed`, `run.structuring.completed`, `run.structuring.failed`,\n`run.resolution.completed`, `run.resolution.failed`, `run.extraction.completed`,\n`run.extraction.failed`, `result.flagged`, `result.approved`, `result.rejected`,\n`delivery.item.completed`, `delivery.item.failed`.\n\n**Signature verification (HMAC-SHA256):**\n\nHeader: `X-Talonic-Signature: t=1714060200000,v1=abc123...`\n\n```javascript\nconst crypto = require('crypto');\nconst [tPart, vPart] = signature.split(',');\nconst timestamp = tPart.split('=')[1];\nconst received = vPart.split('=')[1];\nconst expected = crypto.createHmac('sha256', signingSecret)\n .update(timestamp + '.' + rawBody).digest('hex');\nconst valid = crypto.timingSafeEqual(\n Buffer.from(received), Buffer.from(expected));\n```\n\n**Retry policy:** Up to 7 attempts — 0s, 30s, 2m, 8m, 30m, 2h, 8h (~10.5h total).\nHTTP 429/5xx are retryable. HTTP 4xx (except 408) goes to DLQ immediately.\nReplay failed deliveries via `POST /v1/delivery/dlq/{id}/replay`.\n"
|
|
171
59
|
},
|
|
172
60
|
{
|
|
173
61
|
"name": "Intelligence",
|
|
174
|
-
"
|
|
175
|
-
"Matching",
|
|
176
|
-
"Cases",
|
|
177
|
-
"Linking",
|
|
178
|
-
"Fields",
|
|
179
|
-
"Reference Data",
|
|
180
|
-
"Dialects",
|
|
181
|
-
"Document Types",
|
|
182
|
-
"Schema Graph",
|
|
183
|
-
"N-Shot",
|
|
184
|
-
"Resolutions"
|
|
185
|
-
]
|
|
62
|
+
"description": "Reference-data matching, document linking graphs, case discovery, resolution runs, N-Shot comparisons, and reference dataset management."
|
|
186
63
|
},
|
|
187
64
|
{
|
|
188
65
|
"name": "Platform",
|
|
189
|
-
"
|
|
190
|
-
"Usage",
|
|
191
|
-
"Credits",
|
|
192
|
-
"Quality",
|
|
193
|
-
"Telemetry",
|
|
194
|
-
"Validation",
|
|
195
|
-
"Structuring",
|
|
196
|
-
"Agent"
|
|
197
|
-
]
|
|
66
|
+
"description": "Usage accounting, credit balance, quality benchmarks, structuring checks, validation runs, review queue, telemetry metrics, and the embedded AI agent."
|
|
198
67
|
}
|
|
199
68
|
],
|
|
200
69
|
"paths": {
|
|
@@ -1494,7 +1363,7 @@
|
|
|
1494
1363
|
"summary": "Create and queue a new job",
|
|
1495
1364
|
"description": "Start a new grid-based job that fills a user schema from a set of\ndocuments. Provide a `schema_id` and, optionally, the specific\n`document_ids` to run against. If `document_ids` is omitted or empty,\nall `completed` documents for the customer are used.\n",
|
|
1496
1365
|
"tags": [
|
|
1497
|
-
"Jobs"
|
|
1366
|
+
"Jobs & Batches"
|
|
1498
1367
|
],
|
|
1499
1368
|
"requestBody": {
|
|
1500
1369
|
"required": true,
|
|
@@ -1556,7 +1425,7 @@
|
|
|
1556
1425
|
"operationId": "listJobs",
|
|
1557
1426
|
"summary": "List jobs",
|
|
1558
1427
|
"tags": [
|
|
1559
|
-
"Jobs"
|
|
1428
|
+
"Jobs & Batches"
|
|
1560
1429
|
],
|
|
1561
1430
|
"parameters": [
|
|
1562
1431
|
{
|
|
@@ -1653,7 +1522,7 @@
|
|
|
1653
1522
|
"operationId": "getJob",
|
|
1654
1523
|
"summary": "Get a job",
|
|
1655
1524
|
"tags": [
|
|
1656
|
-
"Jobs"
|
|
1525
|
+
"Jobs & Batches"
|
|
1657
1526
|
],
|
|
1658
1527
|
"parameters": [
|
|
1659
1528
|
{
|
|
@@ -1717,7 +1586,7 @@
|
|
|
1717
1586
|
"summary": "Cancel a job",
|
|
1718
1587
|
"description": "Cancel a pending or processing job. Jobs that are already `complete` or\n`failed` cannot be cancelled and will return a 409 Conflict.\n",
|
|
1719
1588
|
"tags": [
|
|
1720
|
-
"Jobs"
|
|
1589
|
+
"Jobs & Batches"
|
|
1721
1590
|
],
|
|
1722
1591
|
"parameters": [
|
|
1723
1592
|
{
|
|
@@ -1759,7 +1628,7 @@
|
|
|
1759
1628
|
"summary": "Get job result rows",
|
|
1760
1629
|
"description": "Return the extracted values for every document processed by this job,\none row per document. Includes per-row confidence and any validation\nflags raised during Phase 4.\n",
|
|
1761
1630
|
"tags": [
|
|
1762
|
-
"Jobs"
|
|
1631
|
+
"Jobs & Batches"
|
|
1763
1632
|
],
|
|
1764
1633
|
"parameters": [
|
|
1765
1634
|
{
|
|
@@ -2178,7 +2047,7 @@
|
|
|
2178
2047
|
"summary": "List dialects",
|
|
2179
2048
|
"description": "Return every shared dialect defined for the authenticated customer.",
|
|
2180
2049
|
"tags": [
|
|
2181
|
-
"
|
|
2050
|
+
"Schemas"
|
|
2182
2051
|
],
|
|
2183
2052
|
"responses": {
|
|
2184
2053
|
"200": {
|
|
@@ -2223,7 +2092,7 @@
|
|
|
2223
2092
|
"summary": "Create a dialect",
|
|
2224
2093
|
"description": "Create a new shared dialect.",
|
|
2225
2094
|
"tags": [
|
|
2226
|
-
"
|
|
2095
|
+
"Schemas"
|
|
2227
2096
|
],
|
|
2228
2097
|
"requestBody": {
|
|
2229
2098
|
"required": true,
|
|
@@ -2273,7 +2142,7 @@
|
|
|
2273
2142
|
"operationId": "getDialect",
|
|
2274
2143
|
"summary": "Get a dialect",
|
|
2275
2144
|
"tags": [
|
|
2276
|
-
"
|
|
2145
|
+
"Schemas"
|
|
2277
2146
|
],
|
|
2278
2147
|
"parameters": [
|
|
2279
2148
|
{
|
|
@@ -2307,7 +2176,7 @@
|
|
|
2307
2176
|
"summary": "Update a dialect",
|
|
2308
2177
|
"description": "Partial update. Only the keys present on the body are patched. Bumps the stored `version`.",
|
|
2309
2178
|
"tags": [
|
|
2310
|
-
"
|
|
2179
|
+
"Schemas"
|
|
2311
2180
|
],
|
|
2312
2181
|
"parameters": [
|
|
2313
2182
|
{
|
|
@@ -2353,7 +2222,7 @@
|
|
|
2353
2222
|
"operationId": "deleteDialect",
|
|
2354
2223
|
"summary": "Delete a dialect",
|
|
2355
2224
|
"tags": [
|
|
2356
|
-
"
|
|
2225
|
+
"Schemas"
|
|
2357
2226
|
],
|
|
2358
2227
|
"parameters": [
|
|
2359
2228
|
{
|
|
@@ -2394,7 +2263,7 @@
|
|
|
2394
2263
|
"operationId": "listMatchingConfigs",
|
|
2395
2264
|
"summary": "List matching configurations",
|
|
2396
2265
|
"tags": [
|
|
2397
|
-
"
|
|
2266
|
+
"Intelligence"
|
|
2398
2267
|
],
|
|
2399
2268
|
"parameters": [
|
|
2400
2269
|
{
|
|
@@ -2457,7 +2326,7 @@
|
|
|
2457
2326
|
"summary": "Create a matching configuration",
|
|
2458
2327
|
"description": "Link a reference dataset to a target scope via weighted field mappings.\nThe reference dataset must belong to the authenticated customer.\n",
|
|
2459
2328
|
"tags": [
|
|
2460
|
-
"
|
|
2329
|
+
"Intelligence"
|
|
2461
2330
|
],
|
|
2462
2331
|
"requestBody": {
|
|
2463
2332
|
"required": true,
|
|
@@ -2510,7 +2379,7 @@
|
|
|
2510
2379
|
"operationId": "getMatchingConfig",
|
|
2511
2380
|
"summary": "Get a matching configuration",
|
|
2512
2381
|
"tags": [
|
|
2513
|
-
"
|
|
2382
|
+
"Intelligence"
|
|
2514
2383
|
],
|
|
2515
2384
|
"parameters": [
|
|
2516
2385
|
{
|
|
@@ -2544,7 +2413,7 @@
|
|
|
2544
2413
|
"summary": "Update a matching configuration",
|
|
2545
2414
|
"description": "Partial update — only provided keys are applied.",
|
|
2546
2415
|
"tags": [
|
|
2547
|
-
"
|
|
2416
|
+
"Intelligence"
|
|
2548
2417
|
],
|
|
2549
2418
|
"parameters": [
|
|
2550
2419
|
{
|
|
@@ -2590,7 +2459,7 @@
|
|
|
2590
2459
|
"operationId": "deleteMatchingConfig",
|
|
2591
2460
|
"summary": "Delete a matching configuration",
|
|
2592
2461
|
"tags": [
|
|
2593
|
-
"
|
|
2462
|
+
"Intelligence"
|
|
2594
2463
|
],
|
|
2595
2464
|
"parameters": [
|
|
2596
2465
|
{
|
|
@@ -2632,7 +2501,7 @@
|
|
|
2632
2501
|
"summary": "Trigger a matching run",
|
|
2633
2502
|
"description": "Queue a new matching run for this configuration. The run is processed\nasynchronously; poll `GET /v1/matching/runs/{id}` for status.\n",
|
|
2634
2503
|
"tags": [
|
|
2635
|
-
"
|
|
2504
|
+
"Intelligence"
|
|
2636
2505
|
],
|
|
2637
2506
|
"parameters": [
|
|
2638
2507
|
{
|
|
@@ -2678,7 +2547,7 @@
|
|
|
2678
2547
|
"summary": "List matching runs",
|
|
2679
2548
|
"description": "Returns up to the 100 most recent matching runs for the authenticated\ncustomer, optionally filtered by `config_id`. This endpoint is not\ncursor-paginated.\n",
|
|
2680
2549
|
"tags": [
|
|
2681
|
-
"
|
|
2550
|
+
"Intelligence"
|
|
2682
2551
|
],
|
|
2683
2552
|
"parameters": [
|
|
2684
2553
|
{
|
|
@@ -2726,7 +2595,7 @@
|
|
|
2726
2595
|
"summary": "Get a matching run",
|
|
2727
2596
|
"description": "Returns the run summary together with up to the 50 top-confidence match results.",
|
|
2728
2597
|
"tags": [
|
|
2729
|
-
"
|
|
2598
|
+
"Intelligence"
|
|
2730
2599
|
],
|
|
2731
2600
|
"parameters": [
|
|
2732
2601
|
{
|
|
@@ -2762,7 +2631,7 @@
|
|
|
2762
2631
|
"summary": "Cancel a matching run",
|
|
2763
2632
|
"description": "Cancel a queued or running matching run. Runs already in a terminal\nstate (`completed`, `failed`, `cancelled`) return 400.\n",
|
|
2764
2633
|
"tags": [
|
|
2765
|
-
"
|
|
2634
|
+
"Intelligence"
|
|
2766
2635
|
],
|
|
2767
2636
|
"parameters": [
|
|
2768
2637
|
{
|
|
@@ -2801,7 +2670,7 @@
|
|
|
2801
2670
|
"summary": "List routing rules",
|
|
2802
2671
|
"description": "Paginated list of document routing rules, ordered by priority ascending (lowest runs first).",
|
|
2803
2672
|
"tags": [
|
|
2804
|
-
"
|
|
2673
|
+
"Delivery"
|
|
2805
2674
|
],
|
|
2806
2675
|
"parameters": [
|
|
2807
2676
|
{
|
|
@@ -2864,7 +2733,7 @@
|
|
|
2864
2733
|
"summary": "Create a routing rule",
|
|
2865
2734
|
"description": "Create a rule that fires on `document_classified` triggers. The\n`actions.type` key (when present) controls the action kind\n(`route_to_schema` by default).\n",
|
|
2866
2735
|
"tags": [
|
|
2867
|
-
"
|
|
2736
|
+
"Delivery"
|
|
2868
2737
|
],
|
|
2869
2738
|
"requestBody": {
|
|
2870
2739
|
"required": true,
|
|
@@ -2914,7 +2783,7 @@
|
|
|
2914
2783
|
"operationId": "getRoutingRule",
|
|
2915
2784
|
"summary": "Get a routing rule",
|
|
2916
2785
|
"tags": [
|
|
2917
|
-
"
|
|
2786
|
+
"Delivery"
|
|
2918
2787
|
],
|
|
2919
2788
|
"parameters": [
|
|
2920
2789
|
{
|
|
@@ -2948,7 +2817,7 @@
|
|
|
2948
2817
|
"summary": "Update a routing rule",
|
|
2949
2818
|
"description": "Partial update; only provided keys are patched.",
|
|
2950
2819
|
"tags": [
|
|
2951
|
-
"
|
|
2820
|
+
"Delivery"
|
|
2952
2821
|
],
|
|
2953
2822
|
"parameters": [
|
|
2954
2823
|
{
|
|
@@ -2994,7 +2863,7 @@
|
|
|
2994
2863
|
"operationId": "deleteRoutingRule",
|
|
2995
2864
|
"summary": "Delete a routing rule",
|
|
2996
2865
|
"tags": [
|
|
2997
|
-
"
|
|
2866
|
+
"Delivery"
|
|
2998
2867
|
],
|
|
2999
2868
|
"parameters": [
|
|
3000
2869
|
{
|
|
@@ -4358,7 +4227,7 @@
|
|
|
4358
4227
|
"summary": "Filter documents with structured conditions",
|
|
4359
4228
|
"description": "Query documents using an ordered list of filter conditions against\nmaterialised field values. Optional free-text `search` applies\nalongside the structured filter. `limit` is clamped to a server-side\nmaximum of 500.\n",
|
|
4360
4229
|
"tags": [
|
|
4361
|
-
"
|
|
4230
|
+
"Delivery"
|
|
4362
4231
|
],
|
|
4363
4232
|
"requestBody": {
|
|
4364
4233
|
"required": true,
|
|
@@ -4410,7 +4279,7 @@
|
|
|
4410
4279
|
"summary": "Omnisearch across documents, fields, and schemas",
|
|
4411
4280
|
"description": "Full-text search that returns multiple result collections in a single\nresponse: matching documents, field matches, sources, schemas, and\nfields.\n",
|
|
4412
4281
|
"tags": [
|
|
4413
|
-
"
|
|
4282
|
+
"Delivery"
|
|
4414
4283
|
],
|
|
4415
4284
|
"parameters": [
|
|
4416
4285
|
{
|
|
@@ -4459,7 +4328,7 @@
|
|
|
4459
4328
|
"summary": "List review queue records",
|
|
4460
4329
|
"description": "Paginated list of validation records awaiting or having completed review.",
|
|
4461
4330
|
"tags": [
|
|
4462
|
-
"
|
|
4331
|
+
"Platform"
|
|
4463
4332
|
],
|
|
4464
4333
|
"parameters": [
|
|
4465
4334
|
{
|
|
@@ -4532,7 +4401,7 @@
|
|
|
4532
4401
|
"summary": "Apply a review action to many records",
|
|
4533
4402
|
"description": "Approve or reject many validation records in one call. Failed ids\n(not found or not owned by the customer) are reported in the\n`results` array rather than aborting the whole batch.\n",
|
|
4534
4403
|
"tags": [
|
|
4535
|
-
"
|
|
4404
|
+
"Platform"
|
|
4536
4405
|
],
|
|
4537
4406
|
"requestBody": {
|
|
4538
4407
|
"required": true,
|
|
@@ -4573,7 +4442,7 @@
|
|
|
4573
4442
|
"summary": "Get a review record",
|
|
4574
4443
|
"description": "Returns the full record including per-field decisions and low-confidence field list.",
|
|
4575
4444
|
"tags": [
|
|
4576
|
-
"
|
|
4445
|
+
"Platform"
|
|
4577
4446
|
],
|
|
4578
4447
|
"parameters": [
|
|
4579
4448
|
{
|
|
@@ -4608,7 +4477,7 @@
|
|
|
4608
4477
|
"operationId": "performReviewAction",
|
|
4609
4478
|
"summary": "Approve or reject a review record",
|
|
4610
4479
|
"tags": [
|
|
4611
|
-
"
|
|
4480
|
+
"Platform"
|
|
4612
4481
|
],
|
|
4613
4482
|
"parameters": [
|
|
4614
4483
|
{
|
|
@@ -4656,7 +4525,7 @@
|
|
|
4656
4525
|
"operationId": "listGroundTruthDatasets",
|
|
4657
4526
|
"summary": "List ground truth datasets",
|
|
4658
4527
|
"tags": [
|
|
4659
|
-
"
|
|
4528
|
+
"Platform"
|
|
4660
4529
|
],
|
|
4661
4530
|
"parameters": [
|
|
4662
4531
|
{
|
|
@@ -4718,7 +4587,7 @@
|
|
|
4718
4587
|
"operationId": "createGroundTruthDataset",
|
|
4719
4588
|
"summary": "Create a ground truth dataset",
|
|
4720
4589
|
"tags": [
|
|
4721
|
-
"
|
|
4590
|
+
"Platform"
|
|
4722
4591
|
],
|
|
4723
4592
|
"requestBody": {
|
|
4724
4593
|
"required": true,
|
|
@@ -4769,7 +4638,7 @@
|
|
|
4769
4638
|
"summary": "Get a ground truth dataset",
|
|
4770
4639
|
"description": "Returns the dataset together with its sample entries (curated known-correct values).",
|
|
4771
4640
|
"tags": [
|
|
4772
|
-
"
|
|
4641
|
+
"Platform"
|
|
4773
4642
|
],
|
|
4774
4643
|
"parameters": [
|
|
4775
4644
|
{
|
|
@@ -4804,7 +4673,7 @@
|
|
|
4804
4673
|
"operationId": "listBenchmarkRuns",
|
|
4805
4674
|
"summary": "List benchmark runs",
|
|
4806
4675
|
"tags": [
|
|
4807
|
-
"
|
|
4676
|
+
"Platform"
|
|
4808
4677
|
],
|
|
4809
4678
|
"parameters": [
|
|
4810
4679
|
{
|
|
@@ -4869,7 +4738,7 @@
|
|
|
4869
4738
|
"summary": "Get a benchmark run",
|
|
4870
4739
|
"description": "Returns the benchmark run together with its per-document results.",
|
|
4871
4740
|
"tags": [
|
|
4872
|
-
"
|
|
4741
|
+
"Platform"
|
|
4873
4742
|
],
|
|
4874
4743
|
"parameters": [
|
|
4875
4744
|
{
|
|
@@ -4905,7 +4774,7 @@
|
|
|
4905
4774
|
"summary": "List batch inference runs",
|
|
4906
4775
|
"description": "Documents uploaded with `processing_mode=batch` accumulate in an\n`ExtractionBatch` and are submitted to the provider (Anthropic or\nBedrock) at 50% of the realtime cost with a 48h SLA. This endpoint\nreturns a paginated list of the customer's batches.\n",
|
|
4907
4776
|
"tags": [
|
|
4908
|
-
"Batches"
|
|
4777
|
+
"Jobs & Batches"
|
|
4909
4778
|
],
|
|
4910
4779
|
"parameters": [
|
|
4911
4780
|
{
|
|
@@ -4975,7 +4844,7 @@
|
|
|
4975
4844
|
"summary": "Get a batch inference run",
|
|
4976
4845
|
"description": "Returns the batch metadata plus per-item status for every document in the batch.",
|
|
4977
4846
|
"tags": [
|
|
4978
|
-
"Batches"
|
|
4847
|
+
"Jobs & Batches"
|
|
4979
4848
|
],
|
|
4980
4849
|
"parameters": [
|
|
4981
4850
|
{
|
|
@@ -5011,7 +4880,7 @@
|
|
|
5011
4880
|
"summary": "List cases",
|
|
5012
4881
|
"description": "Cases are document clusters discovered automatically from shared entity values across documents (BFS on the linking graph; inference mode may materialise them as first-class entities).",
|
|
5013
4882
|
"tags": [
|
|
5014
|
-
"
|
|
4883
|
+
"Intelligence"
|
|
5015
4884
|
],
|
|
5016
4885
|
"parameters": [
|
|
5017
4886
|
{
|
|
@@ -5066,7 +4935,7 @@
|
|
|
5066
4935
|
"summary": "Get a case by key",
|
|
5067
4936
|
"description": "Case keys are 8–64 char hex strings (SHA-256 hash of the canonical\nentity-value set that defines the cluster). Returns the label,\nnarrative, linked documents, and anomaly count.\n",
|
|
5068
4937
|
"tags": [
|
|
5069
|
-
"
|
|
4938
|
+
"Intelligence"
|
|
5070
4939
|
],
|
|
5071
4940
|
"parameters": [
|
|
5072
4941
|
{
|
|
@@ -5112,7 +4981,7 @@
|
|
|
5112
4981
|
"summary": "List document types",
|
|
5113
4982
|
"description": "Document types resolved for the authenticated customer, ordered by document count descending.",
|
|
5114
4983
|
"tags": [
|
|
5115
|
-
"
|
|
4984
|
+
"Documents"
|
|
5116
4985
|
],
|
|
5117
4986
|
"responses": {
|
|
5118
4987
|
"200": {
|
|
@@ -5148,7 +5017,7 @@
|
|
|
5148
5017
|
"summary": "Get the document type ontology",
|
|
5149
5018
|
"description": "Returns the canonical category summary (categories, subcategories, and types) used by the classifier.",
|
|
5150
5019
|
"tags": [
|
|
5151
|
-
"
|
|
5020
|
+
"Documents"
|
|
5152
5021
|
],
|
|
5153
5022
|
"responses": {
|
|
5154
5023
|
"200": {
|
|
@@ -5186,7 +5055,7 @@
|
|
|
5186
5055
|
"summary": "List fields",
|
|
5187
5056
|
"description": "Paginated list of fields from the field registry, filterable by search, tier, or cluster.",
|
|
5188
5057
|
"tags": [
|
|
5189
|
-
"
|
|
5058
|
+
"Schemas"
|
|
5190
5059
|
],
|
|
5191
5060
|
"parameters": [
|
|
5192
5061
|
{
|
|
@@ -5266,7 +5135,7 @@
|
|
|
5266
5135
|
"summary": "Cross-schema field overlap",
|
|
5267
5136
|
"description": "Fields appearing in two or more schemas, grouped by `canonical_name`.\nUsed to reconcile field definitions across schemas (a field marked\n`is_universal: true` appears in every schema).\n",
|
|
5268
5137
|
"tags": [
|
|
5269
|
-
"
|
|
5138
|
+
"Schemas"
|
|
5270
5139
|
],
|
|
5271
5140
|
"responses": {
|
|
5272
5141
|
"200": {
|
|
@@ -5302,7 +5171,7 @@
|
|
|
5302
5171
|
"summary": "Get a field",
|
|
5303
5172
|
"description": "Returns the field registry row plus up to 20 most recent occurrences.",
|
|
5304
5173
|
"tags": [
|
|
5305
|
-
"
|
|
5174
|
+
"Schemas"
|
|
5306
5175
|
],
|
|
5307
5176
|
"parameters": [
|
|
5308
5177
|
{
|
|
@@ -5338,7 +5207,7 @@
|
|
|
5338
5207
|
"summary": "Get fields similar to this one",
|
|
5339
5208
|
"description": "Returns up to 10 fields most similar to this one by cosine similarity\non the `name_embedding` vector (all-MiniLM-L6-v2, 384 dims). Returns\nan empty `data` array if the field has no embedding computed yet.\n",
|
|
5340
5209
|
"tags": [
|
|
5341
|
-
"
|
|
5210
|
+
"Schemas"
|
|
5342
5211
|
],
|
|
5343
5212
|
"parameters": [
|
|
5344
5213
|
{
|
|
@@ -5418,7 +5287,7 @@
|
|
|
5418
5287
|
"summary": "List reference datasets",
|
|
5419
5288
|
"description": "Uploaded reference datasets (CSV/XLSX) available for matching configurations.",
|
|
5420
5289
|
"tags": [
|
|
5421
|
-
"
|
|
5290
|
+
"Intelligence"
|
|
5422
5291
|
],
|
|
5423
5292
|
"responses": {
|
|
5424
5293
|
"200": {
|
|
@@ -5453,7 +5322,7 @@
|
|
|
5453
5322
|
"operationId": "getReferenceData",
|
|
5454
5323
|
"summary": "Get a reference dataset",
|
|
5455
5324
|
"tags": [
|
|
5456
|
-
"
|
|
5325
|
+
"Intelligence"
|
|
5457
5326
|
],
|
|
5458
5327
|
"parameters": [
|
|
5459
5328
|
{
|
|
@@ -5486,7 +5355,7 @@
|
|
|
5486
5355
|
"operationId": "deleteReferenceData",
|
|
5487
5356
|
"summary": "Delete a reference dataset",
|
|
5488
5357
|
"tags": [
|
|
5489
|
-
"
|
|
5358
|
+
"Intelligence"
|
|
5490
5359
|
],
|
|
5491
5360
|
"parameters": [
|
|
5492
5361
|
{
|
|
@@ -5527,7 +5396,7 @@
|
|
|
5527
5396
|
"summary": "Get reference dataset rows (paginated)",
|
|
5528
5397
|
"description": "Returns the dataset's rows, paginated with page/limit (limit capped at 500).",
|
|
5529
5398
|
"tags": [
|
|
5530
|
-
"
|
|
5399
|
+
"Intelligence"
|
|
5531
5400
|
],
|
|
5532
5401
|
"parameters": [
|
|
5533
5402
|
{
|
|
@@ -5606,7 +5475,7 @@
|
|
|
5606
5475
|
"summary": "Aggregate API usage stats",
|
|
5607
5476
|
"description": "Returns token and call counts aggregated by `operation_type` and\n`model` over the requested date range. Default range is the last 30\ndays.\n",
|
|
5608
5477
|
"tags": [
|
|
5609
|
-
"
|
|
5478
|
+
"Platform"
|
|
5610
5479
|
],
|
|
5611
5480
|
"parameters": [
|
|
5612
5481
|
{
|
|
@@ -5654,7 +5523,7 @@
|
|
|
5654
5523
|
"summary": "Per-document API usage",
|
|
5655
5524
|
"description": "Returns per-document API usage entries and totals. 404 if no usage records exist for the document.",
|
|
5656
5525
|
"tags": [
|
|
5657
|
-
"
|
|
5526
|
+
"Platform"
|
|
5658
5527
|
],
|
|
5659
5528
|
"parameters": [
|
|
5660
5529
|
{
|
|
@@ -5689,7 +5558,7 @@
|
|
|
5689
5558
|
"operationId": "listResolutions",
|
|
5690
5559
|
"summary": "List resolution runs",
|
|
5691
5560
|
"tags": [
|
|
5692
|
-
"
|
|
5561
|
+
"Intelligence"
|
|
5693
5562
|
],
|
|
5694
5563
|
"parameters": [
|
|
5695
5564
|
{
|
|
@@ -5741,7 +5610,7 @@
|
|
|
5741
5610
|
"summary": "Create a resolution run",
|
|
5742
5611
|
"description": "Start a new resolution run targeting documents from a specific source run.",
|
|
5743
5612
|
"tags": [
|
|
5744
|
-
"
|
|
5613
|
+
"Intelligence"
|
|
5745
5614
|
],
|
|
5746
5615
|
"requestBody": {
|
|
5747
5616
|
"required": true,
|
|
@@ -5792,7 +5661,7 @@
|
|
|
5792
5661
|
"operationId": "getResolution",
|
|
5793
5662
|
"summary": "Get a resolution run",
|
|
5794
5663
|
"tags": [
|
|
5795
|
-
"
|
|
5664
|
+
"Intelligence"
|
|
5796
5665
|
],
|
|
5797
5666
|
"parameters": [
|
|
5798
5667
|
{
|
|
@@ -5825,7 +5694,7 @@
|
|
|
5825
5694
|
"operationId": "deleteResolution",
|
|
5826
5695
|
"summary": "Delete a resolution run",
|
|
5827
5696
|
"tags": [
|
|
5828
|
-
"
|
|
5697
|
+
"Intelligence"
|
|
5829
5698
|
],
|
|
5830
5699
|
"parameters": [
|
|
5831
5700
|
{
|
|
@@ -5861,7 +5730,7 @@
|
|
|
5861
5730
|
"summary": "Get resolution run results",
|
|
5862
5731
|
"description": "Returns the resolved data for all documents in the resolution run.",
|
|
5863
5732
|
"tags": [
|
|
5864
|
-
"
|
|
5733
|
+
"Intelligence"
|
|
5865
5734
|
],
|
|
5866
5735
|
"parameters": [
|
|
5867
5736
|
{
|
|
@@ -5906,7 +5775,7 @@
|
|
|
5906
5775
|
"summary": "Execute a resolution run",
|
|
5907
5776
|
"description": "Trigger execution of a pending resolution run.",
|
|
5908
5777
|
"tags": [
|
|
5909
|
-
"
|
|
5778
|
+
"Intelligence"
|
|
5910
5779
|
],
|
|
5911
5780
|
"parameters": [
|
|
5912
5781
|
{
|
|
@@ -5942,7 +5811,7 @@
|
|
|
5942
5811
|
"summary": "List link keys",
|
|
5943
5812
|
"description": "Returns all configured link keys (field-level entity identifiers used for document linking).",
|
|
5944
5813
|
"tags": [
|
|
5945
|
-
"
|
|
5814
|
+
"Intelligence"
|
|
5946
5815
|
],
|
|
5947
5816
|
"responses": {
|
|
5948
5817
|
"200": {
|
|
@@ -5978,7 +5847,7 @@
|
|
|
5978
5847
|
"summary": "Get links for a document",
|
|
5979
5848
|
"description": "Returns all entity links discovered for a specific document.",
|
|
5980
5849
|
"tags": [
|
|
5981
|
-
"
|
|
5850
|
+
"Intelligence"
|
|
5982
5851
|
],
|
|
5983
5852
|
"parameters": [
|
|
5984
5853
|
{
|
|
@@ -6041,7 +5910,7 @@
|
|
|
6041
5910
|
"summary": "Get the full linking graph",
|
|
6042
5911
|
"description": "Returns the bipartite document-entity graph for the customer.",
|
|
6043
5912
|
"tags": [
|
|
6044
|
-
"
|
|
5913
|
+
"Intelligence"
|
|
6045
5914
|
],
|
|
6046
5915
|
"responses": {
|
|
6047
5916
|
"200": {
|
|
@@ -6085,7 +5954,7 @@
|
|
|
6085
5954
|
"summary": "Get graph neighbourhood for a document",
|
|
6086
5955
|
"description": "Returns the subgraph of entities and linked documents for a specific document.",
|
|
6087
5956
|
"tags": [
|
|
6088
|
-
"
|
|
5957
|
+
"Intelligence"
|
|
6089
5958
|
],
|
|
6090
5959
|
"parameters": [
|
|
6091
5960
|
{
|
|
@@ -6137,7 +6006,7 @@
|
|
|
6137
6006
|
"summary": "Classify link keys",
|
|
6138
6007
|
"description": "Run AI classification on ambiguous fields to determine their link key category (identity, transaction, reference).",
|
|
6139
6008
|
"tags": [
|
|
6140
|
-
"
|
|
6009
|
+
"Intelligence"
|
|
6141
6010
|
],
|
|
6142
6011
|
"responses": {
|
|
6143
6012
|
"200": {
|
|
@@ -6177,7 +6046,7 @@
|
|
|
6177
6046
|
"summary": "Backfill linking data",
|
|
6178
6047
|
"description": "Trigger a backfill of the linking graph for all documents. Useful after link key configuration changes.",
|
|
6179
6048
|
"tags": [
|
|
6180
|
-
"
|
|
6049
|
+
"Intelligence"
|
|
6181
6050
|
],
|
|
6182
6051
|
"responses": {
|
|
6183
6052
|
"202": {
|
|
@@ -6215,7 +6084,7 @@
|
|
|
6215
6084
|
"summary": "Get backfill progress",
|
|
6216
6085
|
"description": "Returns the current progress of an in-flight backfill operation.",
|
|
6217
6086
|
"tags": [
|
|
6218
|
-
"
|
|
6087
|
+
"Intelligence"
|
|
6219
6088
|
],
|
|
6220
6089
|
"responses": {
|
|
6221
6090
|
"200": {
|
|
@@ -6260,7 +6129,7 @@
|
|
|
6260
6129
|
"summary": "Get document-to-case mapping",
|
|
6261
6130
|
"description": "Returns a mapping of document IDs to their assigned case keys.",
|
|
6262
6131
|
"tags": [
|
|
6263
|
-
"
|
|
6132
|
+
"Intelligence"
|
|
6264
6133
|
],
|
|
6265
6134
|
"responses": {
|
|
6266
6135
|
"200": {
|
|
@@ -6297,7 +6166,7 @@
|
|
|
6297
6166
|
"summary": "Get N-Shot summary for a run",
|
|
6298
6167
|
"description": "Returns an aggregate summary of N-Shot comparisons for a job run.",
|
|
6299
6168
|
"tags": [
|
|
6300
|
-
"
|
|
6169
|
+
"Intelligence"
|
|
6301
6170
|
],
|
|
6302
6171
|
"parameters": [
|
|
6303
6172
|
{
|
|
@@ -6342,7 +6211,7 @@
|
|
|
6342
6211
|
"summary": "List N-Shot comparisons",
|
|
6343
6212
|
"description": "Returns all N-Shot comparisons for a job run.",
|
|
6344
6213
|
"tags": [
|
|
6345
|
-
"
|
|
6214
|
+
"Intelligence"
|
|
6346
6215
|
],
|
|
6347
6216
|
"parameters": [
|
|
6348
6217
|
{
|
|
@@ -6395,7 +6264,7 @@
|
|
|
6395
6264
|
"summary": "Get a specific N-Shot comparison",
|
|
6396
6265
|
"description": "Returns a single N-Shot comparison filtered by document and field.",
|
|
6397
6266
|
"tags": [
|
|
6398
|
-
"
|
|
6267
|
+
"Intelligence"
|
|
6399
6268
|
],
|
|
6400
6269
|
"parameters": [
|
|
6401
6270
|
{
|
|
@@ -6460,7 +6329,7 @@
|
|
|
6460
6329
|
"summary": "Override an N-Shot value",
|
|
6461
6330
|
"description": "Manually override the N-Shot selected value for a document-field pair.",
|
|
6462
6331
|
"tags": [
|
|
6463
|
-
"
|
|
6332
|
+
"Intelligence"
|
|
6464
6333
|
],
|
|
6465
6334
|
"parameters": [
|
|
6466
6335
|
{
|
|
@@ -6541,7 +6410,7 @@
|
|
|
6541
6410
|
"summary": "Submit a judge decision for N-Shot",
|
|
6542
6411
|
"description": "Submit an AI or human judge decision on which N-Shot candidate is correct.",
|
|
6543
6412
|
"tags": [
|
|
6544
|
-
"
|
|
6413
|
+
"Intelligence"
|
|
6545
6414
|
],
|
|
6546
6415
|
"parameters": [
|
|
6547
6416
|
{
|
|
@@ -6623,7 +6492,7 @@
|
|
|
6623
6492
|
"summary": "List schema graph classes",
|
|
6624
6493
|
"description": "Returns all classes in the schema graph ontology.",
|
|
6625
6494
|
"tags": [
|
|
6626
|
-
"
|
|
6495
|
+
"Schemas"
|
|
6627
6496
|
],
|
|
6628
6497
|
"responses": {
|
|
6629
6498
|
"200": {
|
|
@@ -6658,7 +6527,7 @@
|
|
|
6658
6527
|
"operationId": "getSchemaGraphClass",
|
|
6659
6528
|
"summary": "Get a schema graph class",
|
|
6660
6529
|
"tags": [
|
|
6661
|
-
"
|
|
6530
|
+
"Schemas"
|
|
6662
6531
|
],
|
|
6663
6532
|
"parameters": [
|
|
6664
6533
|
{
|
|
@@ -6694,7 +6563,7 @@
|
|
|
6694
6563
|
"summary": "List versions of a schema graph class",
|
|
6695
6564
|
"description": "Returns all published versions of a class, ordered by version number descending.",
|
|
6696
6565
|
"tags": [
|
|
6697
|
-
"
|
|
6566
|
+
"Schemas"
|
|
6698
6567
|
],
|
|
6699
6568
|
"parameters": [
|
|
6700
6569
|
{
|
|
@@ -6754,7 +6623,7 @@
|
|
|
6754
6623
|
"operationId": "getSchemaGraphClassVersion",
|
|
6755
6624
|
"summary": "Get a specific version of a schema graph class",
|
|
6756
6625
|
"tags": [
|
|
6757
|
-
"
|
|
6626
|
+
"Schemas"
|
|
6758
6627
|
],
|
|
6759
6628
|
"parameters": [
|
|
6760
6629
|
{
|
|
@@ -6816,7 +6685,7 @@
|
|
|
6816
6685
|
"summary": "List schema graph diffs",
|
|
6817
6686
|
"description": "Returns pending and processed diffs between class versions.",
|
|
6818
6687
|
"tags": [
|
|
6819
|
-
"
|
|
6688
|
+
"Schemas"
|
|
6820
6689
|
],
|
|
6821
6690
|
"responses": {
|
|
6822
6691
|
"200": {
|
|
@@ -6852,7 +6721,7 @@
|
|
|
6852
6721
|
"summary": "Approve a schema graph diff",
|
|
6853
6722
|
"description": "Approve a pending diff, promoting the changes to the live class version.",
|
|
6854
6723
|
"tags": [
|
|
6855
|
-
"
|
|
6724
|
+
"Schemas"
|
|
6856
6725
|
],
|
|
6857
6726
|
"parameters": [
|
|
6858
6727
|
{
|
|
@@ -6888,7 +6757,7 @@
|
|
|
6888
6757
|
"summary": "Reject a schema graph diff",
|
|
6889
6758
|
"description": "Reject a pending diff, discarding the proposed changes.",
|
|
6890
6759
|
"tags": [
|
|
6891
|
-
"
|
|
6760
|
+
"Schemas"
|
|
6892
6761
|
],
|
|
6893
6762
|
"parameters": [
|
|
6894
6763
|
{
|
|
@@ -6924,7 +6793,7 @@
|
|
|
6924
6793
|
"summary": "List schema graph edges",
|
|
6925
6794
|
"description": "Returns all edges (relationships) between schema graph classes.",
|
|
6926
6795
|
"tags": [
|
|
6927
|
-
"
|
|
6796
|
+
"Schemas"
|
|
6928
6797
|
],
|
|
6929
6798
|
"responses": {
|
|
6930
6799
|
"200": {
|
|
@@ -6979,7 +6848,7 @@
|
|
|
6979
6848
|
"summary": "List schema graph aliases",
|
|
6980
6849
|
"description": "Returns all class aliases (alternative names mapping to canonical class IDs).",
|
|
6981
6850
|
"tags": [
|
|
6982
|
-
"
|
|
6851
|
+
"Schemas"
|
|
6983
6852
|
],
|
|
6984
6853
|
"responses": {
|
|
6985
6854
|
"200": {
|
|
@@ -7028,7 +6897,7 @@
|
|
|
7028
6897
|
"summary": "Get schema graph visualization data",
|
|
7029
6898
|
"description": "Returns nodes and edges formatted for graph visualization (D3-compatible).",
|
|
7030
6899
|
"tags": [
|
|
7031
|
-
"
|
|
6900
|
+
"Schemas"
|
|
7032
6901
|
],
|
|
7033
6902
|
"responses": {
|
|
7034
6903
|
"200": {
|
|
@@ -7072,7 +6941,7 @@
|
|
|
7072
6941
|
"summary": "List structuring checks",
|
|
7073
6942
|
"description": "Returns all configured validation checks for the customer.",
|
|
7074
6943
|
"tags": [
|
|
7075
|
-
"
|
|
6944
|
+
"Platform"
|
|
7076
6945
|
],
|
|
7077
6946
|
"parameters": [
|
|
7078
6947
|
{
|
|
@@ -7123,7 +6992,7 @@
|
|
|
7123
6992
|
"operationId": "createStructuringCheck",
|
|
7124
6993
|
"summary": "Create a structuring check",
|
|
7125
6994
|
"tags": [
|
|
7126
|
-
"
|
|
6995
|
+
"Platform"
|
|
7127
6996
|
],
|
|
7128
6997
|
"requestBody": {
|
|
7129
6998
|
"required": true,
|
|
@@ -7163,7 +7032,7 @@
|
|
|
7163
7032
|
"operationId": "getStructuringCheck",
|
|
7164
7033
|
"summary": "Get a structuring check",
|
|
7165
7034
|
"tags": [
|
|
7166
|
-
"
|
|
7035
|
+
"Platform"
|
|
7167
7036
|
],
|
|
7168
7037
|
"parameters": [
|
|
7169
7038
|
{
|
|
@@ -7196,7 +7065,7 @@
|
|
|
7196
7065
|
"operationId": "updateStructuringCheck",
|
|
7197
7066
|
"summary": "Update a structuring check",
|
|
7198
7067
|
"tags": [
|
|
7199
|
-
"
|
|
7068
|
+
"Platform"
|
|
7200
7069
|
],
|
|
7201
7070
|
"parameters": [
|
|
7202
7071
|
{
|
|
@@ -7242,7 +7111,7 @@
|
|
|
7242
7111
|
"operationId": "deleteStructuringCheck",
|
|
7243
7112
|
"summary": "Delete a structuring check",
|
|
7244
7113
|
"tags": [
|
|
7245
|
-
"
|
|
7114
|
+
"Platform"
|
|
7246
7115
|
],
|
|
7247
7116
|
"parameters": [
|
|
7248
7117
|
{
|
|
@@ -7278,7 +7147,7 @@
|
|
|
7278
7147
|
"summary": "List approval gates",
|
|
7279
7148
|
"description": "Returns all configured approval gates for the customer.",
|
|
7280
7149
|
"tags": [
|
|
7281
|
-
"
|
|
7150
|
+
"Platform"
|
|
7282
7151
|
],
|
|
7283
7152
|
"parameters": [
|
|
7284
7153
|
{
|
|
@@ -7329,7 +7198,7 @@
|
|
|
7329
7198
|
"operationId": "createStructuringGate",
|
|
7330
7199
|
"summary": "Create an approval gate",
|
|
7331
7200
|
"tags": [
|
|
7332
|
-
"
|
|
7201
|
+
"Platform"
|
|
7333
7202
|
],
|
|
7334
7203
|
"requestBody": {
|
|
7335
7204
|
"required": true,
|
|
@@ -7369,7 +7238,7 @@
|
|
|
7369
7238
|
"operationId": "getStructuringGate",
|
|
7370
7239
|
"summary": "Get an approval gate",
|
|
7371
7240
|
"tags": [
|
|
7372
|
-
"
|
|
7241
|
+
"Platform"
|
|
7373
7242
|
],
|
|
7374
7243
|
"parameters": [
|
|
7375
7244
|
{
|
|
@@ -7402,7 +7271,7 @@
|
|
|
7402
7271
|
"operationId": "updateStructuringGate",
|
|
7403
7272
|
"summary": "Update an approval gate",
|
|
7404
7273
|
"tags": [
|
|
7405
|
-
"
|
|
7274
|
+
"Platform"
|
|
7406
7275
|
],
|
|
7407
7276
|
"parameters": [
|
|
7408
7277
|
{
|
|
@@ -7448,7 +7317,7 @@
|
|
|
7448
7317
|
"operationId": "deleteStructuringGate",
|
|
7449
7318
|
"summary": "Delete an approval gate",
|
|
7450
7319
|
"tags": [
|
|
7451
|
-
"
|
|
7320
|
+
"Platform"
|
|
7452
7321
|
],
|
|
7453
7322
|
"parameters": [
|
|
7454
7323
|
{
|
|
@@ -7483,7 +7352,7 @@
|
|
|
7483
7352
|
"operationId": "addStructuringGateRule",
|
|
7484
7353
|
"summary": "Add a rule to an approval gate",
|
|
7485
7354
|
"tags": [
|
|
7486
|
-
"
|
|
7355
|
+
"Platform"
|
|
7487
7356
|
],
|
|
7488
7357
|
"parameters": [
|
|
7489
7358
|
{
|
|
@@ -7544,7 +7413,7 @@
|
|
|
7544
7413
|
"operationId": "deleteStructuringGateRule",
|
|
7545
7414
|
"summary": "Remove a rule from an approval gate",
|
|
7546
7415
|
"tags": [
|
|
7547
|
-
"
|
|
7416
|
+
"Platform"
|
|
7548
7417
|
],
|
|
7549
7418
|
"parameters": [
|
|
7550
7419
|
{
|
|
@@ -7600,7 +7469,7 @@
|
|
|
7600
7469
|
"summary": "Get check results for a structuring result",
|
|
7601
7470
|
"description": "Returns the validation check outcomes for a specific structuring result.",
|
|
7602
7471
|
"tags": [
|
|
7603
|
-
"
|
|
7472
|
+
"Platform"
|
|
7604
7473
|
],
|
|
7605
7474
|
"parameters": [
|
|
7606
7475
|
{
|
|
@@ -7663,7 +7532,7 @@
|
|
|
7663
7532
|
"summary": "List pending approvals",
|
|
7664
7533
|
"description": "Returns structuring results awaiting manual approval.",
|
|
7665
7534
|
"tags": [
|
|
7666
|
-
"
|
|
7535
|
+
"Platform"
|
|
7667
7536
|
],
|
|
7668
7537
|
"parameters": [
|
|
7669
7538
|
{
|
|
@@ -7714,7 +7583,7 @@
|
|
|
7714
7583
|
"operationId": "approveStructuringResult",
|
|
7715
7584
|
"summary": "Approve a structuring result",
|
|
7716
7585
|
"tags": [
|
|
7717
|
-
"
|
|
7586
|
+
"Platform"
|
|
7718
7587
|
],
|
|
7719
7588
|
"parameters": [
|
|
7720
7589
|
{
|
|
@@ -7760,7 +7629,7 @@
|
|
|
7760
7629
|
"operationId": "rejectStructuringResult",
|
|
7761
7630
|
"summary": "Reject a structuring result",
|
|
7762
7631
|
"tags": [
|
|
7763
|
-
"
|
|
7632
|
+
"Platform"
|
|
7764
7633
|
],
|
|
7765
7634
|
"parameters": [
|
|
7766
7635
|
{
|
|
@@ -7807,7 +7676,7 @@
|
|
|
7807
7676
|
"summary": "Trigger delivery for a structuring run",
|
|
7808
7677
|
"description": "Emit delivery signals for all approved results in the run.",
|
|
7809
7678
|
"tags": [
|
|
7810
|
-
"
|
|
7679
|
+
"Platform"
|
|
7811
7680
|
],
|
|
7812
7681
|
"parameters": [
|
|
7813
7682
|
{
|
|
@@ -7859,7 +7728,7 @@
|
|
|
7859
7728
|
"summary": "Get telemetry summary for a schema",
|
|
7860
7729
|
"description": "Aggregate structuring metrics for a schema — capture hit rate, synthesize rate, strategy distribution, tier funnel.",
|
|
7861
7730
|
"tags": [
|
|
7862
|
-
"
|
|
7731
|
+
"Platform"
|
|
7863
7732
|
],
|
|
7864
7733
|
"parameters": [
|
|
7865
7734
|
{
|
|
@@ -7896,7 +7765,7 @@
|
|
|
7896
7765
|
"summary": "Get telemetry trend for a schema",
|
|
7897
7766
|
"description": "Time-series telemetry data for a schema over recent runs.",
|
|
7898
7767
|
"tags": [
|
|
7899
|
-
"
|
|
7768
|
+
"Platform"
|
|
7900
7769
|
],
|
|
7901
7770
|
"parameters": [
|
|
7902
7771
|
{
|
|
@@ -7941,7 +7810,7 @@
|
|
|
7941
7810
|
"summary": "Get per-field telemetry for a schema",
|
|
7942
7811
|
"description": "Field-level structuring metrics — per-field state distribution, capture rates, and strategy breakdown.",
|
|
7943
7812
|
"tags": [
|
|
7944
|
-
"
|
|
7813
|
+
"Platform"
|
|
7945
7814
|
],
|
|
7946
7815
|
"parameters": [
|
|
7947
7816
|
{
|
|
@@ -7986,7 +7855,7 @@
|
|
|
7986
7855
|
"summary": "Get telemetry summary for a run",
|
|
7987
7856
|
"description": "Aggregate structuring metrics for a specific job run.",
|
|
7988
7857
|
"tags": [
|
|
7989
|
-
"
|
|
7858
|
+
"Platform"
|
|
7990
7859
|
],
|
|
7991
7860
|
"parameters": [
|
|
7992
7861
|
{
|
|
@@ -8023,7 +7892,7 @@
|
|
|
8023
7892
|
"summary": "List golden samples",
|
|
8024
7893
|
"description": "Returns all golden sample datasets for the customer.",
|
|
8025
7894
|
"tags": [
|
|
8026
|
-
"
|
|
7895
|
+
"Platform"
|
|
8027
7896
|
],
|
|
8028
7897
|
"parameters": [
|
|
8029
7898
|
{
|
|
@@ -8076,7 +7945,7 @@
|
|
|
8076
7945
|
"operationId": "getGoldenSample",
|
|
8077
7946
|
"summary": "Get a golden sample",
|
|
8078
7947
|
"tags": [
|
|
8079
|
-
"
|
|
7948
|
+
"Platform"
|
|
8080
7949
|
],
|
|
8081
7950
|
"parameters": [
|
|
8082
7951
|
{
|
|
@@ -8109,7 +7978,7 @@
|
|
|
8109
7978
|
"operationId": "deleteGoldenSample",
|
|
8110
7979
|
"summary": "Delete a golden sample",
|
|
8111
7980
|
"tags": [
|
|
8112
|
-
"
|
|
7981
|
+
"Platform"
|
|
8113
7982
|
],
|
|
8114
7983
|
"parameters": [
|
|
8115
7984
|
{
|
|
@@ -8144,7 +8013,7 @@
|
|
|
8144
8013
|
"operationId": "listValidationRuns",
|
|
8145
8014
|
"summary": "List validation runs",
|
|
8146
8015
|
"tags": [
|
|
8147
|
-
"
|
|
8016
|
+
"Platform"
|
|
8148
8017
|
],
|
|
8149
8018
|
"parameters": [
|
|
8150
8019
|
{
|
|
@@ -8196,7 +8065,7 @@
|
|
|
8196
8065
|
"summary": "Create a validation run",
|
|
8197
8066
|
"description": "Start a new validation run against a golden sample dataset.",
|
|
8198
8067
|
"tags": [
|
|
8199
|
-
"
|
|
8068
|
+
"Platform"
|
|
8200
8069
|
],
|
|
8201
8070
|
"requestBody": {
|
|
8202
8071
|
"required": true,
|
|
@@ -8253,7 +8122,7 @@
|
|
|
8253
8122
|
"operationId": "getValidationRun",
|
|
8254
8123
|
"summary": "Get a validation run",
|
|
8255
8124
|
"tags": [
|
|
8256
|
-
"
|
|
8125
|
+
"Platform"
|
|
8257
8126
|
],
|
|
8258
8127
|
"parameters": [
|
|
8259
8128
|
{
|
|
@@ -8286,7 +8155,7 @@
|
|
|
8286
8155
|
"operationId": "deleteValidationRun",
|
|
8287
8156
|
"summary": "Delete a validation run",
|
|
8288
8157
|
"tags": [
|
|
8289
|
-
"
|
|
8158
|
+
"Platform"
|
|
8290
8159
|
],
|
|
8291
8160
|
"parameters": [
|
|
8292
8161
|
{
|
|
@@ -8322,7 +8191,7 @@
|
|
|
8322
8191
|
"summary": "Get validation run results",
|
|
8323
8192
|
"description": "Returns per-document and per-field accuracy results for the validation run.",
|
|
8324
8193
|
"tags": [
|
|
8325
|
-
"
|
|
8194
|
+
"Platform"
|
|
8326
8195
|
],
|
|
8327
8196
|
"parameters": [
|
|
8328
8197
|
{
|
|
@@ -8378,7 +8247,7 @@
|
|
|
8378
8247
|
"summary": "Get credit balance",
|
|
8379
8248
|
"description": "Returns the current credit balance for the authenticated customer.",
|
|
8380
8249
|
"tags": [
|
|
8381
|
-
"
|
|
8250
|
+
"Platform"
|
|
8382
8251
|
],
|
|
8383
8252
|
"responses": {
|
|
8384
8253
|
"200": {
|
|
@@ -8425,7 +8294,7 @@
|
|
|
8425
8294
|
"summary": "Get credit history",
|
|
8426
8295
|
"description": "Returns credit transaction history (purchases, deductions, adjustments).",
|
|
8427
8296
|
"tags": [
|
|
8428
|
-
"
|
|
8297
|
+
"Platform"
|
|
8429
8298
|
],
|
|
8430
8299
|
"parameters": [
|
|
8431
8300
|
{
|
|
@@ -8505,7 +8374,7 @@
|
|
|
8505
8374
|
"summary": "Get credit usage summary",
|
|
8506
8375
|
"description": "Returns aggregate credit usage broken down by feature.",
|
|
8507
8376
|
"tags": [
|
|
8508
|
-
"
|
|
8377
|
+
"Platform"
|
|
8509
8378
|
],
|
|
8510
8379
|
"parameters": [
|
|
8511
8380
|
{
|
|
@@ -8577,7 +8446,7 @@
|
|
|
8577
8446
|
"summary": "Get daily credit usage",
|
|
8578
8447
|
"description": "Returns per-day credit usage for the specified period (default last 30 days).",
|
|
8579
8448
|
"tags": [
|
|
8580
|
-
"
|
|
8449
|
+
"Platform"
|
|
8581
8450
|
],
|
|
8582
8451
|
"parameters": [
|
|
8583
8452
|
{
|
|
@@ -8646,7 +8515,7 @@
|
|
|
8646
8515
|
"summary": "Get credit usage log",
|
|
8647
8516
|
"description": "Returns a detailed per-request usage log with model, tokens, and cost.",
|
|
8648
8517
|
"tags": [
|
|
8649
|
-
"
|
|
8518
|
+
"Platform"
|
|
8650
8519
|
],
|
|
8651
8520
|
"parameters": [
|
|
8652
8521
|
{
|
|
@@ -8725,7 +8594,7 @@
|
|
|
8725
8594
|
"operationId": "updateCaseStatus",
|
|
8726
8595
|
"summary": "Update case status",
|
|
8727
8596
|
"tags": [
|
|
8728
|
-
"
|
|
8597
|
+
"Intelligence"
|
|
8729
8598
|
],
|
|
8730
8599
|
"parameters": [
|
|
8731
8600
|
{
|
|
@@ -8790,7 +8659,7 @@
|
|
|
8790
8659
|
"summary": "Get case edges",
|
|
8791
8660
|
"description": "Returns the entity edges (evidence chain) connecting documents within the case.",
|
|
8792
8661
|
"tags": [
|
|
8793
|
-
"
|
|
8662
|
+
"Intelligence"
|
|
8794
8663
|
],
|
|
8795
8664
|
"parameters": [
|
|
8796
8665
|
{
|
|
@@ -8862,7 +8731,7 @@
|
|
|
8862
8731
|
"summary": "Confirm a case edge",
|
|
8863
8732
|
"description": "Confirm a proposed entity edge between documents.",
|
|
8864
8733
|
"tags": [
|
|
8865
|
-
"
|
|
8734
|
+
"Intelligence"
|
|
8866
8735
|
],
|
|
8867
8736
|
"requestBody": {
|
|
8868
8737
|
"required": true,
|
|
@@ -8928,7 +8797,7 @@
|
|
|
8928
8797
|
"summary": "Reject a case edge",
|
|
8929
8798
|
"description": "Reject a proposed entity edge between documents.",
|
|
8930
8799
|
"tags": [
|
|
8931
|
-
"
|
|
8800
|
+
"Intelligence"
|
|
8932
8801
|
],
|
|
8933
8802
|
"requestBody": {
|
|
8934
8803
|
"required": true,
|
|
@@ -8994,7 +8863,7 @@
|
|
|
8994
8863
|
"summary": "Split a case",
|
|
8995
8864
|
"description": "Split a case into two separate cases by dividing documents.",
|
|
8996
8865
|
"tags": [
|
|
8997
|
-
"
|
|
8866
|
+
"Intelligence"
|
|
8998
8867
|
],
|
|
8999
8868
|
"parameters": [
|
|
9000
8869
|
{
|
|
@@ -9071,7 +8940,7 @@
|
|
|
9071
8940
|
"summary": "Merge cases",
|
|
9072
8941
|
"description": "Merge another case into this one, combining all documents.",
|
|
9073
8942
|
"tags": [
|
|
9074
|
-
"
|
|
8943
|
+
"Intelligence"
|
|
9075
8944
|
],
|
|
9076
8945
|
"parameters": [
|
|
9077
8946
|
{
|
|
@@ -9135,7 +9004,7 @@
|
|
|
9135
9004
|
"summary": "Get case completeness",
|
|
9136
9005
|
"description": "Returns a completeness assessment for the case (expected vs. present document types, missing fields).",
|
|
9137
9006
|
"tags": [
|
|
9138
|
-
"
|
|
9007
|
+
"Intelligence"
|
|
9139
9008
|
],
|
|
9140
9009
|
"parameters": [
|
|
9141
9010
|
{
|
|
@@ -9201,7 +9070,7 @@
|
|
|
9201
9070
|
"summary": "Pin documents to a case",
|
|
9202
9071
|
"description": "Manually pin one or more documents to a case.",
|
|
9203
9072
|
"tags": [
|
|
9204
|
-
"
|
|
9073
|
+
"Intelligence"
|
|
9205
9074
|
],
|
|
9206
9075
|
"parameters": [
|
|
9207
9076
|
{
|
|
@@ -9269,7 +9138,7 @@
|
|
|
9269
9138
|
"summary": "Remove documents from a case",
|
|
9270
9139
|
"description": "Remove one or more manually-pinned documents from a case.",
|
|
9271
9140
|
"tags": [
|
|
9272
|
-
"
|
|
9141
|
+
"Intelligence"
|
|
9273
9142
|
],
|
|
9274
9143
|
"parameters": [
|
|
9275
9144
|
{
|
|
@@ -9337,7 +9206,7 @@
|
|
|
9337
9206
|
"summary": "Sync batch status with provider",
|
|
9338
9207
|
"description": "Force a status sync with the batch inference provider (Anthropic or Bedrock).",
|
|
9339
9208
|
"tags": [
|
|
9340
|
-
"Batches"
|
|
9209
|
+
"Jobs & Batches"
|
|
9341
9210
|
],
|
|
9342
9211
|
"parameters": [
|
|
9343
9212
|
{
|
|
@@ -9373,7 +9242,7 @@
|
|
|
9373
9242
|
"summary": "Cancel a batch inference run",
|
|
9374
9243
|
"description": "Cancel an in-flight batch. Only batches in `accumulating` or `submitted` status can be cancelled.",
|
|
9375
9244
|
"tags": [
|
|
9376
|
-
"Batches"
|
|
9245
|
+
"Jobs & Batches"
|
|
9377
9246
|
],
|
|
9378
9247
|
"parameters": [
|
|
9379
9248
|
{
|
|
@@ -9412,7 +9281,7 @@
|
|
|
9412
9281
|
"summary": "Trigger a smart matching run",
|
|
9413
9282
|
"description": "AI-driven matching run that auto-suggests field mappings and strategies based on schema and reference data.",
|
|
9414
9283
|
"tags": [
|
|
9415
|
-
"
|
|
9284
|
+
"Intelligence"
|
|
9416
9285
|
],
|
|
9417
9286
|
"requestBody": {
|
|
9418
9287
|
"required": true,
|
|
@@ -9467,7 +9336,7 @@
|
|
|
9467
9336
|
"summary": "AI-resolve ambiguous matches",
|
|
9468
9337
|
"description": "Use AI to resolve ambiguous match candidates where confidence is below the auto-accept threshold.",
|
|
9469
9338
|
"tags": [
|
|
9470
|
-
"
|
|
9339
|
+
"Intelligence"
|
|
9471
9340
|
],
|
|
9472
9341
|
"requestBody": {
|
|
9473
9342
|
"required": true,
|
|
@@ -9530,7 +9399,7 @@
|
|
|
9530
9399
|
"summary": "List matching strategies",
|
|
9531
9400
|
"description": "Returns available matching strategies and their configurations.",
|
|
9532
9401
|
"tags": [
|
|
9533
|
-
"
|
|
9402
|
+
"Intelligence"
|
|
9534
9403
|
],
|
|
9535
9404
|
"responses": {
|
|
9536
9405
|
"200": {
|
|
@@ -9580,7 +9449,7 @@
|
|
|
9580
9449
|
"operationId": "createMatchingStrategy",
|
|
9581
9450
|
"summary": "Create a matching strategy",
|
|
9582
9451
|
"tags": [
|
|
9583
|
-
"
|
|
9452
|
+
"Intelligence"
|
|
9584
9453
|
],
|
|
9585
9454
|
"requestBody": {
|
|
9586
9455
|
"required": true,
|
|
@@ -9639,7 +9508,7 @@
|
|
|
9639
9508
|
"operationId": "getMatchingStrategy",
|
|
9640
9509
|
"summary": "Get a matching strategy",
|
|
9641
9510
|
"tags": [
|
|
9642
|
-
"
|
|
9511
|
+
"Intelligence"
|
|
9643
9512
|
],
|
|
9644
9513
|
"parameters": [
|
|
9645
9514
|
{
|
|
@@ -9673,7 +9542,7 @@
|
|
|
9673
9542
|
"operationId": "updateMatchingStrategy",
|
|
9674
9543
|
"summary": "Update a matching strategy",
|
|
9675
9544
|
"tags": [
|
|
9676
|
-
"
|
|
9545
|
+
"Intelligence"
|
|
9677
9546
|
],
|
|
9678
9547
|
"parameters": [
|
|
9679
9548
|
{
|
|
@@ -9729,7 +9598,7 @@
|
|
|
9729
9598
|
"operationId": "deleteMatchingStrategy",
|
|
9730
9599
|
"summary": "Delete a matching strategy",
|
|
9731
9600
|
"tags": [
|
|
9732
|
-
"
|
|
9601
|
+
"Intelligence"
|
|
9733
9602
|
],
|
|
9734
9603
|
"parameters": [
|
|
9735
9604
|
{
|
|
@@ -9765,7 +9634,7 @@
|
|
|
9765
9634
|
"summary": "Get matching run results",
|
|
9766
9635
|
"description": "Returns per-document match results with top candidates and field-level evidence.",
|
|
9767
9636
|
"tags": [
|
|
9768
|
-
"
|
|
9637
|
+
"Intelligence"
|
|
9769
9638
|
],
|
|
9770
9639
|
"parameters": [
|
|
9771
9640
|
{
|
|
@@ -9810,7 +9679,7 @@
|
|
|
9810
9679
|
"summary": "Get matching run progress",
|
|
9811
9680
|
"description": "Returns the processing progress for an in-flight matching run.",
|
|
9812
9681
|
"tags": [
|
|
9813
|
-
"
|
|
9682
|
+
"Intelligence"
|
|
9814
9683
|
],
|
|
9815
9684
|
"parameters": [
|
|
9816
9685
|
{
|
|
@@ -9862,7 +9731,7 @@
|
|
|
9862
9731
|
"summary": "Submit matching review decisions",
|
|
9863
9732
|
"description": "Submit accept/reject decisions on match candidates.",
|
|
9864
9733
|
"tags": [
|
|
9865
|
-
"
|
|
9734
|
+
"Intelligence"
|
|
9866
9735
|
],
|
|
9867
9736
|
"requestBody": {
|
|
9868
9737
|
"required": true,
|
|
@@ -9944,7 +9813,7 @@
|
|
|
9944
9813
|
"summary": "Assign review records",
|
|
9945
9814
|
"description": "Assign one or more review records to a team member.",
|
|
9946
9815
|
"tags": [
|
|
9947
|
-
"
|
|
9816
|
+
"Platform"
|
|
9948
9817
|
],
|
|
9949
9818
|
"requestBody": {
|
|
9950
9819
|
"required": true,
|
|
@@ -10010,7 +9879,7 @@
|
|
|
10010
9879
|
"summary": "Get review queue statistics",
|
|
10011
9880
|
"description": "Returns aggregate statistics about the review queue (pending, approved, rejected counts).",
|
|
10012
9881
|
"tags": [
|
|
10013
|
-
"
|
|
9882
|
+
"Platform"
|
|
10014
9883
|
],
|
|
10015
9884
|
"responses": {
|
|
10016
9885
|
"200": {
|
|
@@ -10051,7 +9920,7 @@
|
|
|
10051
9920
|
"operationId": "listGroundTruthEntries",
|
|
10052
9921
|
"summary": "List entries in a ground truth dataset",
|
|
10053
9922
|
"tags": [
|
|
10054
|
-
"
|
|
9923
|
+
"Platform"
|
|
10055
9924
|
],
|
|
10056
9925
|
"parameters": [
|
|
10057
9926
|
{
|
|
@@ -10105,7 +9974,7 @@
|
|
|
10105
9974
|
"operationId": "createGroundTruthEntry",
|
|
10106
9975
|
"summary": "Add an entry to a ground truth dataset",
|
|
10107
9976
|
"tags": [
|
|
10108
|
-
"
|
|
9977
|
+
"Platform"
|
|
10109
9978
|
],
|
|
10110
9979
|
"parameters": [
|
|
10111
9980
|
{
|
|
@@ -10171,7 +10040,7 @@
|
|
|
10171
10040
|
"operationId": "updateGroundTruthEntry",
|
|
10172
10041
|
"summary": "Update a ground truth entry",
|
|
10173
10042
|
"tags": [
|
|
10174
|
-
"
|
|
10043
|
+
"Platform"
|
|
10175
10044
|
],
|
|
10176
10045
|
"parameters": [
|
|
10177
10046
|
{
|
|
@@ -10235,7 +10104,7 @@
|
|
|
10235
10104
|
"operationId": "deleteGroundTruthEntry",
|
|
10236
10105
|
"summary": "Delete a ground truth entry",
|
|
10237
10106
|
"tags": [
|
|
10238
|
-
"
|
|
10107
|
+
"Platform"
|
|
10239
10108
|
],
|
|
10240
10109
|
"parameters": [
|
|
10241
10110
|
{
|
|
@@ -10282,7 +10151,7 @@
|
|
|
10282
10151
|
"summary": "Get benchmark results",
|
|
10283
10152
|
"description": "Returns per-document accuracy results for a benchmark run.",
|
|
10284
10153
|
"tags": [
|
|
10285
|
-
"
|
|
10154
|
+
"Platform"
|
|
10286
10155
|
],
|
|
10287
10156
|
"parameters": [
|
|
10288
10157
|
{
|
|
@@ -10326,7 +10195,7 @@
|
|
|
10326
10195
|
"summary": "Compare two benchmark runs",
|
|
10327
10196
|
"description": "Returns accuracy deltas between the target benchmark and a comparison run.",
|
|
10328
10197
|
"tags": [
|
|
10329
|
-
"
|
|
10198
|
+
"Platform"
|
|
10330
10199
|
],
|
|
10331
10200
|
"parameters": [
|
|
10332
10201
|
{
|
|
@@ -10398,7 +10267,7 @@
|
|
|
10398
10267
|
"summary": "Create reference data from JSON",
|
|
10399
10268
|
"description": "Create a new reference dataset by uploading JSON data directly (alternative to CSV/XLSX file upload).",
|
|
10400
10269
|
"tags": [
|
|
10401
|
-
"
|
|
10270
|
+
"Intelligence"
|
|
10402
10271
|
],
|
|
10403
10272
|
"requestBody": {
|
|
10404
10273
|
"required": true,
|
|
@@ -10464,7 +10333,7 @@
|
|
|
10464
10333
|
"summary": "Get workspace context",
|
|
10465
10334
|
"description": "Returns a snapshot of the workspace's current state for the embedded\nAI agent — document counts, active schemas, recent jobs, and feature\nflags. Useful for bootstrapping agent conversations.\n",
|
|
10466
10335
|
"tags": [
|
|
10467
|
-
"
|
|
10336
|
+
"Platform"
|
|
10468
10337
|
],
|
|
10469
10338
|
"responses": {
|
|
10470
10339
|
"200": {
|
|
@@ -10519,7 +10388,7 @@
|
|
|
10519
10388
|
"summary": "List available agent tools",
|
|
10520
10389
|
"description": "Returns the set of tools the embedded AI agent can invoke in the\ncurrent workspace, including their names, descriptions, parameter\nschemas, and tier requirements.\n",
|
|
10521
10390
|
"tags": [
|
|
10522
|
-
"
|
|
10391
|
+
"Platform"
|
|
10523
10392
|
],
|
|
10524
10393
|
"responses": {
|
|
10525
10394
|
"200": {
|
|
@@ -10897,6 +10766,99 @@
|
|
|
10897
10766
|
}
|
|
10898
10767
|
}
|
|
10899
10768
|
},
|
|
10769
|
+
"WebhookEvent": {
|
|
10770
|
+
"type": "object",
|
|
10771
|
+
"description": "Webhook delivery payload sent to configured destinations.",
|
|
10772
|
+
"required": [
|
|
10773
|
+
"event"
|
|
10774
|
+
],
|
|
10775
|
+
"properties": {
|
|
10776
|
+
"event": {
|
|
10777
|
+
"type": "object",
|
|
10778
|
+
"required": [
|
|
10779
|
+
"event_type",
|
|
10780
|
+
"event_id",
|
|
10781
|
+
"binding_id",
|
|
10782
|
+
"idempotency_key",
|
|
10783
|
+
"attempt",
|
|
10784
|
+
"delivered_at"
|
|
10785
|
+
],
|
|
10786
|
+
"properties": {
|
|
10787
|
+
"event_type": {
|
|
10788
|
+
"type": "string",
|
|
10789
|
+
"description": "The event that triggered this delivery. One of:\ndocument.extracted, document.extraction_failed,\nrun.dataspace.completed, run.dataspace.failed,\nresult.dataspace.completed, result.dataspace.failed,\nrun.structuring.completed, run.structuring.failed,\nrun.resolution.completed, run.resolution.failed,\nrun.extraction.completed, run.extraction.failed,\nresult.flagged, result.approved, result.rejected,\ndelivery.item.completed, delivery.item.failed.\n",
|
|
10790
|
+
"example": "document.extracted"
|
|
10791
|
+
},
|
|
10792
|
+
"event_id": {
|
|
10793
|
+
"type": "string",
|
|
10794
|
+
"description": "Monotonically increasing event sequence ID.",
|
|
10795
|
+
"example": "42"
|
|
10796
|
+
},
|
|
10797
|
+
"binding_id": {
|
|
10798
|
+
"type": "string",
|
|
10799
|
+
"format": "uuid",
|
|
10800
|
+
"description": "The delivery binding that matched this event.",
|
|
10801
|
+
"example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
|
10802
|
+
},
|
|
10803
|
+
"idempotency_key": {
|
|
10804
|
+
"type": "string",
|
|
10805
|
+
"description": "32-character hex key derived from binding_id + event_id. Stable across retries.",
|
|
10806
|
+
"example": "c9f3a7e1b2d4f6a8e0c2d4f6a8e0c2d4"
|
|
10807
|
+
},
|
|
10808
|
+
"attempt": {
|
|
10809
|
+
"type": "integer",
|
|
10810
|
+
"description": "Delivery attempt number (1–7).",
|
|
10811
|
+
"example": 1
|
|
10812
|
+
},
|
|
10813
|
+
"delivered_at": {
|
|
10814
|
+
"type": "string",
|
|
10815
|
+
"format": "date-time",
|
|
10816
|
+
"description": "Timestamp of this delivery attempt.",
|
|
10817
|
+
"example": "2026-04-25T14:30:00.000Z"
|
|
10818
|
+
}
|
|
10819
|
+
}
|
|
10820
|
+
},
|
|
10821
|
+
"payload": {
|
|
10822
|
+
"type": "object",
|
|
10823
|
+
"description": "Serialized deliverable data. Shape depends on the deliverable type and serializer format configured on the binding.",
|
|
10824
|
+
"additionalProperties": true,
|
|
10825
|
+
"example": {
|
|
10826
|
+
"document_id": "f0e1d2c3-b4a5-9687-8765-432109876543",
|
|
10827
|
+
"filename": "invoice-042.pdf",
|
|
10828
|
+
"status": "completed",
|
|
10829
|
+
"data": {
|
|
10830
|
+
"invoice_number": "INV-2024-0042",
|
|
10831
|
+
"total_amount": 1250
|
|
10832
|
+
}
|
|
10833
|
+
}
|
|
10834
|
+
},
|
|
10835
|
+
"content": {
|
|
10836
|
+
"type": [
|
|
10837
|
+
"object",
|
|
10838
|
+
"null"
|
|
10839
|
+
],
|
|
10840
|
+
"description": "Binary content envelope (for file-type serializers like CSV/XLSX). Null when payload is used instead.",
|
|
10841
|
+
"properties": {
|
|
10842
|
+
"mime": {
|
|
10843
|
+
"type": "string",
|
|
10844
|
+
"example": "text/csv"
|
|
10845
|
+
},
|
|
10846
|
+
"encoding": {
|
|
10847
|
+
"type": "string",
|
|
10848
|
+
"enum": [
|
|
10849
|
+
"utf-8",
|
|
10850
|
+
"base64"
|
|
10851
|
+
],
|
|
10852
|
+
"example": "utf-8"
|
|
10853
|
+
},
|
|
10854
|
+
"data": {
|
|
10855
|
+
"type": "string",
|
|
10856
|
+
"description": "UTF-8 text or base64-encoded binary."
|
|
10857
|
+
}
|
|
10858
|
+
}
|
|
10859
|
+
}
|
|
10860
|
+
}
|
|
10861
|
+
},
|
|
10900
10862
|
"PaginatedResponse": {
|
|
10901
10863
|
"type": "object",
|
|
10902
10864
|
"properties": {
|