@talonic/docs 0.11.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 +433 -266
- package/openapi.json +433 -266
- 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",
|
|
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,115 +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."
|
|
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"
|
|
83
59
|
},
|
|
84
60
|
{
|
|
85
|
-
"name": "
|
|
86
|
-
"description": "
|
|
61
|
+
"name": "Intelligence",
|
|
62
|
+
"description": "Reference-data matching, document linking graphs, case discovery, resolution runs, N-Shot comparisons, and reference dataset management."
|
|
87
63
|
},
|
|
88
64
|
{
|
|
89
|
-
"name": "
|
|
90
|
-
"description": "
|
|
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."
|
|
65
|
+
"name": "Platform",
|
|
66
|
+
"description": "Usage accounting, credit balance, quality benchmarks, structuring checks, validation runs, review queue, telemetry metrics, and the embedded AI agent."
|
|
143
67
|
}
|
|
144
68
|
],
|
|
145
69
|
"paths": {
|
|
@@ -1052,6 +976,45 @@
|
|
|
1052
976
|
"application/json": {
|
|
1053
977
|
"schema": {
|
|
1054
978
|
"$ref": "#/components/schemas/ExtractionResponse"
|
|
979
|
+
},
|
|
980
|
+
"example": {
|
|
981
|
+
"id": "d1a2b3c4-5678-9abc-def0-1234567890ab",
|
|
982
|
+
"status": "complete",
|
|
983
|
+
"document": {
|
|
984
|
+
"id": "f0e1d2c3-b4a5-9687-8765-432109876543",
|
|
985
|
+
"filename": "invoice-042.pdf",
|
|
986
|
+
"pages": 3,
|
|
987
|
+
"type_detected": "Invoice"
|
|
988
|
+
},
|
|
989
|
+
"data": {
|
|
990
|
+
"vendor_name": "Acme Corporation Ltd.",
|
|
991
|
+
"total_amount": 1275.5,
|
|
992
|
+
"invoice_number": "INV-2024-0042"
|
|
993
|
+
},
|
|
994
|
+
"confidence": {
|
|
995
|
+
"overall": 0.96,
|
|
996
|
+
"fields": {
|
|
997
|
+
"vendor_name": 1,
|
|
998
|
+
"total_amount": 1,
|
|
999
|
+
"invoice_number": 0.99
|
|
1000
|
+
}
|
|
1001
|
+
},
|
|
1002
|
+
"locked_fields": [
|
|
1003
|
+
"vendor_name",
|
|
1004
|
+
"total_amount"
|
|
1005
|
+
],
|
|
1006
|
+
"processing": {
|
|
1007
|
+
"duration_ms": 3420,
|
|
1008
|
+
"pages_processed": 3,
|
|
1009
|
+
"region": "eu-west"
|
|
1010
|
+
},
|
|
1011
|
+
"created_at": "2026-04-25T14:30:00.000Z",
|
|
1012
|
+
"links": {
|
|
1013
|
+
"self": "/v1/extractions/d1a2b3c4-5678-9abc-def0-1234567890ab",
|
|
1014
|
+
"data": "/v1/extractions/d1a2b3c4-5678-9abc-def0-1234567890ab/data",
|
|
1015
|
+
"document": "/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543",
|
|
1016
|
+
"dashboard": "https://app.talonic.com/extractions/d1a2b3c4-5678-9abc-def0-1234567890ab"
|
|
1017
|
+
}
|
|
1055
1018
|
}
|
|
1056
1019
|
}
|
|
1057
1020
|
}
|
|
@@ -1400,7 +1363,7 @@
|
|
|
1400
1363
|
"summary": "Create and queue a new job",
|
|
1401
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",
|
|
1402
1365
|
"tags": [
|
|
1403
|
-
"Jobs"
|
|
1366
|
+
"Jobs & Batches"
|
|
1404
1367
|
],
|
|
1405
1368
|
"requestBody": {
|
|
1406
1369
|
"required": true,
|
|
@@ -1462,7 +1425,7 @@
|
|
|
1462
1425
|
"operationId": "listJobs",
|
|
1463
1426
|
"summary": "List jobs",
|
|
1464
1427
|
"tags": [
|
|
1465
|
-
"Jobs"
|
|
1428
|
+
"Jobs & Batches"
|
|
1466
1429
|
],
|
|
1467
1430
|
"parameters": [
|
|
1468
1431
|
{
|
|
@@ -1559,7 +1522,7 @@
|
|
|
1559
1522
|
"operationId": "getJob",
|
|
1560
1523
|
"summary": "Get a job",
|
|
1561
1524
|
"tags": [
|
|
1562
|
-
"Jobs"
|
|
1525
|
+
"Jobs & Batches"
|
|
1563
1526
|
],
|
|
1564
1527
|
"parameters": [
|
|
1565
1528
|
{
|
|
@@ -1573,6 +1536,34 @@
|
|
|
1573
1536
|
"application/json": {
|
|
1574
1537
|
"schema": {
|
|
1575
1538
|
"$ref": "#/components/schemas/JobResponse"
|
|
1539
|
+
},
|
|
1540
|
+
"example": {
|
|
1541
|
+
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
|
|
1542
|
+
"name": "Q1 Invoice Processing",
|
|
1543
|
+
"status": "processing",
|
|
1544
|
+
"progress": 45,
|
|
1545
|
+
"estimated_seconds_remaining": null,
|
|
1546
|
+
"schema": {
|
|
1547
|
+
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
|
|
1548
|
+
"name": "Invoice Schema"
|
|
1549
|
+
},
|
|
1550
|
+
"document_count": 150,
|
|
1551
|
+
"completed_documents": 67,
|
|
1552
|
+
"grid_stats": {
|
|
1553
|
+
"total_cells": 8850,
|
|
1554
|
+
"filled": 6200,
|
|
1555
|
+
"empty": 2650,
|
|
1556
|
+
"fill_rate": 0.7
|
|
1557
|
+
},
|
|
1558
|
+
"current_phase": "phase_2_execute",
|
|
1559
|
+
"created_at": "2026-04-25T14:30:00.000Z",
|
|
1560
|
+
"started_at": "2026-04-25T14:30:05.000Z",
|
|
1561
|
+
"completed_at": null,
|
|
1562
|
+
"links": {
|
|
1563
|
+
"self": "/v1/jobs/c3d4e5f6-a7b8-9012-cdef-123456789012",
|
|
1564
|
+
"cancel": "/v1/jobs/c3d4e5f6-a7b8-9012-cdef-123456789012/cancel",
|
|
1565
|
+
"dashboard": "https://app.talonic.com/jobs/c3d4e5f6-a7b8-9012-cdef-123456789012"
|
|
1566
|
+
}
|
|
1576
1567
|
}
|
|
1577
1568
|
}
|
|
1578
1569
|
}
|
|
@@ -1595,7 +1586,7 @@
|
|
|
1595
1586
|
"summary": "Cancel a job",
|
|
1596
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",
|
|
1597
1588
|
"tags": [
|
|
1598
|
-
"Jobs"
|
|
1589
|
+
"Jobs & Batches"
|
|
1599
1590
|
],
|
|
1600
1591
|
"parameters": [
|
|
1601
1592
|
{
|
|
@@ -1637,7 +1628,7 @@
|
|
|
1637
1628
|
"summary": "Get job result rows",
|
|
1638
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",
|
|
1639
1630
|
"tags": [
|
|
1640
|
-
"Jobs"
|
|
1631
|
+
"Jobs & Batches"
|
|
1641
1632
|
],
|
|
1642
1633
|
"parameters": [
|
|
1643
1634
|
{
|
|
@@ -1725,6 +1716,10 @@
|
|
|
1725
1716
|
"application/json": {
|
|
1726
1717
|
"schema": {
|
|
1727
1718
|
"$ref": "#/components/schemas/SourceCreateRequest"
|
|
1719
|
+
},
|
|
1720
|
+
"example": {
|
|
1721
|
+
"name": "Invoice Pipeline",
|
|
1722
|
+
"default_schema_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
|
|
1728
1723
|
}
|
|
1729
1724
|
}
|
|
1730
1725
|
}
|
|
@@ -1750,6 +1745,24 @@
|
|
|
1750
1745
|
}
|
|
1751
1746
|
}
|
|
1752
1747
|
]
|
|
1748
|
+
},
|
|
1749
|
+
"example": {
|
|
1750
|
+
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
1751
|
+
"name": "Invoice Pipeline",
|
|
1752
|
+
"type": "api",
|
|
1753
|
+
"status": "active",
|
|
1754
|
+
"document_count": 0,
|
|
1755
|
+
"default_schema": {
|
|
1756
|
+
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
|
|
1757
|
+
},
|
|
1758
|
+
"endpoint": "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/documents",
|
|
1759
|
+
"api_key": "tlnc_live_src_k8m2n4p6q9r1s3t5",
|
|
1760
|
+
"created_at": "2026-04-25T14:30:00.000Z",
|
|
1761
|
+
"links": {
|
|
1762
|
+
"self": "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
1763
|
+
"documents": "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/documents",
|
|
1764
|
+
"dashboard": "https://app.talonic.com/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
|
1765
|
+
}
|
|
1753
1766
|
}
|
|
1754
1767
|
}
|
|
1755
1768
|
}
|
|
@@ -2034,7 +2047,7 @@
|
|
|
2034
2047
|
"summary": "List dialects",
|
|
2035
2048
|
"description": "Return every shared dialect defined for the authenticated customer.",
|
|
2036
2049
|
"tags": [
|
|
2037
|
-
"
|
|
2050
|
+
"Schemas"
|
|
2038
2051
|
],
|
|
2039
2052
|
"responses": {
|
|
2040
2053
|
"200": {
|
|
@@ -2079,7 +2092,7 @@
|
|
|
2079
2092
|
"summary": "Create a dialect",
|
|
2080
2093
|
"description": "Create a new shared dialect.",
|
|
2081
2094
|
"tags": [
|
|
2082
|
-
"
|
|
2095
|
+
"Schemas"
|
|
2083
2096
|
],
|
|
2084
2097
|
"requestBody": {
|
|
2085
2098
|
"required": true,
|
|
@@ -2129,7 +2142,7 @@
|
|
|
2129
2142
|
"operationId": "getDialect",
|
|
2130
2143
|
"summary": "Get a dialect",
|
|
2131
2144
|
"tags": [
|
|
2132
|
-
"
|
|
2145
|
+
"Schemas"
|
|
2133
2146
|
],
|
|
2134
2147
|
"parameters": [
|
|
2135
2148
|
{
|
|
@@ -2163,7 +2176,7 @@
|
|
|
2163
2176
|
"summary": "Update a dialect",
|
|
2164
2177
|
"description": "Partial update. Only the keys present on the body are patched. Bumps the stored `version`.",
|
|
2165
2178
|
"tags": [
|
|
2166
|
-
"
|
|
2179
|
+
"Schemas"
|
|
2167
2180
|
],
|
|
2168
2181
|
"parameters": [
|
|
2169
2182
|
{
|
|
@@ -2209,7 +2222,7 @@
|
|
|
2209
2222
|
"operationId": "deleteDialect",
|
|
2210
2223
|
"summary": "Delete a dialect",
|
|
2211
2224
|
"tags": [
|
|
2212
|
-
"
|
|
2225
|
+
"Schemas"
|
|
2213
2226
|
],
|
|
2214
2227
|
"parameters": [
|
|
2215
2228
|
{
|
|
@@ -2250,7 +2263,7 @@
|
|
|
2250
2263
|
"operationId": "listMatchingConfigs",
|
|
2251
2264
|
"summary": "List matching configurations",
|
|
2252
2265
|
"tags": [
|
|
2253
|
-
"
|
|
2266
|
+
"Intelligence"
|
|
2254
2267
|
],
|
|
2255
2268
|
"parameters": [
|
|
2256
2269
|
{
|
|
@@ -2313,7 +2326,7 @@
|
|
|
2313
2326
|
"summary": "Create a matching configuration",
|
|
2314
2327
|
"description": "Link a reference dataset to a target scope via weighted field mappings.\nThe reference dataset must belong to the authenticated customer.\n",
|
|
2315
2328
|
"tags": [
|
|
2316
|
-
"
|
|
2329
|
+
"Intelligence"
|
|
2317
2330
|
],
|
|
2318
2331
|
"requestBody": {
|
|
2319
2332
|
"required": true,
|
|
@@ -2366,7 +2379,7 @@
|
|
|
2366
2379
|
"operationId": "getMatchingConfig",
|
|
2367
2380
|
"summary": "Get a matching configuration",
|
|
2368
2381
|
"tags": [
|
|
2369
|
-
"
|
|
2382
|
+
"Intelligence"
|
|
2370
2383
|
],
|
|
2371
2384
|
"parameters": [
|
|
2372
2385
|
{
|
|
@@ -2400,7 +2413,7 @@
|
|
|
2400
2413
|
"summary": "Update a matching configuration",
|
|
2401
2414
|
"description": "Partial update — only provided keys are applied.",
|
|
2402
2415
|
"tags": [
|
|
2403
|
-
"
|
|
2416
|
+
"Intelligence"
|
|
2404
2417
|
],
|
|
2405
2418
|
"parameters": [
|
|
2406
2419
|
{
|
|
@@ -2446,7 +2459,7 @@
|
|
|
2446
2459
|
"operationId": "deleteMatchingConfig",
|
|
2447
2460
|
"summary": "Delete a matching configuration",
|
|
2448
2461
|
"tags": [
|
|
2449
|
-
"
|
|
2462
|
+
"Intelligence"
|
|
2450
2463
|
],
|
|
2451
2464
|
"parameters": [
|
|
2452
2465
|
{
|
|
@@ -2488,7 +2501,7 @@
|
|
|
2488
2501
|
"summary": "Trigger a matching run",
|
|
2489
2502
|
"description": "Queue a new matching run for this configuration. The run is processed\nasynchronously; poll `GET /v1/matching/runs/{id}` for status.\n",
|
|
2490
2503
|
"tags": [
|
|
2491
|
-
"
|
|
2504
|
+
"Intelligence"
|
|
2492
2505
|
],
|
|
2493
2506
|
"parameters": [
|
|
2494
2507
|
{
|
|
@@ -2534,7 +2547,7 @@
|
|
|
2534
2547
|
"summary": "List matching runs",
|
|
2535
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",
|
|
2536
2549
|
"tags": [
|
|
2537
|
-
"
|
|
2550
|
+
"Intelligence"
|
|
2538
2551
|
],
|
|
2539
2552
|
"parameters": [
|
|
2540
2553
|
{
|
|
@@ -2582,7 +2595,7 @@
|
|
|
2582
2595
|
"summary": "Get a matching run",
|
|
2583
2596
|
"description": "Returns the run summary together with up to the 50 top-confidence match results.",
|
|
2584
2597
|
"tags": [
|
|
2585
|
-
"
|
|
2598
|
+
"Intelligence"
|
|
2586
2599
|
],
|
|
2587
2600
|
"parameters": [
|
|
2588
2601
|
{
|
|
@@ -2618,7 +2631,7 @@
|
|
|
2618
2631
|
"summary": "Cancel a matching run",
|
|
2619
2632
|
"description": "Cancel a queued or running matching run. Runs already in a terminal\nstate (`completed`, `failed`, `cancelled`) return 400.\n",
|
|
2620
2633
|
"tags": [
|
|
2621
|
-
"
|
|
2634
|
+
"Intelligence"
|
|
2622
2635
|
],
|
|
2623
2636
|
"parameters": [
|
|
2624
2637
|
{
|
|
@@ -2657,7 +2670,7 @@
|
|
|
2657
2670
|
"summary": "List routing rules",
|
|
2658
2671
|
"description": "Paginated list of document routing rules, ordered by priority ascending (lowest runs first).",
|
|
2659
2672
|
"tags": [
|
|
2660
|
-
"
|
|
2673
|
+
"Delivery"
|
|
2661
2674
|
],
|
|
2662
2675
|
"parameters": [
|
|
2663
2676
|
{
|
|
@@ -2720,7 +2733,7 @@
|
|
|
2720
2733
|
"summary": "Create a routing rule",
|
|
2721
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",
|
|
2722
2735
|
"tags": [
|
|
2723
|
-
"
|
|
2736
|
+
"Delivery"
|
|
2724
2737
|
],
|
|
2725
2738
|
"requestBody": {
|
|
2726
2739
|
"required": true,
|
|
@@ -2770,7 +2783,7 @@
|
|
|
2770
2783
|
"operationId": "getRoutingRule",
|
|
2771
2784
|
"summary": "Get a routing rule",
|
|
2772
2785
|
"tags": [
|
|
2773
|
-
"
|
|
2786
|
+
"Delivery"
|
|
2774
2787
|
],
|
|
2775
2788
|
"parameters": [
|
|
2776
2789
|
{
|
|
@@ -2804,7 +2817,7 @@
|
|
|
2804
2817
|
"summary": "Update a routing rule",
|
|
2805
2818
|
"description": "Partial update; only provided keys are patched.",
|
|
2806
2819
|
"tags": [
|
|
2807
|
-
"
|
|
2820
|
+
"Delivery"
|
|
2808
2821
|
],
|
|
2809
2822
|
"parameters": [
|
|
2810
2823
|
{
|
|
@@ -2850,7 +2863,7 @@
|
|
|
2850
2863
|
"operationId": "deleteRoutingRule",
|
|
2851
2864
|
"summary": "Delete a routing rule",
|
|
2852
2865
|
"tags": [
|
|
2853
|
-
"
|
|
2866
|
+
"Delivery"
|
|
2854
2867
|
],
|
|
2855
2868
|
"parameters": [
|
|
2856
2869
|
{
|
|
@@ -4214,7 +4227,7 @@
|
|
|
4214
4227
|
"summary": "Filter documents with structured conditions",
|
|
4215
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",
|
|
4216
4229
|
"tags": [
|
|
4217
|
-
"
|
|
4230
|
+
"Delivery"
|
|
4218
4231
|
],
|
|
4219
4232
|
"requestBody": {
|
|
4220
4233
|
"required": true,
|
|
@@ -4266,7 +4279,7 @@
|
|
|
4266
4279
|
"summary": "Omnisearch across documents, fields, and schemas",
|
|
4267
4280
|
"description": "Full-text search that returns multiple result collections in a single\nresponse: matching documents, field matches, sources, schemas, and\nfields.\n",
|
|
4268
4281
|
"tags": [
|
|
4269
|
-
"
|
|
4282
|
+
"Delivery"
|
|
4270
4283
|
],
|
|
4271
4284
|
"parameters": [
|
|
4272
4285
|
{
|
|
@@ -4315,7 +4328,7 @@
|
|
|
4315
4328
|
"summary": "List review queue records",
|
|
4316
4329
|
"description": "Paginated list of validation records awaiting or having completed review.",
|
|
4317
4330
|
"tags": [
|
|
4318
|
-
"
|
|
4331
|
+
"Platform"
|
|
4319
4332
|
],
|
|
4320
4333
|
"parameters": [
|
|
4321
4334
|
{
|
|
@@ -4388,7 +4401,7 @@
|
|
|
4388
4401
|
"summary": "Apply a review action to many records",
|
|
4389
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",
|
|
4390
4403
|
"tags": [
|
|
4391
|
-
"
|
|
4404
|
+
"Platform"
|
|
4392
4405
|
],
|
|
4393
4406
|
"requestBody": {
|
|
4394
4407
|
"required": true,
|
|
@@ -4429,7 +4442,7 @@
|
|
|
4429
4442
|
"summary": "Get a review record",
|
|
4430
4443
|
"description": "Returns the full record including per-field decisions and low-confidence field list.",
|
|
4431
4444
|
"tags": [
|
|
4432
|
-
"
|
|
4445
|
+
"Platform"
|
|
4433
4446
|
],
|
|
4434
4447
|
"parameters": [
|
|
4435
4448
|
{
|
|
@@ -4464,7 +4477,7 @@
|
|
|
4464
4477
|
"operationId": "performReviewAction",
|
|
4465
4478
|
"summary": "Approve or reject a review record",
|
|
4466
4479
|
"tags": [
|
|
4467
|
-
"
|
|
4480
|
+
"Platform"
|
|
4468
4481
|
],
|
|
4469
4482
|
"parameters": [
|
|
4470
4483
|
{
|
|
@@ -4512,7 +4525,7 @@
|
|
|
4512
4525
|
"operationId": "listGroundTruthDatasets",
|
|
4513
4526
|
"summary": "List ground truth datasets",
|
|
4514
4527
|
"tags": [
|
|
4515
|
-
"
|
|
4528
|
+
"Platform"
|
|
4516
4529
|
],
|
|
4517
4530
|
"parameters": [
|
|
4518
4531
|
{
|
|
@@ -4574,7 +4587,7 @@
|
|
|
4574
4587
|
"operationId": "createGroundTruthDataset",
|
|
4575
4588
|
"summary": "Create a ground truth dataset",
|
|
4576
4589
|
"tags": [
|
|
4577
|
-
"
|
|
4590
|
+
"Platform"
|
|
4578
4591
|
],
|
|
4579
4592
|
"requestBody": {
|
|
4580
4593
|
"required": true,
|
|
@@ -4625,7 +4638,7 @@
|
|
|
4625
4638
|
"summary": "Get a ground truth dataset",
|
|
4626
4639
|
"description": "Returns the dataset together with its sample entries (curated known-correct values).",
|
|
4627
4640
|
"tags": [
|
|
4628
|
-
"
|
|
4641
|
+
"Platform"
|
|
4629
4642
|
],
|
|
4630
4643
|
"parameters": [
|
|
4631
4644
|
{
|
|
@@ -4660,7 +4673,7 @@
|
|
|
4660
4673
|
"operationId": "listBenchmarkRuns",
|
|
4661
4674
|
"summary": "List benchmark runs",
|
|
4662
4675
|
"tags": [
|
|
4663
|
-
"
|
|
4676
|
+
"Platform"
|
|
4664
4677
|
],
|
|
4665
4678
|
"parameters": [
|
|
4666
4679
|
{
|
|
@@ -4725,7 +4738,7 @@
|
|
|
4725
4738
|
"summary": "Get a benchmark run",
|
|
4726
4739
|
"description": "Returns the benchmark run together with its per-document results.",
|
|
4727
4740
|
"tags": [
|
|
4728
|
-
"
|
|
4741
|
+
"Platform"
|
|
4729
4742
|
],
|
|
4730
4743
|
"parameters": [
|
|
4731
4744
|
{
|
|
@@ -4761,7 +4774,7 @@
|
|
|
4761
4774
|
"summary": "List batch inference runs",
|
|
4762
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",
|
|
4763
4776
|
"tags": [
|
|
4764
|
-
"Batches"
|
|
4777
|
+
"Jobs & Batches"
|
|
4765
4778
|
],
|
|
4766
4779
|
"parameters": [
|
|
4767
4780
|
{
|
|
@@ -4831,7 +4844,7 @@
|
|
|
4831
4844
|
"summary": "Get a batch inference run",
|
|
4832
4845
|
"description": "Returns the batch metadata plus per-item status for every document in the batch.",
|
|
4833
4846
|
"tags": [
|
|
4834
|
-
"Batches"
|
|
4847
|
+
"Jobs & Batches"
|
|
4835
4848
|
],
|
|
4836
4849
|
"parameters": [
|
|
4837
4850
|
{
|
|
@@ -4867,7 +4880,7 @@
|
|
|
4867
4880
|
"summary": "List cases",
|
|
4868
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).",
|
|
4869
4882
|
"tags": [
|
|
4870
|
-
"
|
|
4883
|
+
"Intelligence"
|
|
4871
4884
|
],
|
|
4872
4885
|
"parameters": [
|
|
4873
4886
|
{
|
|
@@ -4922,7 +4935,7 @@
|
|
|
4922
4935
|
"summary": "Get a case by key",
|
|
4923
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",
|
|
4924
4937
|
"tags": [
|
|
4925
|
-
"
|
|
4938
|
+
"Intelligence"
|
|
4926
4939
|
],
|
|
4927
4940
|
"parameters": [
|
|
4928
4941
|
{
|
|
@@ -4968,7 +4981,7 @@
|
|
|
4968
4981
|
"summary": "List document types",
|
|
4969
4982
|
"description": "Document types resolved for the authenticated customer, ordered by document count descending.",
|
|
4970
4983
|
"tags": [
|
|
4971
|
-
"
|
|
4984
|
+
"Documents"
|
|
4972
4985
|
],
|
|
4973
4986
|
"responses": {
|
|
4974
4987
|
"200": {
|
|
@@ -5004,7 +5017,7 @@
|
|
|
5004
5017
|
"summary": "Get the document type ontology",
|
|
5005
5018
|
"description": "Returns the canonical category summary (categories, subcategories, and types) used by the classifier.",
|
|
5006
5019
|
"tags": [
|
|
5007
|
-
"
|
|
5020
|
+
"Documents"
|
|
5008
5021
|
],
|
|
5009
5022
|
"responses": {
|
|
5010
5023
|
"200": {
|
|
@@ -5042,7 +5055,7 @@
|
|
|
5042
5055
|
"summary": "List fields",
|
|
5043
5056
|
"description": "Paginated list of fields from the field registry, filterable by search, tier, or cluster.",
|
|
5044
5057
|
"tags": [
|
|
5045
|
-
"
|
|
5058
|
+
"Schemas"
|
|
5046
5059
|
],
|
|
5047
5060
|
"parameters": [
|
|
5048
5061
|
{
|
|
@@ -5122,7 +5135,7 @@
|
|
|
5122
5135
|
"summary": "Cross-schema field overlap",
|
|
5123
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",
|
|
5124
5137
|
"tags": [
|
|
5125
|
-
"
|
|
5138
|
+
"Schemas"
|
|
5126
5139
|
],
|
|
5127
5140
|
"responses": {
|
|
5128
5141
|
"200": {
|
|
@@ -5158,7 +5171,7 @@
|
|
|
5158
5171
|
"summary": "Get a field",
|
|
5159
5172
|
"description": "Returns the field registry row plus up to 20 most recent occurrences.",
|
|
5160
5173
|
"tags": [
|
|
5161
|
-
"
|
|
5174
|
+
"Schemas"
|
|
5162
5175
|
],
|
|
5163
5176
|
"parameters": [
|
|
5164
5177
|
{
|
|
@@ -5194,7 +5207,7 @@
|
|
|
5194
5207
|
"summary": "Get fields similar to this one",
|
|
5195
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",
|
|
5196
5209
|
"tags": [
|
|
5197
|
-
"
|
|
5210
|
+
"Schemas"
|
|
5198
5211
|
],
|
|
5199
5212
|
"parameters": [
|
|
5200
5213
|
{
|
|
@@ -5274,7 +5287,7 @@
|
|
|
5274
5287
|
"summary": "List reference datasets",
|
|
5275
5288
|
"description": "Uploaded reference datasets (CSV/XLSX) available for matching configurations.",
|
|
5276
5289
|
"tags": [
|
|
5277
|
-
"
|
|
5290
|
+
"Intelligence"
|
|
5278
5291
|
],
|
|
5279
5292
|
"responses": {
|
|
5280
5293
|
"200": {
|
|
@@ -5309,7 +5322,7 @@
|
|
|
5309
5322
|
"operationId": "getReferenceData",
|
|
5310
5323
|
"summary": "Get a reference dataset",
|
|
5311
5324
|
"tags": [
|
|
5312
|
-
"
|
|
5325
|
+
"Intelligence"
|
|
5313
5326
|
],
|
|
5314
5327
|
"parameters": [
|
|
5315
5328
|
{
|
|
@@ -5342,7 +5355,7 @@
|
|
|
5342
5355
|
"operationId": "deleteReferenceData",
|
|
5343
5356
|
"summary": "Delete a reference dataset",
|
|
5344
5357
|
"tags": [
|
|
5345
|
-
"
|
|
5358
|
+
"Intelligence"
|
|
5346
5359
|
],
|
|
5347
5360
|
"parameters": [
|
|
5348
5361
|
{
|
|
@@ -5383,7 +5396,7 @@
|
|
|
5383
5396
|
"summary": "Get reference dataset rows (paginated)",
|
|
5384
5397
|
"description": "Returns the dataset's rows, paginated with page/limit (limit capped at 500).",
|
|
5385
5398
|
"tags": [
|
|
5386
|
-
"
|
|
5399
|
+
"Intelligence"
|
|
5387
5400
|
],
|
|
5388
5401
|
"parameters": [
|
|
5389
5402
|
{
|
|
@@ -5462,7 +5475,7 @@
|
|
|
5462
5475
|
"summary": "Aggregate API usage stats",
|
|
5463
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",
|
|
5464
5477
|
"tags": [
|
|
5465
|
-
"
|
|
5478
|
+
"Platform"
|
|
5466
5479
|
],
|
|
5467
5480
|
"parameters": [
|
|
5468
5481
|
{
|
|
@@ -5510,7 +5523,7 @@
|
|
|
5510
5523
|
"summary": "Per-document API usage",
|
|
5511
5524
|
"description": "Returns per-document API usage entries and totals. 404 if no usage records exist for the document.",
|
|
5512
5525
|
"tags": [
|
|
5513
|
-
"
|
|
5526
|
+
"Platform"
|
|
5514
5527
|
],
|
|
5515
5528
|
"parameters": [
|
|
5516
5529
|
{
|
|
@@ -5545,7 +5558,7 @@
|
|
|
5545
5558
|
"operationId": "listResolutions",
|
|
5546
5559
|
"summary": "List resolution runs",
|
|
5547
5560
|
"tags": [
|
|
5548
|
-
"
|
|
5561
|
+
"Intelligence"
|
|
5549
5562
|
],
|
|
5550
5563
|
"parameters": [
|
|
5551
5564
|
{
|
|
@@ -5597,7 +5610,7 @@
|
|
|
5597
5610
|
"summary": "Create a resolution run",
|
|
5598
5611
|
"description": "Start a new resolution run targeting documents from a specific source run.",
|
|
5599
5612
|
"tags": [
|
|
5600
|
-
"
|
|
5613
|
+
"Intelligence"
|
|
5601
5614
|
],
|
|
5602
5615
|
"requestBody": {
|
|
5603
5616
|
"required": true,
|
|
@@ -5648,7 +5661,7 @@
|
|
|
5648
5661
|
"operationId": "getResolution",
|
|
5649
5662
|
"summary": "Get a resolution run",
|
|
5650
5663
|
"tags": [
|
|
5651
|
-
"
|
|
5664
|
+
"Intelligence"
|
|
5652
5665
|
],
|
|
5653
5666
|
"parameters": [
|
|
5654
5667
|
{
|
|
@@ -5681,7 +5694,7 @@
|
|
|
5681
5694
|
"operationId": "deleteResolution",
|
|
5682
5695
|
"summary": "Delete a resolution run",
|
|
5683
5696
|
"tags": [
|
|
5684
|
-
"
|
|
5697
|
+
"Intelligence"
|
|
5685
5698
|
],
|
|
5686
5699
|
"parameters": [
|
|
5687
5700
|
{
|
|
@@ -5717,7 +5730,7 @@
|
|
|
5717
5730
|
"summary": "Get resolution run results",
|
|
5718
5731
|
"description": "Returns the resolved data for all documents in the resolution run.",
|
|
5719
5732
|
"tags": [
|
|
5720
|
-
"
|
|
5733
|
+
"Intelligence"
|
|
5721
5734
|
],
|
|
5722
5735
|
"parameters": [
|
|
5723
5736
|
{
|
|
@@ -5762,7 +5775,7 @@
|
|
|
5762
5775
|
"summary": "Execute a resolution run",
|
|
5763
5776
|
"description": "Trigger execution of a pending resolution run.",
|
|
5764
5777
|
"tags": [
|
|
5765
|
-
"
|
|
5778
|
+
"Intelligence"
|
|
5766
5779
|
],
|
|
5767
5780
|
"parameters": [
|
|
5768
5781
|
{
|
|
@@ -5798,7 +5811,7 @@
|
|
|
5798
5811
|
"summary": "List link keys",
|
|
5799
5812
|
"description": "Returns all configured link keys (field-level entity identifiers used for document linking).",
|
|
5800
5813
|
"tags": [
|
|
5801
|
-
"
|
|
5814
|
+
"Intelligence"
|
|
5802
5815
|
],
|
|
5803
5816
|
"responses": {
|
|
5804
5817
|
"200": {
|
|
@@ -5834,7 +5847,7 @@
|
|
|
5834
5847
|
"summary": "Get links for a document",
|
|
5835
5848
|
"description": "Returns all entity links discovered for a specific document.",
|
|
5836
5849
|
"tags": [
|
|
5837
|
-
"
|
|
5850
|
+
"Intelligence"
|
|
5838
5851
|
],
|
|
5839
5852
|
"parameters": [
|
|
5840
5853
|
{
|
|
@@ -5897,7 +5910,7 @@
|
|
|
5897
5910
|
"summary": "Get the full linking graph",
|
|
5898
5911
|
"description": "Returns the bipartite document-entity graph for the customer.",
|
|
5899
5912
|
"tags": [
|
|
5900
|
-
"
|
|
5913
|
+
"Intelligence"
|
|
5901
5914
|
],
|
|
5902
5915
|
"responses": {
|
|
5903
5916
|
"200": {
|
|
@@ -5941,7 +5954,7 @@
|
|
|
5941
5954
|
"summary": "Get graph neighbourhood for a document",
|
|
5942
5955
|
"description": "Returns the subgraph of entities and linked documents for a specific document.",
|
|
5943
5956
|
"tags": [
|
|
5944
|
-
"
|
|
5957
|
+
"Intelligence"
|
|
5945
5958
|
],
|
|
5946
5959
|
"parameters": [
|
|
5947
5960
|
{
|
|
@@ -5993,7 +6006,7 @@
|
|
|
5993
6006
|
"summary": "Classify link keys",
|
|
5994
6007
|
"description": "Run AI classification on ambiguous fields to determine their link key category (identity, transaction, reference).",
|
|
5995
6008
|
"tags": [
|
|
5996
|
-
"
|
|
6009
|
+
"Intelligence"
|
|
5997
6010
|
],
|
|
5998
6011
|
"responses": {
|
|
5999
6012
|
"200": {
|
|
@@ -6033,7 +6046,7 @@
|
|
|
6033
6046
|
"summary": "Backfill linking data",
|
|
6034
6047
|
"description": "Trigger a backfill of the linking graph for all documents. Useful after link key configuration changes.",
|
|
6035
6048
|
"tags": [
|
|
6036
|
-
"
|
|
6049
|
+
"Intelligence"
|
|
6037
6050
|
],
|
|
6038
6051
|
"responses": {
|
|
6039
6052
|
"202": {
|
|
@@ -6071,7 +6084,7 @@
|
|
|
6071
6084
|
"summary": "Get backfill progress",
|
|
6072
6085
|
"description": "Returns the current progress of an in-flight backfill operation.",
|
|
6073
6086
|
"tags": [
|
|
6074
|
-
"
|
|
6087
|
+
"Intelligence"
|
|
6075
6088
|
],
|
|
6076
6089
|
"responses": {
|
|
6077
6090
|
"200": {
|
|
@@ -6116,7 +6129,7 @@
|
|
|
6116
6129
|
"summary": "Get document-to-case mapping",
|
|
6117
6130
|
"description": "Returns a mapping of document IDs to their assigned case keys.",
|
|
6118
6131
|
"tags": [
|
|
6119
|
-
"
|
|
6132
|
+
"Intelligence"
|
|
6120
6133
|
],
|
|
6121
6134
|
"responses": {
|
|
6122
6135
|
"200": {
|
|
@@ -6153,7 +6166,7 @@
|
|
|
6153
6166
|
"summary": "Get N-Shot summary for a run",
|
|
6154
6167
|
"description": "Returns an aggregate summary of N-Shot comparisons for a job run.",
|
|
6155
6168
|
"tags": [
|
|
6156
|
-
"
|
|
6169
|
+
"Intelligence"
|
|
6157
6170
|
],
|
|
6158
6171
|
"parameters": [
|
|
6159
6172
|
{
|
|
@@ -6198,7 +6211,7 @@
|
|
|
6198
6211
|
"summary": "List N-Shot comparisons",
|
|
6199
6212
|
"description": "Returns all N-Shot comparisons for a job run.",
|
|
6200
6213
|
"tags": [
|
|
6201
|
-
"
|
|
6214
|
+
"Intelligence"
|
|
6202
6215
|
],
|
|
6203
6216
|
"parameters": [
|
|
6204
6217
|
{
|
|
@@ -6251,7 +6264,7 @@
|
|
|
6251
6264
|
"summary": "Get a specific N-Shot comparison",
|
|
6252
6265
|
"description": "Returns a single N-Shot comparison filtered by document and field.",
|
|
6253
6266
|
"tags": [
|
|
6254
|
-
"
|
|
6267
|
+
"Intelligence"
|
|
6255
6268
|
],
|
|
6256
6269
|
"parameters": [
|
|
6257
6270
|
{
|
|
@@ -6316,7 +6329,7 @@
|
|
|
6316
6329
|
"summary": "Override an N-Shot value",
|
|
6317
6330
|
"description": "Manually override the N-Shot selected value for a document-field pair.",
|
|
6318
6331
|
"tags": [
|
|
6319
|
-
"
|
|
6332
|
+
"Intelligence"
|
|
6320
6333
|
],
|
|
6321
6334
|
"parameters": [
|
|
6322
6335
|
{
|
|
@@ -6397,7 +6410,7 @@
|
|
|
6397
6410
|
"summary": "Submit a judge decision for N-Shot",
|
|
6398
6411
|
"description": "Submit an AI or human judge decision on which N-Shot candidate is correct.",
|
|
6399
6412
|
"tags": [
|
|
6400
|
-
"
|
|
6413
|
+
"Intelligence"
|
|
6401
6414
|
],
|
|
6402
6415
|
"parameters": [
|
|
6403
6416
|
{
|
|
@@ -6479,7 +6492,7 @@
|
|
|
6479
6492
|
"summary": "List schema graph classes",
|
|
6480
6493
|
"description": "Returns all classes in the schema graph ontology.",
|
|
6481
6494
|
"tags": [
|
|
6482
|
-
"
|
|
6495
|
+
"Schemas"
|
|
6483
6496
|
],
|
|
6484
6497
|
"responses": {
|
|
6485
6498
|
"200": {
|
|
@@ -6514,7 +6527,7 @@
|
|
|
6514
6527
|
"operationId": "getSchemaGraphClass",
|
|
6515
6528
|
"summary": "Get a schema graph class",
|
|
6516
6529
|
"tags": [
|
|
6517
|
-
"
|
|
6530
|
+
"Schemas"
|
|
6518
6531
|
],
|
|
6519
6532
|
"parameters": [
|
|
6520
6533
|
{
|
|
@@ -6550,7 +6563,7 @@
|
|
|
6550
6563
|
"summary": "List versions of a schema graph class",
|
|
6551
6564
|
"description": "Returns all published versions of a class, ordered by version number descending.",
|
|
6552
6565
|
"tags": [
|
|
6553
|
-
"
|
|
6566
|
+
"Schemas"
|
|
6554
6567
|
],
|
|
6555
6568
|
"parameters": [
|
|
6556
6569
|
{
|
|
@@ -6610,7 +6623,7 @@
|
|
|
6610
6623
|
"operationId": "getSchemaGraphClassVersion",
|
|
6611
6624
|
"summary": "Get a specific version of a schema graph class",
|
|
6612
6625
|
"tags": [
|
|
6613
|
-
"
|
|
6626
|
+
"Schemas"
|
|
6614
6627
|
],
|
|
6615
6628
|
"parameters": [
|
|
6616
6629
|
{
|
|
@@ -6672,7 +6685,7 @@
|
|
|
6672
6685
|
"summary": "List schema graph diffs",
|
|
6673
6686
|
"description": "Returns pending and processed diffs between class versions.",
|
|
6674
6687
|
"tags": [
|
|
6675
|
-
"
|
|
6688
|
+
"Schemas"
|
|
6676
6689
|
],
|
|
6677
6690
|
"responses": {
|
|
6678
6691
|
"200": {
|
|
@@ -6708,7 +6721,7 @@
|
|
|
6708
6721
|
"summary": "Approve a schema graph diff",
|
|
6709
6722
|
"description": "Approve a pending diff, promoting the changes to the live class version.",
|
|
6710
6723
|
"tags": [
|
|
6711
|
-
"
|
|
6724
|
+
"Schemas"
|
|
6712
6725
|
],
|
|
6713
6726
|
"parameters": [
|
|
6714
6727
|
{
|
|
@@ -6744,7 +6757,7 @@
|
|
|
6744
6757
|
"summary": "Reject a schema graph diff",
|
|
6745
6758
|
"description": "Reject a pending diff, discarding the proposed changes.",
|
|
6746
6759
|
"tags": [
|
|
6747
|
-
"
|
|
6760
|
+
"Schemas"
|
|
6748
6761
|
],
|
|
6749
6762
|
"parameters": [
|
|
6750
6763
|
{
|
|
@@ -6780,7 +6793,7 @@
|
|
|
6780
6793
|
"summary": "List schema graph edges",
|
|
6781
6794
|
"description": "Returns all edges (relationships) between schema graph classes.",
|
|
6782
6795
|
"tags": [
|
|
6783
|
-
"
|
|
6796
|
+
"Schemas"
|
|
6784
6797
|
],
|
|
6785
6798
|
"responses": {
|
|
6786
6799
|
"200": {
|
|
@@ -6835,7 +6848,7 @@
|
|
|
6835
6848
|
"summary": "List schema graph aliases",
|
|
6836
6849
|
"description": "Returns all class aliases (alternative names mapping to canonical class IDs).",
|
|
6837
6850
|
"tags": [
|
|
6838
|
-
"
|
|
6851
|
+
"Schemas"
|
|
6839
6852
|
],
|
|
6840
6853
|
"responses": {
|
|
6841
6854
|
"200": {
|
|
@@ -6884,7 +6897,7 @@
|
|
|
6884
6897
|
"summary": "Get schema graph visualization data",
|
|
6885
6898
|
"description": "Returns nodes and edges formatted for graph visualization (D3-compatible).",
|
|
6886
6899
|
"tags": [
|
|
6887
|
-
"
|
|
6900
|
+
"Schemas"
|
|
6888
6901
|
],
|
|
6889
6902
|
"responses": {
|
|
6890
6903
|
"200": {
|
|
@@ -6928,7 +6941,7 @@
|
|
|
6928
6941
|
"summary": "List structuring checks",
|
|
6929
6942
|
"description": "Returns all configured validation checks for the customer.",
|
|
6930
6943
|
"tags": [
|
|
6931
|
-
"
|
|
6944
|
+
"Platform"
|
|
6932
6945
|
],
|
|
6933
6946
|
"parameters": [
|
|
6934
6947
|
{
|
|
@@ -6979,7 +6992,7 @@
|
|
|
6979
6992
|
"operationId": "createStructuringCheck",
|
|
6980
6993
|
"summary": "Create a structuring check",
|
|
6981
6994
|
"tags": [
|
|
6982
|
-
"
|
|
6995
|
+
"Platform"
|
|
6983
6996
|
],
|
|
6984
6997
|
"requestBody": {
|
|
6985
6998
|
"required": true,
|
|
@@ -7019,7 +7032,7 @@
|
|
|
7019
7032
|
"operationId": "getStructuringCheck",
|
|
7020
7033
|
"summary": "Get a structuring check",
|
|
7021
7034
|
"tags": [
|
|
7022
|
-
"
|
|
7035
|
+
"Platform"
|
|
7023
7036
|
],
|
|
7024
7037
|
"parameters": [
|
|
7025
7038
|
{
|
|
@@ -7052,7 +7065,7 @@
|
|
|
7052
7065
|
"operationId": "updateStructuringCheck",
|
|
7053
7066
|
"summary": "Update a structuring check",
|
|
7054
7067
|
"tags": [
|
|
7055
|
-
"
|
|
7068
|
+
"Platform"
|
|
7056
7069
|
],
|
|
7057
7070
|
"parameters": [
|
|
7058
7071
|
{
|
|
@@ -7098,7 +7111,7 @@
|
|
|
7098
7111
|
"operationId": "deleteStructuringCheck",
|
|
7099
7112
|
"summary": "Delete a structuring check",
|
|
7100
7113
|
"tags": [
|
|
7101
|
-
"
|
|
7114
|
+
"Platform"
|
|
7102
7115
|
],
|
|
7103
7116
|
"parameters": [
|
|
7104
7117
|
{
|
|
@@ -7134,7 +7147,7 @@
|
|
|
7134
7147
|
"summary": "List approval gates",
|
|
7135
7148
|
"description": "Returns all configured approval gates for the customer.",
|
|
7136
7149
|
"tags": [
|
|
7137
|
-
"
|
|
7150
|
+
"Platform"
|
|
7138
7151
|
],
|
|
7139
7152
|
"parameters": [
|
|
7140
7153
|
{
|
|
@@ -7185,7 +7198,7 @@
|
|
|
7185
7198
|
"operationId": "createStructuringGate",
|
|
7186
7199
|
"summary": "Create an approval gate",
|
|
7187
7200
|
"tags": [
|
|
7188
|
-
"
|
|
7201
|
+
"Platform"
|
|
7189
7202
|
],
|
|
7190
7203
|
"requestBody": {
|
|
7191
7204
|
"required": true,
|
|
@@ -7225,7 +7238,7 @@
|
|
|
7225
7238
|
"operationId": "getStructuringGate",
|
|
7226
7239
|
"summary": "Get an approval gate",
|
|
7227
7240
|
"tags": [
|
|
7228
|
-
"
|
|
7241
|
+
"Platform"
|
|
7229
7242
|
],
|
|
7230
7243
|
"parameters": [
|
|
7231
7244
|
{
|
|
@@ -7258,7 +7271,7 @@
|
|
|
7258
7271
|
"operationId": "updateStructuringGate",
|
|
7259
7272
|
"summary": "Update an approval gate",
|
|
7260
7273
|
"tags": [
|
|
7261
|
-
"
|
|
7274
|
+
"Platform"
|
|
7262
7275
|
],
|
|
7263
7276
|
"parameters": [
|
|
7264
7277
|
{
|
|
@@ -7304,7 +7317,7 @@
|
|
|
7304
7317
|
"operationId": "deleteStructuringGate",
|
|
7305
7318
|
"summary": "Delete an approval gate",
|
|
7306
7319
|
"tags": [
|
|
7307
|
-
"
|
|
7320
|
+
"Platform"
|
|
7308
7321
|
],
|
|
7309
7322
|
"parameters": [
|
|
7310
7323
|
{
|
|
@@ -7339,7 +7352,7 @@
|
|
|
7339
7352
|
"operationId": "addStructuringGateRule",
|
|
7340
7353
|
"summary": "Add a rule to an approval gate",
|
|
7341
7354
|
"tags": [
|
|
7342
|
-
"
|
|
7355
|
+
"Platform"
|
|
7343
7356
|
],
|
|
7344
7357
|
"parameters": [
|
|
7345
7358
|
{
|
|
@@ -7400,7 +7413,7 @@
|
|
|
7400
7413
|
"operationId": "deleteStructuringGateRule",
|
|
7401
7414
|
"summary": "Remove a rule from an approval gate",
|
|
7402
7415
|
"tags": [
|
|
7403
|
-
"
|
|
7416
|
+
"Platform"
|
|
7404
7417
|
],
|
|
7405
7418
|
"parameters": [
|
|
7406
7419
|
{
|
|
@@ -7456,7 +7469,7 @@
|
|
|
7456
7469
|
"summary": "Get check results for a structuring result",
|
|
7457
7470
|
"description": "Returns the validation check outcomes for a specific structuring result.",
|
|
7458
7471
|
"tags": [
|
|
7459
|
-
"
|
|
7472
|
+
"Platform"
|
|
7460
7473
|
],
|
|
7461
7474
|
"parameters": [
|
|
7462
7475
|
{
|
|
@@ -7519,7 +7532,7 @@
|
|
|
7519
7532
|
"summary": "List pending approvals",
|
|
7520
7533
|
"description": "Returns structuring results awaiting manual approval.",
|
|
7521
7534
|
"tags": [
|
|
7522
|
-
"
|
|
7535
|
+
"Platform"
|
|
7523
7536
|
],
|
|
7524
7537
|
"parameters": [
|
|
7525
7538
|
{
|
|
@@ -7570,7 +7583,7 @@
|
|
|
7570
7583
|
"operationId": "approveStructuringResult",
|
|
7571
7584
|
"summary": "Approve a structuring result",
|
|
7572
7585
|
"tags": [
|
|
7573
|
-
"
|
|
7586
|
+
"Platform"
|
|
7574
7587
|
],
|
|
7575
7588
|
"parameters": [
|
|
7576
7589
|
{
|
|
@@ -7616,7 +7629,7 @@
|
|
|
7616
7629
|
"operationId": "rejectStructuringResult",
|
|
7617
7630
|
"summary": "Reject a structuring result",
|
|
7618
7631
|
"tags": [
|
|
7619
|
-
"
|
|
7632
|
+
"Platform"
|
|
7620
7633
|
],
|
|
7621
7634
|
"parameters": [
|
|
7622
7635
|
{
|
|
@@ -7663,7 +7676,7 @@
|
|
|
7663
7676
|
"summary": "Trigger delivery for a structuring run",
|
|
7664
7677
|
"description": "Emit delivery signals for all approved results in the run.",
|
|
7665
7678
|
"tags": [
|
|
7666
|
-
"
|
|
7679
|
+
"Platform"
|
|
7667
7680
|
],
|
|
7668
7681
|
"parameters": [
|
|
7669
7682
|
{
|
|
@@ -7715,7 +7728,7 @@
|
|
|
7715
7728
|
"summary": "Get telemetry summary for a schema",
|
|
7716
7729
|
"description": "Aggregate structuring metrics for a schema — capture hit rate, synthesize rate, strategy distribution, tier funnel.",
|
|
7717
7730
|
"tags": [
|
|
7718
|
-
"
|
|
7731
|
+
"Platform"
|
|
7719
7732
|
],
|
|
7720
7733
|
"parameters": [
|
|
7721
7734
|
{
|
|
@@ -7752,7 +7765,7 @@
|
|
|
7752
7765
|
"summary": "Get telemetry trend for a schema",
|
|
7753
7766
|
"description": "Time-series telemetry data for a schema over recent runs.",
|
|
7754
7767
|
"tags": [
|
|
7755
|
-
"
|
|
7768
|
+
"Platform"
|
|
7756
7769
|
],
|
|
7757
7770
|
"parameters": [
|
|
7758
7771
|
{
|
|
@@ -7797,7 +7810,7 @@
|
|
|
7797
7810
|
"summary": "Get per-field telemetry for a schema",
|
|
7798
7811
|
"description": "Field-level structuring metrics — per-field state distribution, capture rates, and strategy breakdown.",
|
|
7799
7812
|
"tags": [
|
|
7800
|
-
"
|
|
7813
|
+
"Platform"
|
|
7801
7814
|
],
|
|
7802
7815
|
"parameters": [
|
|
7803
7816
|
{
|
|
@@ -7842,7 +7855,7 @@
|
|
|
7842
7855
|
"summary": "Get telemetry summary for a run",
|
|
7843
7856
|
"description": "Aggregate structuring metrics for a specific job run.",
|
|
7844
7857
|
"tags": [
|
|
7845
|
-
"
|
|
7858
|
+
"Platform"
|
|
7846
7859
|
],
|
|
7847
7860
|
"parameters": [
|
|
7848
7861
|
{
|
|
@@ -7879,7 +7892,7 @@
|
|
|
7879
7892
|
"summary": "List golden samples",
|
|
7880
7893
|
"description": "Returns all golden sample datasets for the customer.",
|
|
7881
7894
|
"tags": [
|
|
7882
|
-
"
|
|
7895
|
+
"Platform"
|
|
7883
7896
|
],
|
|
7884
7897
|
"parameters": [
|
|
7885
7898
|
{
|
|
@@ -7932,7 +7945,7 @@
|
|
|
7932
7945
|
"operationId": "getGoldenSample",
|
|
7933
7946
|
"summary": "Get a golden sample",
|
|
7934
7947
|
"tags": [
|
|
7935
|
-
"
|
|
7948
|
+
"Platform"
|
|
7936
7949
|
],
|
|
7937
7950
|
"parameters": [
|
|
7938
7951
|
{
|
|
@@ -7965,7 +7978,7 @@
|
|
|
7965
7978
|
"operationId": "deleteGoldenSample",
|
|
7966
7979
|
"summary": "Delete a golden sample",
|
|
7967
7980
|
"tags": [
|
|
7968
|
-
"
|
|
7981
|
+
"Platform"
|
|
7969
7982
|
],
|
|
7970
7983
|
"parameters": [
|
|
7971
7984
|
{
|
|
@@ -8000,7 +8013,7 @@
|
|
|
8000
8013
|
"operationId": "listValidationRuns",
|
|
8001
8014
|
"summary": "List validation runs",
|
|
8002
8015
|
"tags": [
|
|
8003
|
-
"
|
|
8016
|
+
"Platform"
|
|
8004
8017
|
],
|
|
8005
8018
|
"parameters": [
|
|
8006
8019
|
{
|
|
@@ -8052,7 +8065,7 @@
|
|
|
8052
8065
|
"summary": "Create a validation run",
|
|
8053
8066
|
"description": "Start a new validation run against a golden sample dataset.",
|
|
8054
8067
|
"tags": [
|
|
8055
|
-
"
|
|
8068
|
+
"Platform"
|
|
8056
8069
|
],
|
|
8057
8070
|
"requestBody": {
|
|
8058
8071
|
"required": true,
|
|
@@ -8109,7 +8122,7 @@
|
|
|
8109
8122
|
"operationId": "getValidationRun",
|
|
8110
8123
|
"summary": "Get a validation run",
|
|
8111
8124
|
"tags": [
|
|
8112
|
-
"
|
|
8125
|
+
"Platform"
|
|
8113
8126
|
],
|
|
8114
8127
|
"parameters": [
|
|
8115
8128
|
{
|
|
@@ -8142,7 +8155,7 @@
|
|
|
8142
8155
|
"operationId": "deleteValidationRun",
|
|
8143
8156
|
"summary": "Delete a validation run",
|
|
8144
8157
|
"tags": [
|
|
8145
|
-
"
|
|
8158
|
+
"Platform"
|
|
8146
8159
|
],
|
|
8147
8160
|
"parameters": [
|
|
8148
8161
|
{
|
|
@@ -8178,7 +8191,7 @@
|
|
|
8178
8191
|
"summary": "Get validation run results",
|
|
8179
8192
|
"description": "Returns per-document and per-field accuracy results for the validation run.",
|
|
8180
8193
|
"tags": [
|
|
8181
|
-
"
|
|
8194
|
+
"Platform"
|
|
8182
8195
|
],
|
|
8183
8196
|
"parameters": [
|
|
8184
8197
|
{
|
|
@@ -8234,7 +8247,7 @@
|
|
|
8234
8247
|
"summary": "Get credit balance",
|
|
8235
8248
|
"description": "Returns the current credit balance for the authenticated customer.",
|
|
8236
8249
|
"tags": [
|
|
8237
|
-
"
|
|
8250
|
+
"Platform"
|
|
8238
8251
|
],
|
|
8239
8252
|
"responses": {
|
|
8240
8253
|
"200": {
|
|
@@ -8281,7 +8294,7 @@
|
|
|
8281
8294
|
"summary": "Get credit history",
|
|
8282
8295
|
"description": "Returns credit transaction history (purchases, deductions, adjustments).",
|
|
8283
8296
|
"tags": [
|
|
8284
|
-
"
|
|
8297
|
+
"Platform"
|
|
8285
8298
|
],
|
|
8286
8299
|
"parameters": [
|
|
8287
8300
|
{
|
|
@@ -8361,7 +8374,7 @@
|
|
|
8361
8374
|
"summary": "Get credit usage summary",
|
|
8362
8375
|
"description": "Returns aggregate credit usage broken down by feature.",
|
|
8363
8376
|
"tags": [
|
|
8364
|
-
"
|
|
8377
|
+
"Platform"
|
|
8365
8378
|
],
|
|
8366
8379
|
"parameters": [
|
|
8367
8380
|
{
|
|
@@ -8433,7 +8446,7 @@
|
|
|
8433
8446
|
"summary": "Get daily credit usage",
|
|
8434
8447
|
"description": "Returns per-day credit usage for the specified period (default last 30 days).",
|
|
8435
8448
|
"tags": [
|
|
8436
|
-
"
|
|
8449
|
+
"Platform"
|
|
8437
8450
|
],
|
|
8438
8451
|
"parameters": [
|
|
8439
8452
|
{
|
|
@@ -8502,7 +8515,7 @@
|
|
|
8502
8515
|
"summary": "Get credit usage log",
|
|
8503
8516
|
"description": "Returns a detailed per-request usage log with model, tokens, and cost.",
|
|
8504
8517
|
"tags": [
|
|
8505
|
-
"
|
|
8518
|
+
"Platform"
|
|
8506
8519
|
],
|
|
8507
8520
|
"parameters": [
|
|
8508
8521
|
{
|
|
@@ -8581,7 +8594,7 @@
|
|
|
8581
8594
|
"operationId": "updateCaseStatus",
|
|
8582
8595
|
"summary": "Update case status",
|
|
8583
8596
|
"tags": [
|
|
8584
|
-
"
|
|
8597
|
+
"Intelligence"
|
|
8585
8598
|
],
|
|
8586
8599
|
"parameters": [
|
|
8587
8600
|
{
|
|
@@ -8646,7 +8659,7 @@
|
|
|
8646
8659
|
"summary": "Get case edges",
|
|
8647
8660
|
"description": "Returns the entity edges (evidence chain) connecting documents within the case.",
|
|
8648
8661
|
"tags": [
|
|
8649
|
-
"
|
|
8662
|
+
"Intelligence"
|
|
8650
8663
|
],
|
|
8651
8664
|
"parameters": [
|
|
8652
8665
|
{
|
|
@@ -8718,7 +8731,7 @@
|
|
|
8718
8731
|
"summary": "Confirm a case edge",
|
|
8719
8732
|
"description": "Confirm a proposed entity edge between documents.",
|
|
8720
8733
|
"tags": [
|
|
8721
|
-
"
|
|
8734
|
+
"Intelligence"
|
|
8722
8735
|
],
|
|
8723
8736
|
"requestBody": {
|
|
8724
8737
|
"required": true,
|
|
@@ -8784,7 +8797,7 @@
|
|
|
8784
8797
|
"summary": "Reject a case edge",
|
|
8785
8798
|
"description": "Reject a proposed entity edge between documents.",
|
|
8786
8799
|
"tags": [
|
|
8787
|
-
"
|
|
8800
|
+
"Intelligence"
|
|
8788
8801
|
],
|
|
8789
8802
|
"requestBody": {
|
|
8790
8803
|
"required": true,
|
|
@@ -8850,7 +8863,7 @@
|
|
|
8850
8863
|
"summary": "Split a case",
|
|
8851
8864
|
"description": "Split a case into two separate cases by dividing documents.",
|
|
8852
8865
|
"tags": [
|
|
8853
|
-
"
|
|
8866
|
+
"Intelligence"
|
|
8854
8867
|
],
|
|
8855
8868
|
"parameters": [
|
|
8856
8869
|
{
|
|
@@ -8927,7 +8940,7 @@
|
|
|
8927
8940
|
"summary": "Merge cases",
|
|
8928
8941
|
"description": "Merge another case into this one, combining all documents.",
|
|
8929
8942
|
"tags": [
|
|
8930
|
-
"
|
|
8943
|
+
"Intelligence"
|
|
8931
8944
|
],
|
|
8932
8945
|
"parameters": [
|
|
8933
8946
|
{
|
|
@@ -8991,7 +9004,7 @@
|
|
|
8991
9004
|
"summary": "Get case completeness",
|
|
8992
9005
|
"description": "Returns a completeness assessment for the case (expected vs. present document types, missing fields).",
|
|
8993
9006
|
"tags": [
|
|
8994
|
-
"
|
|
9007
|
+
"Intelligence"
|
|
8995
9008
|
],
|
|
8996
9009
|
"parameters": [
|
|
8997
9010
|
{
|
|
@@ -9057,7 +9070,7 @@
|
|
|
9057
9070
|
"summary": "Pin documents to a case",
|
|
9058
9071
|
"description": "Manually pin one or more documents to a case.",
|
|
9059
9072
|
"tags": [
|
|
9060
|
-
"
|
|
9073
|
+
"Intelligence"
|
|
9061
9074
|
],
|
|
9062
9075
|
"parameters": [
|
|
9063
9076
|
{
|
|
@@ -9125,7 +9138,7 @@
|
|
|
9125
9138
|
"summary": "Remove documents from a case",
|
|
9126
9139
|
"description": "Remove one or more manually-pinned documents from a case.",
|
|
9127
9140
|
"tags": [
|
|
9128
|
-
"
|
|
9141
|
+
"Intelligence"
|
|
9129
9142
|
],
|
|
9130
9143
|
"parameters": [
|
|
9131
9144
|
{
|
|
@@ -9193,7 +9206,7 @@
|
|
|
9193
9206
|
"summary": "Sync batch status with provider",
|
|
9194
9207
|
"description": "Force a status sync with the batch inference provider (Anthropic or Bedrock).",
|
|
9195
9208
|
"tags": [
|
|
9196
|
-
"Batches"
|
|
9209
|
+
"Jobs & Batches"
|
|
9197
9210
|
],
|
|
9198
9211
|
"parameters": [
|
|
9199
9212
|
{
|
|
@@ -9229,7 +9242,7 @@
|
|
|
9229
9242
|
"summary": "Cancel a batch inference run",
|
|
9230
9243
|
"description": "Cancel an in-flight batch. Only batches in `accumulating` or `submitted` status can be cancelled.",
|
|
9231
9244
|
"tags": [
|
|
9232
|
-
"Batches"
|
|
9245
|
+
"Jobs & Batches"
|
|
9233
9246
|
],
|
|
9234
9247
|
"parameters": [
|
|
9235
9248
|
{
|
|
@@ -9268,7 +9281,7 @@
|
|
|
9268
9281
|
"summary": "Trigger a smart matching run",
|
|
9269
9282
|
"description": "AI-driven matching run that auto-suggests field mappings and strategies based on schema and reference data.",
|
|
9270
9283
|
"tags": [
|
|
9271
|
-
"
|
|
9284
|
+
"Intelligence"
|
|
9272
9285
|
],
|
|
9273
9286
|
"requestBody": {
|
|
9274
9287
|
"required": true,
|
|
@@ -9323,7 +9336,7 @@
|
|
|
9323
9336
|
"summary": "AI-resolve ambiguous matches",
|
|
9324
9337
|
"description": "Use AI to resolve ambiguous match candidates where confidence is below the auto-accept threshold.",
|
|
9325
9338
|
"tags": [
|
|
9326
|
-
"
|
|
9339
|
+
"Intelligence"
|
|
9327
9340
|
],
|
|
9328
9341
|
"requestBody": {
|
|
9329
9342
|
"required": true,
|
|
@@ -9386,7 +9399,7 @@
|
|
|
9386
9399
|
"summary": "List matching strategies",
|
|
9387
9400
|
"description": "Returns available matching strategies and their configurations.",
|
|
9388
9401
|
"tags": [
|
|
9389
|
-
"
|
|
9402
|
+
"Intelligence"
|
|
9390
9403
|
],
|
|
9391
9404
|
"responses": {
|
|
9392
9405
|
"200": {
|
|
@@ -9436,7 +9449,7 @@
|
|
|
9436
9449
|
"operationId": "createMatchingStrategy",
|
|
9437
9450
|
"summary": "Create a matching strategy",
|
|
9438
9451
|
"tags": [
|
|
9439
|
-
"
|
|
9452
|
+
"Intelligence"
|
|
9440
9453
|
],
|
|
9441
9454
|
"requestBody": {
|
|
9442
9455
|
"required": true,
|
|
@@ -9495,7 +9508,7 @@
|
|
|
9495
9508
|
"operationId": "getMatchingStrategy",
|
|
9496
9509
|
"summary": "Get a matching strategy",
|
|
9497
9510
|
"tags": [
|
|
9498
|
-
"
|
|
9511
|
+
"Intelligence"
|
|
9499
9512
|
],
|
|
9500
9513
|
"parameters": [
|
|
9501
9514
|
{
|
|
@@ -9529,7 +9542,7 @@
|
|
|
9529
9542
|
"operationId": "updateMatchingStrategy",
|
|
9530
9543
|
"summary": "Update a matching strategy",
|
|
9531
9544
|
"tags": [
|
|
9532
|
-
"
|
|
9545
|
+
"Intelligence"
|
|
9533
9546
|
],
|
|
9534
9547
|
"parameters": [
|
|
9535
9548
|
{
|
|
@@ -9585,7 +9598,7 @@
|
|
|
9585
9598
|
"operationId": "deleteMatchingStrategy",
|
|
9586
9599
|
"summary": "Delete a matching strategy",
|
|
9587
9600
|
"tags": [
|
|
9588
|
-
"
|
|
9601
|
+
"Intelligence"
|
|
9589
9602
|
],
|
|
9590
9603
|
"parameters": [
|
|
9591
9604
|
{
|
|
@@ -9621,7 +9634,7 @@
|
|
|
9621
9634
|
"summary": "Get matching run results",
|
|
9622
9635
|
"description": "Returns per-document match results with top candidates and field-level evidence.",
|
|
9623
9636
|
"tags": [
|
|
9624
|
-
"
|
|
9637
|
+
"Intelligence"
|
|
9625
9638
|
],
|
|
9626
9639
|
"parameters": [
|
|
9627
9640
|
{
|
|
@@ -9666,7 +9679,7 @@
|
|
|
9666
9679
|
"summary": "Get matching run progress",
|
|
9667
9680
|
"description": "Returns the processing progress for an in-flight matching run.",
|
|
9668
9681
|
"tags": [
|
|
9669
|
-
"
|
|
9682
|
+
"Intelligence"
|
|
9670
9683
|
],
|
|
9671
9684
|
"parameters": [
|
|
9672
9685
|
{
|
|
@@ -9718,7 +9731,7 @@
|
|
|
9718
9731
|
"summary": "Submit matching review decisions",
|
|
9719
9732
|
"description": "Submit accept/reject decisions on match candidates.",
|
|
9720
9733
|
"tags": [
|
|
9721
|
-
"
|
|
9734
|
+
"Intelligence"
|
|
9722
9735
|
],
|
|
9723
9736
|
"requestBody": {
|
|
9724
9737
|
"required": true,
|
|
@@ -9800,7 +9813,7 @@
|
|
|
9800
9813
|
"summary": "Assign review records",
|
|
9801
9814
|
"description": "Assign one or more review records to a team member.",
|
|
9802
9815
|
"tags": [
|
|
9803
|
-
"
|
|
9816
|
+
"Platform"
|
|
9804
9817
|
],
|
|
9805
9818
|
"requestBody": {
|
|
9806
9819
|
"required": true,
|
|
@@ -9866,7 +9879,7 @@
|
|
|
9866
9879
|
"summary": "Get review queue statistics",
|
|
9867
9880
|
"description": "Returns aggregate statistics about the review queue (pending, approved, rejected counts).",
|
|
9868
9881
|
"tags": [
|
|
9869
|
-
"
|
|
9882
|
+
"Platform"
|
|
9870
9883
|
],
|
|
9871
9884
|
"responses": {
|
|
9872
9885
|
"200": {
|
|
@@ -9907,7 +9920,7 @@
|
|
|
9907
9920
|
"operationId": "listGroundTruthEntries",
|
|
9908
9921
|
"summary": "List entries in a ground truth dataset",
|
|
9909
9922
|
"tags": [
|
|
9910
|
-
"
|
|
9923
|
+
"Platform"
|
|
9911
9924
|
],
|
|
9912
9925
|
"parameters": [
|
|
9913
9926
|
{
|
|
@@ -9961,7 +9974,7 @@
|
|
|
9961
9974
|
"operationId": "createGroundTruthEntry",
|
|
9962
9975
|
"summary": "Add an entry to a ground truth dataset",
|
|
9963
9976
|
"tags": [
|
|
9964
|
-
"
|
|
9977
|
+
"Platform"
|
|
9965
9978
|
],
|
|
9966
9979
|
"parameters": [
|
|
9967
9980
|
{
|
|
@@ -10027,7 +10040,7 @@
|
|
|
10027
10040
|
"operationId": "updateGroundTruthEntry",
|
|
10028
10041
|
"summary": "Update a ground truth entry",
|
|
10029
10042
|
"tags": [
|
|
10030
|
-
"
|
|
10043
|
+
"Platform"
|
|
10031
10044
|
],
|
|
10032
10045
|
"parameters": [
|
|
10033
10046
|
{
|
|
@@ -10091,7 +10104,7 @@
|
|
|
10091
10104
|
"operationId": "deleteGroundTruthEntry",
|
|
10092
10105
|
"summary": "Delete a ground truth entry",
|
|
10093
10106
|
"tags": [
|
|
10094
|
-
"
|
|
10107
|
+
"Platform"
|
|
10095
10108
|
],
|
|
10096
10109
|
"parameters": [
|
|
10097
10110
|
{
|
|
@@ -10138,7 +10151,7 @@
|
|
|
10138
10151
|
"summary": "Get benchmark results",
|
|
10139
10152
|
"description": "Returns per-document accuracy results for a benchmark run.",
|
|
10140
10153
|
"tags": [
|
|
10141
|
-
"
|
|
10154
|
+
"Platform"
|
|
10142
10155
|
],
|
|
10143
10156
|
"parameters": [
|
|
10144
10157
|
{
|
|
@@ -10182,7 +10195,7 @@
|
|
|
10182
10195
|
"summary": "Compare two benchmark runs",
|
|
10183
10196
|
"description": "Returns accuracy deltas between the target benchmark and a comparison run.",
|
|
10184
10197
|
"tags": [
|
|
10185
|
-
"
|
|
10198
|
+
"Platform"
|
|
10186
10199
|
],
|
|
10187
10200
|
"parameters": [
|
|
10188
10201
|
{
|
|
@@ -10254,7 +10267,7 @@
|
|
|
10254
10267
|
"summary": "Create reference data from JSON",
|
|
10255
10268
|
"description": "Create a new reference dataset by uploading JSON data directly (alternative to CSV/XLSX file upload).",
|
|
10256
10269
|
"tags": [
|
|
10257
|
-
"
|
|
10270
|
+
"Intelligence"
|
|
10258
10271
|
],
|
|
10259
10272
|
"requestBody": {
|
|
10260
10273
|
"required": true,
|
|
@@ -10320,7 +10333,7 @@
|
|
|
10320
10333
|
"summary": "Get workspace context",
|
|
10321
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",
|
|
10322
10335
|
"tags": [
|
|
10323
|
-
"
|
|
10336
|
+
"Platform"
|
|
10324
10337
|
],
|
|
10325
10338
|
"responses": {
|
|
10326
10339
|
"200": {
|
|
@@ -10375,7 +10388,7 @@
|
|
|
10375
10388
|
"summary": "List available agent tools",
|
|
10376
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",
|
|
10377
10390
|
"tags": [
|
|
10378
|
-
"
|
|
10391
|
+
"Platform"
|
|
10379
10392
|
],
|
|
10380
10393
|
"responses": {
|
|
10381
10394
|
"200": {
|
|
@@ -10524,8 +10537,13 @@
|
|
|
10524
10537
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
10525
10538
|
},
|
|
10526
10539
|
"example": {
|
|
10527
|
-
"
|
|
10528
|
-
"
|
|
10540
|
+
"statusCode": 400,
|
|
10541
|
+
"code": "VALIDATION_ERROR",
|
|
10542
|
+
"error": "Bad Request",
|
|
10543
|
+
"message": "name is required.",
|
|
10544
|
+
"retryable": false,
|
|
10545
|
+
"timestamp": "2026-04-25T14:30:00.000Z",
|
|
10546
|
+
"path": "/v1/schemas"
|
|
10529
10547
|
}
|
|
10530
10548
|
}
|
|
10531
10549
|
}
|
|
@@ -10538,8 +10556,13 @@
|
|
|
10538
10556
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
10539
10557
|
},
|
|
10540
10558
|
"example": {
|
|
10541
|
-
"
|
|
10542
|
-
"
|
|
10559
|
+
"statusCode": 401,
|
|
10560
|
+
"code": "AUTH_REQUIRED",
|
|
10561
|
+
"error": "Unauthorized",
|
|
10562
|
+
"message": "Invalid or missing API key.",
|
|
10563
|
+
"retryable": false,
|
|
10564
|
+
"timestamp": "2026-04-25T14:30:00.000Z",
|
|
10565
|
+
"path": "/v1/extract"
|
|
10543
10566
|
}
|
|
10544
10567
|
}
|
|
10545
10568
|
}
|
|
@@ -10552,8 +10575,13 @@
|
|
|
10552
10575
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
10553
10576
|
},
|
|
10554
10577
|
"example": {
|
|
10555
|
-
"
|
|
10556
|
-
"
|
|
10578
|
+
"statusCode": 403,
|
|
10579
|
+
"code": "INSUFFICIENT_PERMISSIONS",
|
|
10580
|
+
"error": "Forbidden",
|
|
10581
|
+
"message": "This key does not have the 'write' scope.",
|
|
10582
|
+
"retryable": false,
|
|
10583
|
+
"timestamp": "2026-04-25T14:30:00.000Z",
|
|
10584
|
+
"path": "/v1/schemas"
|
|
10557
10585
|
}
|
|
10558
10586
|
}
|
|
10559
10587
|
}
|
|
@@ -10566,8 +10594,13 @@
|
|
|
10566
10594
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
10567
10595
|
},
|
|
10568
10596
|
"example": {
|
|
10569
|
-
"
|
|
10570
|
-
"
|
|
10597
|
+
"statusCode": 404,
|
|
10598
|
+
"code": "RESOURCE_NOT_FOUND",
|
|
10599
|
+
"error": "Not Found",
|
|
10600
|
+
"message": "Document 'f0e1d2c3-b4a5-9687-8765-432109876543' not found.",
|
|
10601
|
+
"retryable": false,
|
|
10602
|
+
"timestamp": "2026-04-25T14:30:00.000Z",
|
|
10603
|
+
"path": "/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543"
|
|
10571
10604
|
}
|
|
10572
10605
|
}
|
|
10573
10606
|
}
|
|
@@ -10580,8 +10613,13 @@
|
|
|
10580
10613
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
10581
10614
|
},
|
|
10582
10615
|
"example": {
|
|
10583
|
-
"
|
|
10584
|
-
"
|
|
10616
|
+
"statusCode": 409,
|
|
10617
|
+
"code": "VALIDATION_ERROR",
|
|
10618
|
+
"error": "Conflict",
|
|
10619
|
+
"message": "Job is already completed. Cannot cancel.",
|
|
10620
|
+
"retryable": false,
|
|
10621
|
+
"timestamp": "2026-04-25T14:30:00.000Z",
|
|
10622
|
+
"path": "/v1/jobs/c3d4e5f6-a7b8-9012-cdef-123456789012/cancel"
|
|
10585
10623
|
}
|
|
10586
10624
|
}
|
|
10587
10625
|
}
|
|
@@ -10594,8 +10632,13 @@
|
|
|
10594
10632
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
10595
10633
|
},
|
|
10596
10634
|
"example": {
|
|
10597
|
-
"
|
|
10598
|
-
"
|
|
10635
|
+
"statusCode": 413,
|
|
10636
|
+
"code": "FILE_TOO_LARGE",
|
|
10637
|
+
"error": "Payload Too Large",
|
|
10638
|
+
"message": "File exceeds the 500 MB limit.",
|
|
10639
|
+
"retryable": false,
|
|
10640
|
+
"timestamp": "2026-04-25T14:30:00.000Z",
|
|
10641
|
+
"path": "/v1/extract"
|
|
10599
10642
|
}
|
|
10600
10643
|
}
|
|
10601
10644
|
}
|
|
@@ -10608,9 +10651,13 @@
|
|
|
10608
10651
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
10609
10652
|
},
|
|
10610
10653
|
"example": {
|
|
10611
|
-
"
|
|
10654
|
+
"statusCode": 422,
|
|
10655
|
+
"code": "EXTRACTION_FAILED",
|
|
10656
|
+
"error": "Unprocessable Entity",
|
|
10612
10657
|
"message": "Unable to extract fields from the provided document.",
|
|
10613
|
-
"
|
|
10658
|
+
"retryable": false,
|
|
10659
|
+
"timestamp": "2026-04-25T14:30:00.000Z",
|
|
10660
|
+
"path": "/v1/extract",
|
|
10614
10661
|
"links": {
|
|
10615
10662
|
"dashboard": "https://app.talonic.com/documents/abc-123"
|
|
10616
10663
|
}
|
|
@@ -10637,11 +10684,13 @@
|
|
|
10637
10684
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
10638
10685
|
},
|
|
10639
10686
|
"example": {
|
|
10640
|
-
"
|
|
10687
|
+
"statusCode": 429,
|
|
10688
|
+
"code": "QUOTA_EXCEEDED",
|
|
10689
|
+
"error": "Too Many Requests",
|
|
10641
10690
|
"message": "Daily extract request limit (50) reached. Resets at midnight UTC.",
|
|
10642
|
-
"
|
|
10643
|
-
"
|
|
10644
|
-
"
|
|
10691
|
+
"retryable": true,
|
|
10692
|
+
"timestamp": "2026-04-25T23:45:00.000Z",
|
|
10693
|
+
"path": "/v1/extract"
|
|
10645
10694
|
}
|
|
10646
10695
|
}
|
|
10647
10696
|
}
|
|
@@ -10654,9 +10703,13 @@
|
|
|
10654
10703
|
"$ref": "#/components/schemas/ErrorResponse"
|
|
10655
10704
|
},
|
|
10656
10705
|
"example": {
|
|
10657
|
-
"
|
|
10706
|
+
"statusCode": 500,
|
|
10707
|
+
"code": "INTERNAL_ERROR",
|
|
10708
|
+
"error": "Internal Server Error",
|
|
10658
10709
|
"message": "An unexpected error occurred. Please try again or contact support.",
|
|
10659
|
-
"
|
|
10710
|
+
"retryable": true,
|
|
10711
|
+
"timestamp": "2026-04-25T14:30:00.000Z",
|
|
10712
|
+
"path": "/v1/extract"
|
|
10660
10713
|
}
|
|
10661
10714
|
}
|
|
10662
10715
|
}
|
|
@@ -10666,29 +10719,143 @@
|
|
|
10666
10719
|
"ErrorResponse": {
|
|
10667
10720
|
"type": "object",
|
|
10668
10721
|
"required": [
|
|
10722
|
+
"statusCode",
|
|
10723
|
+
"code",
|
|
10669
10724
|
"error",
|
|
10670
|
-
"message"
|
|
10725
|
+
"message",
|
|
10726
|
+
"retryable",
|
|
10727
|
+
"timestamp",
|
|
10728
|
+
"path"
|
|
10671
10729
|
],
|
|
10672
10730
|
"properties": {
|
|
10731
|
+
"statusCode": {
|
|
10732
|
+
"type": "integer",
|
|
10733
|
+
"description": "HTTP status code.",
|
|
10734
|
+
"example": 400
|
|
10735
|
+
},
|
|
10736
|
+
"code": {
|
|
10737
|
+
"type": "string",
|
|
10738
|
+
"description": "Machine-readable error discriminant. One of: VALIDATION_ERROR,\nAUTH_REQUIRED, TOKEN_EXPIRED, INSUFFICIENT_PERMISSIONS,\nRESOURCE_NOT_FOUND, QUOTA_EXCEEDED, INSUFFICIENT_CREDITS,\nLLM_RATE_LIMITED, LLM_TIMEOUT, LLM_UNAVAILABLE, OCR_FAILED,\nEXTRACTION_FAILED, EXTRACTION_TIMEOUT, FILE_TOO_LARGE,\nDUPLICATE_RESOURCE, DATASPACE_RUN_FAILED, INTERNAL_ERROR.\n",
|
|
10739
|
+
"example": "VALIDATION_ERROR"
|
|
10740
|
+
},
|
|
10673
10741
|
"error": {
|
|
10674
10742
|
"type": "string",
|
|
10675
|
-
"description": "
|
|
10743
|
+
"description": "HTTP status name.",
|
|
10744
|
+
"example": "Bad Request"
|
|
10676
10745
|
},
|
|
10677
10746
|
"message": {
|
|
10678
10747
|
"type": "string",
|
|
10679
|
-
"
|
|
10680
|
-
"
|
|
10748
|
+
"description": "Human-readable error description.",
|
|
10749
|
+
"example": "name is required."
|
|
10681
10750
|
},
|
|
10682
|
-
"
|
|
10751
|
+
"retryable": {
|
|
10752
|
+
"type": "boolean",
|
|
10753
|
+
"description": "Whether the client should retry the request.",
|
|
10754
|
+
"example": false
|
|
10755
|
+
},
|
|
10756
|
+
"timestamp": {
|
|
10683
10757
|
"type": "string",
|
|
10684
|
-
"
|
|
10758
|
+
"format": "date-time",
|
|
10759
|
+
"description": "ISO 8601 timestamp when the error occurred.",
|
|
10760
|
+
"example": "2026-04-25T14:30:00.000Z"
|
|
10685
10761
|
},
|
|
10686
|
-
"
|
|
10762
|
+
"path": {
|
|
10763
|
+
"type": "string",
|
|
10764
|
+
"description": "Request path that failed.",
|
|
10765
|
+
"example": "/v1/schemas"
|
|
10766
|
+
}
|
|
10767
|
+
}
|
|
10768
|
+
},
|
|
10769
|
+
"WebhookEvent": {
|
|
10770
|
+
"type": "object",
|
|
10771
|
+
"description": "Webhook delivery payload sent to configured destinations.",
|
|
10772
|
+
"required": [
|
|
10773
|
+
"event"
|
|
10774
|
+
],
|
|
10775
|
+
"properties": {
|
|
10776
|
+
"event": {
|
|
10687
10777
|
"type": "object",
|
|
10688
|
-
"
|
|
10689
|
-
"
|
|
10690
|
-
|
|
10691
|
-
|
|
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
|
+
}
|
|
10692
10859
|
}
|
|
10693
10860
|
}
|
|
10694
10861
|
},
|