@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/dist/seo.js
CHANGED
|
@@ -4,7 +4,7 @@ var openapi_default = {
|
|
|
4
4
|
info: {
|
|
5
5
|
title: "Talonic API",
|
|
6
6
|
version: "1.0.0",
|
|
7
|
-
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 (\u22645 pages) are processed synchronously and return a `200`\nwith the extracted data immediately. Larger documents return a `202 Accepted`\nwith a `poll_url` \u2014 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` \u2192 `processing` \u2192 `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` \u2014 daily cap for the namespace\n- `X-RateLimit-Remaining` \u2014 requests left today\n- `X-RateLimit-Reset` \u2014 ISO 8601 timestamp when the window resets (midnight UTC)\n\n## Pagination\n\nList endpoints use cursor-based pagination. Pass `limit` (1\u2013100, 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',
|
|
7
|
+
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 (\u22645 pages) are processed synchronously and return a `200`\nwith the extracted data immediately. Larger documents return a `202 Accepted`\nwith a `poll_url` \u2014 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` \u2192 `processing` \u2192 `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` \u2014 daily cap for the namespace\n- `X-RateLimit-Remaining` \u2014 requests left today\n- `X-RateLimit-Reset` \u2014 ISO 8601 timestamp when the window resets (midnight UTC)\n\n## Pagination\n\nList endpoints use cursor-based pagination. Pass `limit` (1\u2013100, 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 \u22645 pages return results synchronously (`200`). Larger documents\n\u2014 or any request with `options: {"async": true}` \u2014 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\u21924\u21928\u219216\u219230s cap),\ntimeout after 5 minutes.\n\n**Alternative \u2014 Webhooks:** Configure a delivery destination and listen for\n`document.extracted` events. See the Delivery tag.\n\n**Job status state machine:**\n`pending` \u2192 `queued` \u2192 `processing` \u2192 `complete` | `failed`\n\n## Performance\n\n| Document size | Expected latency | Max timeout |\n|---------------|------------------|-------------|\n| 1\u20135 pages | Sync, <3s | 30s |\n| 6\u201350 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',
|
|
8
8
|
contact: {
|
|
9
9
|
name: "Talonic Support",
|
|
10
10
|
email: "support@talonic.ai",
|
|
@@ -32,115 +32,39 @@ var openapi_default = {
|
|
|
32
32
|
tags: [
|
|
33
33
|
{
|
|
34
34
|
name: "Extract",
|
|
35
|
-
description: "Upload a document and extract structured data in one call."
|
|
35
|
+
description: "Upload a document and extract structured data in one call. Start here."
|
|
36
36
|
},
|
|
37
37
|
{
|
|
38
38
|
name: "Documents",
|
|
39
|
-
description: "Browse, inspect, and delete processed documents."
|
|
39
|
+
description: "Browse, inspect, and delete processed documents. Includes document type classification and OCR markdown retrieval."
|
|
40
40
|
},
|
|
41
41
|
{
|
|
42
42
|
name: "Extractions",
|
|
43
|
-
description: "Access and
|
|
43
|
+
description: "Access extraction results, retrieve structured data in JSON or CSV, and submit field-level corrections."
|
|
44
44
|
},
|
|
45
45
|
{
|
|
46
46
|
name: "Schemas",
|
|
47
|
-
description: "Create and manage reusable extraction schemas."
|
|
47
|
+
description: "Create and manage reusable extraction schemas, schema graph classes, output dialects, and the field registry."
|
|
48
48
|
},
|
|
49
49
|
{
|
|
50
|
-
name: "Jobs",
|
|
51
|
-
description: "Track and
|
|
50
|
+
name: "Jobs & Batches",
|
|
51
|
+
description: "Track async processing jobs, poll for completion, retrieve result grids, and manage batch inference runs at 50% cost."
|
|
52
52
|
},
|
|
53
53
|
{
|
|
54
54
|
name: "Sources",
|
|
55
|
-
description: "
|
|
56
|
-
},
|
|
57
|
-
{
|
|
58
|
-
name: "Dialects",
|
|
59
|
-
description: "Manage shared dialects \u2014 named presets for output format conventions (date format, number locale, CSV delimiter, encoding, boolean rendering)."
|
|
60
|
-
},
|
|
61
|
-
{
|
|
62
|
-
name: "Matching",
|
|
63
|
-
description: "Reference-data matching configurations and runs. Matches extracted document fields against reference datasets with weighted field mappings."
|
|
64
|
-
},
|
|
65
|
-
{
|
|
66
|
-
name: "Routing",
|
|
67
|
-
description: "Document routing rules that trigger actions when classification conditions are met."
|
|
55
|
+
description: "Create document ingest sources with dedicated API keys. Upload documents for automatic extraction."
|
|
68
56
|
},
|
|
69
57
|
{
|
|
70
58
|
name: "Delivery",
|
|
71
|
-
description:
|
|
72
|
-
},
|
|
73
|
-
{
|
|
74
|
-
name: "Filter",
|
|
75
|
-
description: "Structured filter queries over materialised document values plus omnisearch across documents, fields, and schemas."
|
|
76
|
-
},
|
|
77
|
-
{
|
|
78
|
-
name: "Review",
|
|
79
|
-
description: "Queue of validation records requiring human review; supports single- and batch-action approvals/rejections."
|
|
80
|
-
},
|
|
81
|
-
{
|
|
82
|
-
name: "Quality",
|
|
83
|
-
description: "Ground truth datasets and benchmark runs for measuring extraction accuracy."
|
|
59
|
+
description: 'Outbound delivery pipeline \u2014 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 \u2014 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'
|
|
84
60
|
},
|
|
85
61
|
{
|
|
86
|
-
name: "
|
|
87
|
-
description: "
|
|
62
|
+
name: "Intelligence",
|
|
63
|
+
description: "Reference-data matching, document linking graphs, case discovery, resolution runs, N-Shot comparisons, and reference dataset management."
|
|
88
64
|
},
|
|
89
65
|
{
|
|
90
|
-
name: "
|
|
91
|
-
description: "
|
|
92
|
-
},
|
|
93
|
-
{
|
|
94
|
-
name: "Document Types",
|
|
95
|
-
description: "Canonical document type ontology and the customer's resolved types."
|
|
96
|
-
},
|
|
97
|
-
{
|
|
98
|
-
name: "Fields",
|
|
99
|
-
description: "Field registry \u2014 canonical field definitions discovered across the customer's documents plus cross-schema harmonization."
|
|
100
|
-
},
|
|
101
|
-
{
|
|
102
|
-
name: "Reference Data",
|
|
103
|
-
description: "Uploaded reference datasets (CSV/XLSX) used by matching configurations for lookups and joins."
|
|
104
|
-
},
|
|
105
|
-
{
|
|
106
|
-
name: "Usage",
|
|
107
|
-
description: "Aggregate and per-document API usage accounting (tokens, costs, operation types)."
|
|
108
|
-
},
|
|
109
|
-
{
|
|
110
|
-
name: "Resolutions",
|
|
111
|
-
description: "Resolution runs \u2014 apply field normalization, transforms, and lookup cascades to extracted data."
|
|
112
|
-
},
|
|
113
|
-
{
|
|
114
|
-
name: "Linking",
|
|
115
|
-
description: "Document linking graph \u2014 link keys, document links, entity graph, classification, and backfill operations."
|
|
116
|
-
},
|
|
117
|
-
{
|
|
118
|
-
name: "N-Shot",
|
|
119
|
-
description: "N-Shot comparison endpoints for job runs \u2014 summary, field comparisons, overrides, and judge decisions."
|
|
120
|
-
},
|
|
121
|
-
{
|
|
122
|
-
name: "Schema Graph",
|
|
123
|
-
description: "Schema class ontology \u2014 versioned classes, diffs with approval workflow, edges, aliases, and visualization."
|
|
124
|
-
},
|
|
125
|
-
{
|
|
126
|
-
name: "Structuring",
|
|
127
|
-
description: "Structuring pipeline \u2014 validation checks, approval gates with rules, result checks, pending approvals, and delivery triggers."
|
|
128
|
-
},
|
|
129
|
-
{
|
|
130
|
-
name: "Telemetry",
|
|
131
|
-
description: "Aggregate structuring metrics \u2014 capture hit rate, synthesize rate, strategy distribution, and tier funnel breakdowns per schema or run."
|
|
132
|
-
},
|
|
133
|
-
{
|
|
134
|
-
name: "Validation",
|
|
135
|
-
description: "Golden sample management and validation runs for measuring extraction accuracy against ground truth."
|
|
136
|
-
},
|
|
137
|
-
{
|
|
138
|
-
name: "Credits",
|
|
139
|
-
description: "Credit balance, usage history, daily breakdown, and per-request usage log."
|
|
140
|
-
},
|
|
141
|
-
{
|
|
142
|
-
name: "Agent",
|
|
143
|
-
description: "Workspace context snapshot and tool discovery for the embedded AI agent."
|
|
66
|
+
name: "Platform",
|
|
67
|
+
description: "Usage accounting, credit balance, quality benchmarks, structuring checks, validation runs, review queue, telemetry metrics, and the embedded AI agent."
|
|
144
68
|
}
|
|
145
69
|
],
|
|
146
70
|
paths: {
|
|
@@ -1057,6 +981,45 @@ var openapi_default = {
|
|
|
1057
981
|
"application/json": {
|
|
1058
982
|
schema: {
|
|
1059
983
|
$ref: "#/components/schemas/ExtractionResponse"
|
|
984
|
+
},
|
|
985
|
+
example: {
|
|
986
|
+
id: "d1a2b3c4-5678-9abc-def0-1234567890ab",
|
|
987
|
+
status: "complete",
|
|
988
|
+
document: {
|
|
989
|
+
id: "f0e1d2c3-b4a5-9687-8765-432109876543",
|
|
990
|
+
filename: "invoice-042.pdf",
|
|
991
|
+
pages: 3,
|
|
992
|
+
type_detected: "Invoice"
|
|
993
|
+
},
|
|
994
|
+
data: {
|
|
995
|
+
vendor_name: "Acme Corporation Ltd.",
|
|
996
|
+
total_amount: 1275.5,
|
|
997
|
+
invoice_number: "INV-2024-0042"
|
|
998
|
+
},
|
|
999
|
+
confidence: {
|
|
1000
|
+
overall: 0.96,
|
|
1001
|
+
fields: {
|
|
1002
|
+
vendor_name: 1,
|
|
1003
|
+
total_amount: 1,
|
|
1004
|
+
invoice_number: 0.99
|
|
1005
|
+
}
|
|
1006
|
+
},
|
|
1007
|
+
locked_fields: [
|
|
1008
|
+
"vendor_name",
|
|
1009
|
+
"total_amount"
|
|
1010
|
+
],
|
|
1011
|
+
processing: {
|
|
1012
|
+
duration_ms: 3420,
|
|
1013
|
+
pages_processed: 3,
|
|
1014
|
+
region: "eu-west"
|
|
1015
|
+
},
|
|
1016
|
+
created_at: "2026-04-25T14:30:00.000Z",
|
|
1017
|
+
links: {
|
|
1018
|
+
self: "/v1/extractions/d1a2b3c4-5678-9abc-def0-1234567890ab",
|
|
1019
|
+
data: "/v1/extractions/d1a2b3c4-5678-9abc-def0-1234567890ab/data",
|
|
1020
|
+
document: "/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543",
|
|
1021
|
+
dashboard: "https://app.talonic.com/extractions/d1a2b3c4-5678-9abc-def0-1234567890ab"
|
|
1022
|
+
}
|
|
1060
1023
|
}
|
|
1061
1024
|
}
|
|
1062
1025
|
}
|
|
@@ -1419,7 +1382,7 @@ var openapi_default = {
|
|
|
1419
1382
|
summary: "Create and queue a new job",
|
|
1420
1383
|
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",
|
|
1421
1384
|
tags: [
|
|
1422
|
-
"Jobs"
|
|
1385
|
+
"Jobs & Batches"
|
|
1423
1386
|
],
|
|
1424
1387
|
requestBody: {
|
|
1425
1388
|
required: true,
|
|
@@ -1481,7 +1444,7 @@ var openapi_default = {
|
|
|
1481
1444
|
operationId: "listJobs",
|
|
1482
1445
|
summary: "List jobs",
|
|
1483
1446
|
tags: [
|
|
1484
|
-
"Jobs"
|
|
1447
|
+
"Jobs & Batches"
|
|
1485
1448
|
],
|
|
1486
1449
|
parameters: [
|
|
1487
1450
|
{
|
|
@@ -1578,7 +1541,7 @@ var openapi_default = {
|
|
|
1578
1541
|
operationId: "getJob",
|
|
1579
1542
|
summary: "Get a job",
|
|
1580
1543
|
tags: [
|
|
1581
|
-
"Jobs"
|
|
1544
|
+
"Jobs & Batches"
|
|
1582
1545
|
],
|
|
1583
1546
|
parameters: [
|
|
1584
1547
|
{
|
|
@@ -1592,6 +1555,34 @@ var openapi_default = {
|
|
|
1592
1555
|
"application/json": {
|
|
1593
1556
|
schema: {
|
|
1594
1557
|
$ref: "#/components/schemas/JobResponse"
|
|
1558
|
+
},
|
|
1559
|
+
example: {
|
|
1560
|
+
id: "c3d4e5f6-a7b8-9012-cdef-123456789012",
|
|
1561
|
+
name: "Q1 Invoice Processing",
|
|
1562
|
+
status: "processing",
|
|
1563
|
+
progress: 45,
|
|
1564
|
+
estimated_seconds_remaining: null,
|
|
1565
|
+
schema: {
|
|
1566
|
+
id: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
|
|
1567
|
+
name: "Invoice Schema"
|
|
1568
|
+
},
|
|
1569
|
+
document_count: 150,
|
|
1570
|
+
completed_documents: 67,
|
|
1571
|
+
grid_stats: {
|
|
1572
|
+
total_cells: 8850,
|
|
1573
|
+
filled: 6200,
|
|
1574
|
+
empty: 2650,
|
|
1575
|
+
fill_rate: 0.7
|
|
1576
|
+
},
|
|
1577
|
+
current_phase: "phase_2_execute",
|
|
1578
|
+
created_at: "2026-04-25T14:30:00.000Z",
|
|
1579
|
+
started_at: "2026-04-25T14:30:05.000Z",
|
|
1580
|
+
completed_at: null,
|
|
1581
|
+
links: {
|
|
1582
|
+
self: "/v1/jobs/c3d4e5f6-a7b8-9012-cdef-123456789012",
|
|
1583
|
+
cancel: "/v1/jobs/c3d4e5f6-a7b8-9012-cdef-123456789012/cancel",
|
|
1584
|
+
dashboard: "https://app.talonic.com/jobs/c3d4e5f6-a7b8-9012-cdef-123456789012"
|
|
1585
|
+
}
|
|
1595
1586
|
}
|
|
1596
1587
|
}
|
|
1597
1588
|
}
|
|
@@ -1614,7 +1605,7 @@ var openapi_default = {
|
|
|
1614
1605
|
summary: "Cancel a job",
|
|
1615
1606
|
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",
|
|
1616
1607
|
tags: [
|
|
1617
|
-
"Jobs"
|
|
1608
|
+
"Jobs & Batches"
|
|
1618
1609
|
],
|
|
1619
1610
|
parameters: [
|
|
1620
1611
|
{
|
|
@@ -1656,7 +1647,7 @@ var openapi_default = {
|
|
|
1656
1647
|
summary: "Get job result rows",
|
|
1657
1648
|
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",
|
|
1658
1649
|
tags: [
|
|
1659
|
-
"Jobs"
|
|
1650
|
+
"Jobs & Batches"
|
|
1660
1651
|
],
|
|
1661
1652
|
parameters: [
|
|
1662
1653
|
{
|
|
@@ -1744,6 +1735,10 @@ var openapi_default = {
|
|
|
1744
1735
|
"application/json": {
|
|
1745
1736
|
schema: {
|
|
1746
1737
|
$ref: "#/components/schemas/SourceCreateRequest"
|
|
1738
|
+
},
|
|
1739
|
+
example: {
|
|
1740
|
+
name: "Invoice Pipeline",
|
|
1741
|
+
default_schema_id: "b2c3d4e5-f6a7-8901-bcde-f12345678901"
|
|
1747
1742
|
}
|
|
1748
1743
|
}
|
|
1749
1744
|
}
|
|
@@ -1769,6 +1764,24 @@ var openapi_default = {
|
|
|
1769
1764
|
}
|
|
1770
1765
|
}
|
|
1771
1766
|
]
|
|
1767
|
+
},
|
|
1768
|
+
example: {
|
|
1769
|
+
id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
1770
|
+
name: "Invoice Pipeline",
|
|
1771
|
+
type: "api",
|
|
1772
|
+
status: "active",
|
|
1773
|
+
document_count: 0,
|
|
1774
|
+
default_schema: {
|
|
1775
|
+
id: "b2c3d4e5-f6a7-8901-bcde-f12345678901"
|
|
1776
|
+
},
|
|
1777
|
+
endpoint: "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/documents",
|
|
1778
|
+
api_key: "tlnc_live_src_k8m2n4p6q9r1s3t5",
|
|
1779
|
+
created_at: "2026-04-25T14:30:00.000Z",
|
|
1780
|
+
links: {
|
|
1781
|
+
self: "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
1782
|
+
documents: "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/documents",
|
|
1783
|
+
dashboard: "https://app.talonic.com/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
|
1784
|
+
}
|
|
1772
1785
|
}
|
|
1773
1786
|
}
|
|
1774
1787
|
}
|
|
@@ -2053,7 +2066,7 @@ var openapi_default = {
|
|
|
2053
2066
|
summary: "List dialects",
|
|
2054
2067
|
description: "Return every shared dialect defined for the authenticated customer.",
|
|
2055
2068
|
tags: [
|
|
2056
|
-
"
|
|
2069
|
+
"Schemas"
|
|
2057
2070
|
],
|
|
2058
2071
|
responses: {
|
|
2059
2072
|
"200": {
|
|
@@ -2098,7 +2111,7 @@ var openapi_default = {
|
|
|
2098
2111
|
summary: "Create a dialect",
|
|
2099
2112
|
description: "Create a new shared dialect.",
|
|
2100
2113
|
tags: [
|
|
2101
|
-
"
|
|
2114
|
+
"Schemas"
|
|
2102
2115
|
],
|
|
2103
2116
|
requestBody: {
|
|
2104
2117
|
required: true,
|
|
@@ -2148,7 +2161,7 @@ var openapi_default = {
|
|
|
2148
2161
|
operationId: "getDialect",
|
|
2149
2162
|
summary: "Get a dialect",
|
|
2150
2163
|
tags: [
|
|
2151
|
-
"
|
|
2164
|
+
"Schemas"
|
|
2152
2165
|
],
|
|
2153
2166
|
parameters: [
|
|
2154
2167
|
{
|
|
@@ -2182,7 +2195,7 @@ var openapi_default = {
|
|
|
2182
2195
|
summary: "Update a dialect",
|
|
2183
2196
|
description: "Partial update. Only the keys present on the body are patched. Bumps the stored `version`.",
|
|
2184
2197
|
tags: [
|
|
2185
|
-
"
|
|
2198
|
+
"Schemas"
|
|
2186
2199
|
],
|
|
2187
2200
|
parameters: [
|
|
2188
2201
|
{
|
|
@@ -2228,7 +2241,7 @@ var openapi_default = {
|
|
|
2228
2241
|
operationId: "deleteDialect",
|
|
2229
2242
|
summary: "Delete a dialect",
|
|
2230
2243
|
tags: [
|
|
2231
|
-
"
|
|
2244
|
+
"Schemas"
|
|
2232
2245
|
],
|
|
2233
2246
|
parameters: [
|
|
2234
2247
|
{
|
|
@@ -2269,7 +2282,7 @@ var openapi_default = {
|
|
|
2269
2282
|
operationId: "listMatchingConfigs",
|
|
2270
2283
|
summary: "List matching configurations",
|
|
2271
2284
|
tags: [
|
|
2272
|
-
"
|
|
2285
|
+
"Intelligence"
|
|
2273
2286
|
],
|
|
2274
2287
|
parameters: [
|
|
2275
2288
|
{
|
|
@@ -2332,7 +2345,7 @@ var openapi_default = {
|
|
|
2332
2345
|
summary: "Create a matching configuration",
|
|
2333
2346
|
description: "Link a reference dataset to a target scope via weighted field mappings.\nThe reference dataset must belong to the authenticated customer.\n",
|
|
2334
2347
|
tags: [
|
|
2335
|
-
"
|
|
2348
|
+
"Intelligence"
|
|
2336
2349
|
],
|
|
2337
2350
|
requestBody: {
|
|
2338
2351
|
required: true,
|
|
@@ -2385,7 +2398,7 @@ var openapi_default = {
|
|
|
2385
2398
|
operationId: "getMatchingConfig",
|
|
2386
2399
|
summary: "Get a matching configuration",
|
|
2387
2400
|
tags: [
|
|
2388
|
-
"
|
|
2401
|
+
"Intelligence"
|
|
2389
2402
|
],
|
|
2390
2403
|
parameters: [
|
|
2391
2404
|
{
|
|
@@ -2419,7 +2432,7 @@ var openapi_default = {
|
|
|
2419
2432
|
summary: "Update a matching configuration",
|
|
2420
2433
|
description: "Partial update \u2014 only provided keys are applied.",
|
|
2421
2434
|
tags: [
|
|
2422
|
-
"
|
|
2435
|
+
"Intelligence"
|
|
2423
2436
|
],
|
|
2424
2437
|
parameters: [
|
|
2425
2438
|
{
|
|
@@ -2465,7 +2478,7 @@ var openapi_default = {
|
|
|
2465
2478
|
operationId: "deleteMatchingConfig",
|
|
2466
2479
|
summary: "Delete a matching configuration",
|
|
2467
2480
|
tags: [
|
|
2468
|
-
"
|
|
2481
|
+
"Intelligence"
|
|
2469
2482
|
],
|
|
2470
2483
|
parameters: [
|
|
2471
2484
|
{
|
|
@@ -2507,7 +2520,7 @@ var openapi_default = {
|
|
|
2507
2520
|
summary: "Trigger a matching run",
|
|
2508
2521
|
description: "Queue a new matching run for this configuration. The run is processed\nasynchronously; poll `GET /v1/matching/runs/{id}` for status.\n",
|
|
2509
2522
|
tags: [
|
|
2510
|
-
"
|
|
2523
|
+
"Intelligence"
|
|
2511
2524
|
],
|
|
2512
2525
|
parameters: [
|
|
2513
2526
|
{
|
|
@@ -2553,7 +2566,7 @@ var openapi_default = {
|
|
|
2553
2566
|
summary: "List matching runs",
|
|
2554
2567
|
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",
|
|
2555
2568
|
tags: [
|
|
2556
|
-
"
|
|
2569
|
+
"Intelligence"
|
|
2557
2570
|
],
|
|
2558
2571
|
parameters: [
|
|
2559
2572
|
{
|
|
@@ -2601,7 +2614,7 @@ var openapi_default = {
|
|
|
2601
2614
|
summary: "Get a matching run",
|
|
2602
2615
|
description: "Returns the run summary together with up to the 50 top-confidence match results.",
|
|
2603
2616
|
tags: [
|
|
2604
|
-
"
|
|
2617
|
+
"Intelligence"
|
|
2605
2618
|
],
|
|
2606
2619
|
parameters: [
|
|
2607
2620
|
{
|
|
@@ -2637,7 +2650,7 @@ var openapi_default = {
|
|
|
2637
2650
|
summary: "Cancel a matching run",
|
|
2638
2651
|
description: "Cancel a queued or running matching run. Runs already in a terminal\nstate (`completed`, `failed`, `cancelled`) return 400.\n",
|
|
2639
2652
|
tags: [
|
|
2640
|
-
"
|
|
2653
|
+
"Intelligence"
|
|
2641
2654
|
],
|
|
2642
2655
|
parameters: [
|
|
2643
2656
|
{
|
|
@@ -2676,7 +2689,7 @@ var openapi_default = {
|
|
|
2676
2689
|
summary: "List routing rules",
|
|
2677
2690
|
description: "Paginated list of document routing rules, ordered by priority ascending (lowest runs first).",
|
|
2678
2691
|
tags: [
|
|
2679
|
-
"
|
|
2692
|
+
"Delivery"
|
|
2680
2693
|
],
|
|
2681
2694
|
parameters: [
|
|
2682
2695
|
{
|
|
@@ -2739,7 +2752,7 @@ var openapi_default = {
|
|
|
2739
2752
|
summary: "Create a routing rule",
|
|
2740
2753
|
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",
|
|
2741
2754
|
tags: [
|
|
2742
|
-
"
|
|
2755
|
+
"Delivery"
|
|
2743
2756
|
],
|
|
2744
2757
|
requestBody: {
|
|
2745
2758
|
required: true,
|
|
@@ -2789,7 +2802,7 @@ var openapi_default = {
|
|
|
2789
2802
|
operationId: "getRoutingRule",
|
|
2790
2803
|
summary: "Get a routing rule",
|
|
2791
2804
|
tags: [
|
|
2792
|
-
"
|
|
2805
|
+
"Delivery"
|
|
2793
2806
|
],
|
|
2794
2807
|
parameters: [
|
|
2795
2808
|
{
|
|
@@ -2823,7 +2836,7 @@ var openapi_default = {
|
|
|
2823
2836
|
summary: "Update a routing rule",
|
|
2824
2837
|
description: "Partial update; only provided keys are patched.",
|
|
2825
2838
|
tags: [
|
|
2826
|
-
"
|
|
2839
|
+
"Delivery"
|
|
2827
2840
|
],
|
|
2828
2841
|
parameters: [
|
|
2829
2842
|
{
|
|
@@ -2869,7 +2882,7 @@ var openapi_default = {
|
|
|
2869
2882
|
operationId: "deleteRoutingRule",
|
|
2870
2883
|
summary: "Delete a routing rule",
|
|
2871
2884
|
tags: [
|
|
2872
|
-
"
|
|
2885
|
+
"Delivery"
|
|
2873
2886
|
],
|
|
2874
2887
|
parameters: [
|
|
2875
2888
|
{
|
|
@@ -4233,7 +4246,7 @@ var openapi_default = {
|
|
|
4233
4246
|
summary: "Filter documents with structured conditions",
|
|
4234
4247
|
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",
|
|
4235
4248
|
tags: [
|
|
4236
|
-
"
|
|
4249
|
+
"Delivery"
|
|
4237
4250
|
],
|
|
4238
4251
|
requestBody: {
|
|
4239
4252
|
required: true,
|
|
@@ -4285,7 +4298,7 @@ var openapi_default = {
|
|
|
4285
4298
|
summary: "Omnisearch across documents, fields, and schemas",
|
|
4286
4299
|
description: "Full-text search that returns multiple result collections in a single\nresponse: matching documents, field matches, sources, schemas, and\nfields.\n",
|
|
4287
4300
|
tags: [
|
|
4288
|
-
"
|
|
4301
|
+
"Delivery"
|
|
4289
4302
|
],
|
|
4290
4303
|
parameters: [
|
|
4291
4304
|
{
|
|
@@ -4334,7 +4347,7 @@ var openapi_default = {
|
|
|
4334
4347
|
summary: "List review queue records",
|
|
4335
4348
|
description: "Paginated list of validation records awaiting or having completed review.",
|
|
4336
4349
|
tags: [
|
|
4337
|
-
"
|
|
4350
|
+
"Platform"
|
|
4338
4351
|
],
|
|
4339
4352
|
parameters: [
|
|
4340
4353
|
{
|
|
@@ -4407,7 +4420,7 @@ var openapi_default = {
|
|
|
4407
4420
|
summary: "Apply a review action to many records",
|
|
4408
4421
|
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",
|
|
4409
4422
|
tags: [
|
|
4410
|
-
"
|
|
4423
|
+
"Platform"
|
|
4411
4424
|
],
|
|
4412
4425
|
requestBody: {
|
|
4413
4426
|
required: true,
|
|
@@ -4448,7 +4461,7 @@ var openapi_default = {
|
|
|
4448
4461
|
summary: "Get a review record",
|
|
4449
4462
|
description: "Returns the full record including per-field decisions and low-confidence field list.",
|
|
4450
4463
|
tags: [
|
|
4451
|
-
"
|
|
4464
|
+
"Platform"
|
|
4452
4465
|
],
|
|
4453
4466
|
parameters: [
|
|
4454
4467
|
{
|
|
@@ -4483,7 +4496,7 @@ var openapi_default = {
|
|
|
4483
4496
|
operationId: "performReviewAction",
|
|
4484
4497
|
summary: "Approve or reject a review record",
|
|
4485
4498
|
tags: [
|
|
4486
|
-
"
|
|
4499
|
+
"Platform"
|
|
4487
4500
|
],
|
|
4488
4501
|
parameters: [
|
|
4489
4502
|
{
|
|
@@ -4531,7 +4544,7 @@ var openapi_default = {
|
|
|
4531
4544
|
operationId: "listGroundTruthDatasets",
|
|
4532
4545
|
summary: "List ground truth datasets",
|
|
4533
4546
|
tags: [
|
|
4534
|
-
"
|
|
4547
|
+
"Platform"
|
|
4535
4548
|
],
|
|
4536
4549
|
parameters: [
|
|
4537
4550
|
{
|
|
@@ -4593,7 +4606,7 @@ var openapi_default = {
|
|
|
4593
4606
|
operationId: "createGroundTruthDataset",
|
|
4594
4607
|
summary: "Create a ground truth dataset",
|
|
4595
4608
|
tags: [
|
|
4596
|
-
"
|
|
4609
|
+
"Platform"
|
|
4597
4610
|
],
|
|
4598
4611
|
requestBody: {
|
|
4599
4612
|
required: true,
|
|
@@ -4644,7 +4657,7 @@ var openapi_default = {
|
|
|
4644
4657
|
summary: "Get a ground truth dataset",
|
|
4645
4658
|
description: "Returns the dataset together with its sample entries (curated known-correct values).",
|
|
4646
4659
|
tags: [
|
|
4647
|
-
"
|
|
4660
|
+
"Platform"
|
|
4648
4661
|
],
|
|
4649
4662
|
parameters: [
|
|
4650
4663
|
{
|
|
@@ -4679,7 +4692,7 @@ var openapi_default = {
|
|
|
4679
4692
|
operationId: "listBenchmarkRuns",
|
|
4680
4693
|
summary: "List benchmark runs",
|
|
4681
4694
|
tags: [
|
|
4682
|
-
"
|
|
4695
|
+
"Platform"
|
|
4683
4696
|
],
|
|
4684
4697
|
parameters: [
|
|
4685
4698
|
{
|
|
@@ -4744,7 +4757,7 @@ var openapi_default = {
|
|
|
4744
4757
|
summary: "Get a benchmark run",
|
|
4745
4758
|
description: "Returns the benchmark run together with its per-document results.",
|
|
4746
4759
|
tags: [
|
|
4747
|
-
"
|
|
4760
|
+
"Platform"
|
|
4748
4761
|
],
|
|
4749
4762
|
parameters: [
|
|
4750
4763
|
{
|
|
@@ -4780,7 +4793,7 @@ var openapi_default = {
|
|
|
4780
4793
|
summary: "List batch inference runs",
|
|
4781
4794
|
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",
|
|
4782
4795
|
tags: [
|
|
4783
|
-
"Batches"
|
|
4796
|
+
"Jobs & Batches"
|
|
4784
4797
|
],
|
|
4785
4798
|
parameters: [
|
|
4786
4799
|
{
|
|
@@ -4850,7 +4863,7 @@ var openapi_default = {
|
|
|
4850
4863
|
summary: "Get a batch inference run",
|
|
4851
4864
|
description: "Returns the batch metadata plus per-item status for every document in the batch.",
|
|
4852
4865
|
tags: [
|
|
4853
|
-
"Batches"
|
|
4866
|
+
"Jobs & Batches"
|
|
4854
4867
|
],
|
|
4855
4868
|
parameters: [
|
|
4856
4869
|
{
|
|
@@ -4886,7 +4899,7 @@ var openapi_default = {
|
|
|
4886
4899
|
summary: "List cases",
|
|
4887
4900
|
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).",
|
|
4888
4901
|
tags: [
|
|
4889
|
-
"
|
|
4902
|
+
"Intelligence"
|
|
4890
4903
|
],
|
|
4891
4904
|
parameters: [
|
|
4892
4905
|
{
|
|
@@ -4941,7 +4954,7 @@ var openapi_default = {
|
|
|
4941
4954
|
summary: "Get a case by key",
|
|
4942
4955
|
description: "Case keys are 8\u201364 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",
|
|
4943
4956
|
tags: [
|
|
4944
|
-
"
|
|
4957
|
+
"Intelligence"
|
|
4945
4958
|
],
|
|
4946
4959
|
parameters: [
|
|
4947
4960
|
{
|
|
@@ -4987,7 +5000,7 @@ var openapi_default = {
|
|
|
4987
5000
|
summary: "List document types",
|
|
4988
5001
|
description: "Document types resolved for the authenticated customer, ordered by document count descending.",
|
|
4989
5002
|
tags: [
|
|
4990
|
-
"
|
|
5003
|
+
"Documents"
|
|
4991
5004
|
],
|
|
4992
5005
|
responses: {
|
|
4993
5006
|
"200": {
|
|
@@ -5023,7 +5036,7 @@ var openapi_default = {
|
|
|
5023
5036
|
summary: "Get the document type ontology",
|
|
5024
5037
|
description: "Returns the canonical category summary (categories, subcategories, and types) used by the classifier.",
|
|
5025
5038
|
tags: [
|
|
5026
|
-
"
|
|
5039
|
+
"Documents"
|
|
5027
5040
|
],
|
|
5028
5041
|
responses: {
|
|
5029
5042
|
"200": {
|
|
@@ -5061,7 +5074,7 @@ var openapi_default = {
|
|
|
5061
5074
|
summary: "List fields",
|
|
5062
5075
|
description: "Paginated list of fields from the field registry, filterable by search, tier, or cluster.",
|
|
5063
5076
|
tags: [
|
|
5064
|
-
"
|
|
5077
|
+
"Schemas"
|
|
5065
5078
|
],
|
|
5066
5079
|
parameters: [
|
|
5067
5080
|
{
|
|
@@ -5141,7 +5154,7 @@ var openapi_default = {
|
|
|
5141
5154
|
summary: "Cross-schema field overlap",
|
|
5142
5155
|
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",
|
|
5143
5156
|
tags: [
|
|
5144
|
-
"
|
|
5157
|
+
"Schemas"
|
|
5145
5158
|
],
|
|
5146
5159
|
responses: {
|
|
5147
5160
|
"200": {
|
|
@@ -5177,7 +5190,7 @@ var openapi_default = {
|
|
|
5177
5190
|
summary: "Get a field",
|
|
5178
5191
|
description: "Returns the field registry row plus up to 20 most recent occurrences.",
|
|
5179
5192
|
tags: [
|
|
5180
|
-
"
|
|
5193
|
+
"Schemas"
|
|
5181
5194
|
],
|
|
5182
5195
|
parameters: [
|
|
5183
5196
|
{
|
|
@@ -5213,7 +5226,7 @@ var openapi_default = {
|
|
|
5213
5226
|
summary: "Get fields similar to this one",
|
|
5214
5227
|
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",
|
|
5215
5228
|
tags: [
|
|
5216
|
-
"
|
|
5229
|
+
"Schemas"
|
|
5217
5230
|
],
|
|
5218
5231
|
parameters: [
|
|
5219
5232
|
{
|
|
@@ -5293,7 +5306,7 @@ var openapi_default = {
|
|
|
5293
5306
|
summary: "List reference datasets",
|
|
5294
5307
|
description: "Uploaded reference datasets (CSV/XLSX) available for matching configurations.",
|
|
5295
5308
|
tags: [
|
|
5296
|
-
"
|
|
5309
|
+
"Intelligence"
|
|
5297
5310
|
],
|
|
5298
5311
|
responses: {
|
|
5299
5312
|
"200": {
|
|
@@ -5328,7 +5341,7 @@ var openapi_default = {
|
|
|
5328
5341
|
operationId: "getReferenceData",
|
|
5329
5342
|
summary: "Get a reference dataset",
|
|
5330
5343
|
tags: [
|
|
5331
|
-
"
|
|
5344
|
+
"Intelligence"
|
|
5332
5345
|
],
|
|
5333
5346
|
parameters: [
|
|
5334
5347
|
{
|
|
@@ -5361,7 +5374,7 @@ var openapi_default = {
|
|
|
5361
5374
|
operationId: "deleteReferenceData",
|
|
5362
5375
|
summary: "Delete a reference dataset",
|
|
5363
5376
|
tags: [
|
|
5364
|
-
"
|
|
5377
|
+
"Intelligence"
|
|
5365
5378
|
],
|
|
5366
5379
|
parameters: [
|
|
5367
5380
|
{
|
|
@@ -5402,7 +5415,7 @@ var openapi_default = {
|
|
|
5402
5415
|
summary: "Get reference dataset rows (paginated)",
|
|
5403
5416
|
description: "Returns the dataset's rows, paginated with page/limit (limit capped at 500).",
|
|
5404
5417
|
tags: [
|
|
5405
|
-
"
|
|
5418
|
+
"Intelligence"
|
|
5406
5419
|
],
|
|
5407
5420
|
parameters: [
|
|
5408
5421
|
{
|
|
@@ -5481,7 +5494,7 @@ var openapi_default = {
|
|
|
5481
5494
|
summary: "Aggregate API usage stats",
|
|
5482
5495
|
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",
|
|
5483
5496
|
tags: [
|
|
5484
|
-
"
|
|
5497
|
+
"Platform"
|
|
5485
5498
|
],
|
|
5486
5499
|
parameters: [
|
|
5487
5500
|
{
|
|
@@ -5529,7 +5542,7 @@ var openapi_default = {
|
|
|
5529
5542
|
summary: "Per-document API usage",
|
|
5530
5543
|
description: "Returns per-document API usage entries and totals. 404 if no usage records exist for the document.",
|
|
5531
5544
|
tags: [
|
|
5532
|
-
"
|
|
5545
|
+
"Platform"
|
|
5533
5546
|
],
|
|
5534
5547
|
parameters: [
|
|
5535
5548
|
{
|
|
@@ -5564,7 +5577,7 @@ var openapi_default = {
|
|
|
5564
5577
|
operationId: "listResolutions",
|
|
5565
5578
|
summary: "List resolution runs",
|
|
5566
5579
|
tags: [
|
|
5567
|
-
"
|
|
5580
|
+
"Intelligence"
|
|
5568
5581
|
],
|
|
5569
5582
|
parameters: [
|
|
5570
5583
|
{
|
|
@@ -5616,7 +5629,7 @@ var openapi_default = {
|
|
|
5616
5629
|
summary: "Create a resolution run",
|
|
5617
5630
|
description: "Start a new resolution run targeting documents from a specific source run.",
|
|
5618
5631
|
tags: [
|
|
5619
|
-
"
|
|
5632
|
+
"Intelligence"
|
|
5620
5633
|
],
|
|
5621
5634
|
requestBody: {
|
|
5622
5635
|
required: true,
|
|
@@ -5667,7 +5680,7 @@ var openapi_default = {
|
|
|
5667
5680
|
operationId: "getResolution",
|
|
5668
5681
|
summary: "Get a resolution run",
|
|
5669
5682
|
tags: [
|
|
5670
|
-
"
|
|
5683
|
+
"Intelligence"
|
|
5671
5684
|
],
|
|
5672
5685
|
parameters: [
|
|
5673
5686
|
{
|
|
@@ -5700,7 +5713,7 @@ var openapi_default = {
|
|
|
5700
5713
|
operationId: "deleteResolution",
|
|
5701
5714
|
summary: "Delete a resolution run",
|
|
5702
5715
|
tags: [
|
|
5703
|
-
"
|
|
5716
|
+
"Intelligence"
|
|
5704
5717
|
],
|
|
5705
5718
|
parameters: [
|
|
5706
5719
|
{
|
|
@@ -5736,7 +5749,7 @@ var openapi_default = {
|
|
|
5736
5749
|
summary: "Get resolution run results",
|
|
5737
5750
|
description: "Returns the resolved data for all documents in the resolution run.",
|
|
5738
5751
|
tags: [
|
|
5739
|
-
"
|
|
5752
|
+
"Intelligence"
|
|
5740
5753
|
],
|
|
5741
5754
|
parameters: [
|
|
5742
5755
|
{
|
|
@@ -5781,7 +5794,7 @@ var openapi_default = {
|
|
|
5781
5794
|
summary: "Execute a resolution run",
|
|
5782
5795
|
description: "Trigger execution of a pending resolution run.",
|
|
5783
5796
|
tags: [
|
|
5784
|
-
"
|
|
5797
|
+
"Intelligence"
|
|
5785
5798
|
],
|
|
5786
5799
|
parameters: [
|
|
5787
5800
|
{
|
|
@@ -5817,7 +5830,7 @@ var openapi_default = {
|
|
|
5817
5830
|
summary: "List link keys",
|
|
5818
5831
|
description: "Returns all configured link keys (field-level entity identifiers used for document linking).",
|
|
5819
5832
|
tags: [
|
|
5820
|
-
"
|
|
5833
|
+
"Intelligence"
|
|
5821
5834
|
],
|
|
5822
5835
|
responses: {
|
|
5823
5836
|
"200": {
|
|
@@ -5853,7 +5866,7 @@ var openapi_default = {
|
|
|
5853
5866
|
summary: "Get links for a document",
|
|
5854
5867
|
description: "Returns all entity links discovered for a specific document.",
|
|
5855
5868
|
tags: [
|
|
5856
|
-
"
|
|
5869
|
+
"Intelligence"
|
|
5857
5870
|
],
|
|
5858
5871
|
parameters: [
|
|
5859
5872
|
{
|
|
@@ -5916,7 +5929,7 @@ var openapi_default = {
|
|
|
5916
5929
|
summary: "Get the full linking graph",
|
|
5917
5930
|
description: "Returns the bipartite document-entity graph for the customer.",
|
|
5918
5931
|
tags: [
|
|
5919
|
-
"
|
|
5932
|
+
"Intelligence"
|
|
5920
5933
|
],
|
|
5921
5934
|
responses: {
|
|
5922
5935
|
"200": {
|
|
@@ -5960,7 +5973,7 @@ var openapi_default = {
|
|
|
5960
5973
|
summary: "Get graph neighbourhood for a document",
|
|
5961
5974
|
description: "Returns the subgraph of entities and linked documents for a specific document.",
|
|
5962
5975
|
tags: [
|
|
5963
|
-
"
|
|
5976
|
+
"Intelligence"
|
|
5964
5977
|
],
|
|
5965
5978
|
parameters: [
|
|
5966
5979
|
{
|
|
@@ -6012,7 +6025,7 @@ var openapi_default = {
|
|
|
6012
6025
|
summary: "Classify link keys",
|
|
6013
6026
|
description: "Run AI classification on ambiguous fields to determine their link key category (identity, transaction, reference).",
|
|
6014
6027
|
tags: [
|
|
6015
|
-
"
|
|
6028
|
+
"Intelligence"
|
|
6016
6029
|
],
|
|
6017
6030
|
responses: {
|
|
6018
6031
|
"200": {
|
|
@@ -6052,7 +6065,7 @@ var openapi_default = {
|
|
|
6052
6065
|
summary: "Backfill linking data",
|
|
6053
6066
|
description: "Trigger a backfill of the linking graph for all documents. Useful after link key configuration changes.",
|
|
6054
6067
|
tags: [
|
|
6055
|
-
"
|
|
6068
|
+
"Intelligence"
|
|
6056
6069
|
],
|
|
6057
6070
|
responses: {
|
|
6058
6071
|
"202": {
|
|
@@ -6090,7 +6103,7 @@ var openapi_default = {
|
|
|
6090
6103
|
summary: "Get backfill progress",
|
|
6091
6104
|
description: "Returns the current progress of an in-flight backfill operation.",
|
|
6092
6105
|
tags: [
|
|
6093
|
-
"
|
|
6106
|
+
"Intelligence"
|
|
6094
6107
|
],
|
|
6095
6108
|
responses: {
|
|
6096
6109
|
"200": {
|
|
@@ -6135,7 +6148,7 @@ var openapi_default = {
|
|
|
6135
6148
|
summary: "Get document-to-case mapping",
|
|
6136
6149
|
description: "Returns a mapping of document IDs to their assigned case keys.",
|
|
6137
6150
|
tags: [
|
|
6138
|
-
"
|
|
6151
|
+
"Intelligence"
|
|
6139
6152
|
],
|
|
6140
6153
|
responses: {
|
|
6141
6154
|
"200": {
|
|
@@ -6172,7 +6185,7 @@ var openapi_default = {
|
|
|
6172
6185
|
summary: "Get N-Shot summary for a run",
|
|
6173
6186
|
description: "Returns an aggregate summary of N-Shot comparisons for a job run.",
|
|
6174
6187
|
tags: [
|
|
6175
|
-
"
|
|
6188
|
+
"Intelligence"
|
|
6176
6189
|
],
|
|
6177
6190
|
parameters: [
|
|
6178
6191
|
{
|
|
@@ -6217,7 +6230,7 @@ var openapi_default = {
|
|
|
6217
6230
|
summary: "List N-Shot comparisons",
|
|
6218
6231
|
description: "Returns all N-Shot comparisons for a job run.",
|
|
6219
6232
|
tags: [
|
|
6220
|
-
"
|
|
6233
|
+
"Intelligence"
|
|
6221
6234
|
],
|
|
6222
6235
|
parameters: [
|
|
6223
6236
|
{
|
|
@@ -6270,7 +6283,7 @@ var openapi_default = {
|
|
|
6270
6283
|
summary: "Get a specific N-Shot comparison",
|
|
6271
6284
|
description: "Returns a single N-Shot comparison filtered by document and field.",
|
|
6272
6285
|
tags: [
|
|
6273
|
-
"
|
|
6286
|
+
"Intelligence"
|
|
6274
6287
|
],
|
|
6275
6288
|
parameters: [
|
|
6276
6289
|
{
|
|
@@ -6335,7 +6348,7 @@ var openapi_default = {
|
|
|
6335
6348
|
summary: "Override an N-Shot value",
|
|
6336
6349
|
description: "Manually override the N-Shot selected value for a document-field pair.",
|
|
6337
6350
|
tags: [
|
|
6338
|
-
"
|
|
6351
|
+
"Intelligence"
|
|
6339
6352
|
],
|
|
6340
6353
|
parameters: [
|
|
6341
6354
|
{
|
|
@@ -6416,7 +6429,7 @@ var openapi_default = {
|
|
|
6416
6429
|
summary: "Submit a judge decision for N-Shot",
|
|
6417
6430
|
description: "Submit an AI or human judge decision on which N-Shot candidate is correct.",
|
|
6418
6431
|
tags: [
|
|
6419
|
-
"
|
|
6432
|
+
"Intelligence"
|
|
6420
6433
|
],
|
|
6421
6434
|
parameters: [
|
|
6422
6435
|
{
|
|
@@ -6498,7 +6511,7 @@ var openapi_default = {
|
|
|
6498
6511
|
summary: "List schema graph classes",
|
|
6499
6512
|
description: "Returns all classes in the schema graph ontology.",
|
|
6500
6513
|
tags: [
|
|
6501
|
-
"
|
|
6514
|
+
"Schemas"
|
|
6502
6515
|
],
|
|
6503
6516
|
responses: {
|
|
6504
6517
|
"200": {
|
|
@@ -6533,7 +6546,7 @@ var openapi_default = {
|
|
|
6533
6546
|
operationId: "getSchemaGraphClass",
|
|
6534
6547
|
summary: "Get a schema graph class",
|
|
6535
6548
|
tags: [
|
|
6536
|
-
"
|
|
6549
|
+
"Schemas"
|
|
6537
6550
|
],
|
|
6538
6551
|
parameters: [
|
|
6539
6552
|
{
|
|
@@ -6569,7 +6582,7 @@ var openapi_default = {
|
|
|
6569
6582
|
summary: "List versions of a schema graph class",
|
|
6570
6583
|
description: "Returns all published versions of a class, ordered by version number descending.",
|
|
6571
6584
|
tags: [
|
|
6572
|
-
"
|
|
6585
|
+
"Schemas"
|
|
6573
6586
|
],
|
|
6574
6587
|
parameters: [
|
|
6575
6588
|
{
|
|
@@ -6629,7 +6642,7 @@ var openapi_default = {
|
|
|
6629
6642
|
operationId: "getSchemaGraphClassVersion",
|
|
6630
6643
|
summary: "Get a specific version of a schema graph class",
|
|
6631
6644
|
tags: [
|
|
6632
|
-
"
|
|
6645
|
+
"Schemas"
|
|
6633
6646
|
],
|
|
6634
6647
|
parameters: [
|
|
6635
6648
|
{
|
|
@@ -6691,7 +6704,7 @@ var openapi_default = {
|
|
|
6691
6704
|
summary: "List schema graph diffs",
|
|
6692
6705
|
description: "Returns pending and processed diffs between class versions.",
|
|
6693
6706
|
tags: [
|
|
6694
|
-
"
|
|
6707
|
+
"Schemas"
|
|
6695
6708
|
],
|
|
6696
6709
|
responses: {
|
|
6697
6710
|
"200": {
|
|
@@ -6727,7 +6740,7 @@ var openapi_default = {
|
|
|
6727
6740
|
summary: "Approve a schema graph diff",
|
|
6728
6741
|
description: "Approve a pending diff, promoting the changes to the live class version.",
|
|
6729
6742
|
tags: [
|
|
6730
|
-
"
|
|
6743
|
+
"Schemas"
|
|
6731
6744
|
],
|
|
6732
6745
|
parameters: [
|
|
6733
6746
|
{
|
|
@@ -6763,7 +6776,7 @@ var openapi_default = {
|
|
|
6763
6776
|
summary: "Reject a schema graph diff",
|
|
6764
6777
|
description: "Reject a pending diff, discarding the proposed changes.",
|
|
6765
6778
|
tags: [
|
|
6766
|
-
"
|
|
6779
|
+
"Schemas"
|
|
6767
6780
|
],
|
|
6768
6781
|
parameters: [
|
|
6769
6782
|
{
|
|
@@ -6799,7 +6812,7 @@ var openapi_default = {
|
|
|
6799
6812
|
summary: "List schema graph edges",
|
|
6800
6813
|
description: "Returns all edges (relationships) between schema graph classes.",
|
|
6801
6814
|
tags: [
|
|
6802
|
-
"
|
|
6815
|
+
"Schemas"
|
|
6803
6816
|
],
|
|
6804
6817
|
responses: {
|
|
6805
6818
|
"200": {
|
|
@@ -6854,7 +6867,7 @@ var openapi_default = {
|
|
|
6854
6867
|
summary: "List schema graph aliases",
|
|
6855
6868
|
description: "Returns all class aliases (alternative names mapping to canonical class IDs).",
|
|
6856
6869
|
tags: [
|
|
6857
|
-
"
|
|
6870
|
+
"Schemas"
|
|
6858
6871
|
],
|
|
6859
6872
|
responses: {
|
|
6860
6873
|
"200": {
|
|
@@ -6903,7 +6916,7 @@ var openapi_default = {
|
|
|
6903
6916
|
summary: "Get schema graph visualization data",
|
|
6904
6917
|
description: "Returns nodes and edges formatted for graph visualization (D3-compatible).",
|
|
6905
6918
|
tags: [
|
|
6906
|
-
"
|
|
6919
|
+
"Schemas"
|
|
6907
6920
|
],
|
|
6908
6921
|
responses: {
|
|
6909
6922
|
"200": {
|
|
@@ -6947,7 +6960,7 @@ var openapi_default = {
|
|
|
6947
6960
|
summary: "List structuring checks",
|
|
6948
6961
|
description: "Returns all configured validation checks for the customer.",
|
|
6949
6962
|
tags: [
|
|
6950
|
-
"
|
|
6963
|
+
"Platform"
|
|
6951
6964
|
],
|
|
6952
6965
|
parameters: [
|
|
6953
6966
|
{
|
|
@@ -6998,7 +7011,7 @@ var openapi_default = {
|
|
|
6998
7011
|
operationId: "createStructuringCheck",
|
|
6999
7012
|
summary: "Create a structuring check",
|
|
7000
7013
|
tags: [
|
|
7001
|
-
"
|
|
7014
|
+
"Platform"
|
|
7002
7015
|
],
|
|
7003
7016
|
requestBody: {
|
|
7004
7017
|
required: true,
|
|
@@ -7038,7 +7051,7 @@ var openapi_default = {
|
|
|
7038
7051
|
operationId: "getStructuringCheck",
|
|
7039
7052
|
summary: "Get a structuring check",
|
|
7040
7053
|
tags: [
|
|
7041
|
-
"
|
|
7054
|
+
"Platform"
|
|
7042
7055
|
],
|
|
7043
7056
|
parameters: [
|
|
7044
7057
|
{
|
|
@@ -7071,7 +7084,7 @@ var openapi_default = {
|
|
|
7071
7084
|
operationId: "updateStructuringCheck",
|
|
7072
7085
|
summary: "Update a structuring check",
|
|
7073
7086
|
tags: [
|
|
7074
|
-
"
|
|
7087
|
+
"Platform"
|
|
7075
7088
|
],
|
|
7076
7089
|
parameters: [
|
|
7077
7090
|
{
|
|
@@ -7117,7 +7130,7 @@ var openapi_default = {
|
|
|
7117
7130
|
operationId: "deleteStructuringCheck",
|
|
7118
7131
|
summary: "Delete a structuring check",
|
|
7119
7132
|
tags: [
|
|
7120
|
-
"
|
|
7133
|
+
"Platform"
|
|
7121
7134
|
],
|
|
7122
7135
|
parameters: [
|
|
7123
7136
|
{
|
|
@@ -7153,7 +7166,7 @@ var openapi_default = {
|
|
|
7153
7166
|
summary: "List approval gates",
|
|
7154
7167
|
description: "Returns all configured approval gates for the customer.",
|
|
7155
7168
|
tags: [
|
|
7156
|
-
"
|
|
7169
|
+
"Platform"
|
|
7157
7170
|
],
|
|
7158
7171
|
parameters: [
|
|
7159
7172
|
{
|
|
@@ -7204,7 +7217,7 @@ var openapi_default = {
|
|
|
7204
7217
|
operationId: "createStructuringGate",
|
|
7205
7218
|
summary: "Create an approval gate",
|
|
7206
7219
|
tags: [
|
|
7207
|
-
"
|
|
7220
|
+
"Platform"
|
|
7208
7221
|
],
|
|
7209
7222
|
requestBody: {
|
|
7210
7223
|
required: true,
|
|
@@ -7244,7 +7257,7 @@ var openapi_default = {
|
|
|
7244
7257
|
operationId: "getStructuringGate",
|
|
7245
7258
|
summary: "Get an approval gate",
|
|
7246
7259
|
tags: [
|
|
7247
|
-
"
|
|
7260
|
+
"Platform"
|
|
7248
7261
|
],
|
|
7249
7262
|
parameters: [
|
|
7250
7263
|
{
|
|
@@ -7277,7 +7290,7 @@ var openapi_default = {
|
|
|
7277
7290
|
operationId: "updateStructuringGate",
|
|
7278
7291
|
summary: "Update an approval gate",
|
|
7279
7292
|
tags: [
|
|
7280
|
-
"
|
|
7293
|
+
"Platform"
|
|
7281
7294
|
],
|
|
7282
7295
|
parameters: [
|
|
7283
7296
|
{
|
|
@@ -7323,7 +7336,7 @@ var openapi_default = {
|
|
|
7323
7336
|
operationId: "deleteStructuringGate",
|
|
7324
7337
|
summary: "Delete an approval gate",
|
|
7325
7338
|
tags: [
|
|
7326
|
-
"
|
|
7339
|
+
"Platform"
|
|
7327
7340
|
],
|
|
7328
7341
|
parameters: [
|
|
7329
7342
|
{
|
|
@@ -7358,7 +7371,7 @@ var openapi_default = {
|
|
|
7358
7371
|
operationId: "addStructuringGateRule",
|
|
7359
7372
|
summary: "Add a rule to an approval gate",
|
|
7360
7373
|
tags: [
|
|
7361
|
-
"
|
|
7374
|
+
"Platform"
|
|
7362
7375
|
],
|
|
7363
7376
|
parameters: [
|
|
7364
7377
|
{
|
|
@@ -7419,7 +7432,7 @@ var openapi_default = {
|
|
|
7419
7432
|
operationId: "deleteStructuringGateRule",
|
|
7420
7433
|
summary: "Remove a rule from an approval gate",
|
|
7421
7434
|
tags: [
|
|
7422
|
-
"
|
|
7435
|
+
"Platform"
|
|
7423
7436
|
],
|
|
7424
7437
|
parameters: [
|
|
7425
7438
|
{
|
|
@@ -7475,7 +7488,7 @@ var openapi_default = {
|
|
|
7475
7488
|
summary: "Get check results for a structuring result",
|
|
7476
7489
|
description: "Returns the validation check outcomes for a specific structuring result.",
|
|
7477
7490
|
tags: [
|
|
7478
|
-
"
|
|
7491
|
+
"Platform"
|
|
7479
7492
|
],
|
|
7480
7493
|
parameters: [
|
|
7481
7494
|
{
|
|
@@ -7538,7 +7551,7 @@ var openapi_default = {
|
|
|
7538
7551
|
summary: "List pending approvals",
|
|
7539
7552
|
description: "Returns structuring results awaiting manual approval.",
|
|
7540
7553
|
tags: [
|
|
7541
|
-
"
|
|
7554
|
+
"Platform"
|
|
7542
7555
|
],
|
|
7543
7556
|
parameters: [
|
|
7544
7557
|
{
|
|
@@ -7589,7 +7602,7 @@ var openapi_default = {
|
|
|
7589
7602
|
operationId: "approveStructuringResult",
|
|
7590
7603
|
summary: "Approve a structuring result",
|
|
7591
7604
|
tags: [
|
|
7592
|
-
"
|
|
7605
|
+
"Platform"
|
|
7593
7606
|
],
|
|
7594
7607
|
parameters: [
|
|
7595
7608
|
{
|
|
@@ -7635,7 +7648,7 @@ var openapi_default = {
|
|
|
7635
7648
|
operationId: "rejectStructuringResult",
|
|
7636
7649
|
summary: "Reject a structuring result",
|
|
7637
7650
|
tags: [
|
|
7638
|
-
"
|
|
7651
|
+
"Platform"
|
|
7639
7652
|
],
|
|
7640
7653
|
parameters: [
|
|
7641
7654
|
{
|
|
@@ -7682,7 +7695,7 @@ var openapi_default = {
|
|
|
7682
7695
|
summary: "Trigger delivery for a structuring run",
|
|
7683
7696
|
description: "Emit delivery signals for all approved results in the run.",
|
|
7684
7697
|
tags: [
|
|
7685
|
-
"
|
|
7698
|
+
"Platform"
|
|
7686
7699
|
],
|
|
7687
7700
|
parameters: [
|
|
7688
7701
|
{
|
|
@@ -7734,7 +7747,7 @@ var openapi_default = {
|
|
|
7734
7747
|
summary: "Get telemetry summary for a schema",
|
|
7735
7748
|
description: "Aggregate structuring metrics for a schema \u2014 capture hit rate, synthesize rate, strategy distribution, tier funnel.",
|
|
7736
7749
|
tags: [
|
|
7737
|
-
"
|
|
7750
|
+
"Platform"
|
|
7738
7751
|
],
|
|
7739
7752
|
parameters: [
|
|
7740
7753
|
{
|
|
@@ -7771,7 +7784,7 @@ var openapi_default = {
|
|
|
7771
7784
|
summary: "Get telemetry trend for a schema",
|
|
7772
7785
|
description: "Time-series telemetry data for a schema over recent runs.",
|
|
7773
7786
|
tags: [
|
|
7774
|
-
"
|
|
7787
|
+
"Platform"
|
|
7775
7788
|
],
|
|
7776
7789
|
parameters: [
|
|
7777
7790
|
{
|
|
@@ -7816,7 +7829,7 @@ var openapi_default = {
|
|
|
7816
7829
|
summary: "Get per-field telemetry for a schema",
|
|
7817
7830
|
description: "Field-level structuring metrics \u2014 per-field state distribution, capture rates, and strategy breakdown.",
|
|
7818
7831
|
tags: [
|
|
7819
|
-
"
|
|
7832
|
+
"Platform"
|
|
7820
7833
|
],
|
|
7821
7834
|
parameters: [
|
|
7822
7835
|
{
|
|
@@ -7861,7 +7874,7 @@ var openapi_default = {
|
|
|
7861
7874
|
summary: "Get telemetry summary for a run",
|
|
7862
7875
|
description: "Aggregate structuring metrics for a specific job run.",
|
|
7863
7876
|
tags: [
|
|
7864
|
-
"
|
|
7877
|
+
"Platform"
|
|
7865
7878
|
],
|
|
7866
7879
|
parameters: [
|
|
7867
7880
|
{
|
|
@@ -7898,7 +7911,7 @@ var openapi_default = {
|
|
|
7898
7911
|
summary: "List golden samples",
|
|
7899
7912
|
description: "Returns all golden sample datasets for the customer.",
|
|
7900
7913
|
tags: [
|
|
7901
|
-
"
|
|
7914
|
+
"Platform"
|
|
7902
7915
|
],
|
|
7903
7916
|
parameters: [
|
|
7904
7917
|
{
|
|
@@ -7951,7 +7964,7 @@ var openapi_default = {
|
|
|
7951
7964
|
operationId: "getGoldenSample",
|
|
7952
7965
|
summary: "Get a golden sample",
|
|
7953
7966
|
tags: [
|
|
7954
|
-
"
|
|
7967
|
+
"Platform"
|
|
7955
7968
|
],
|
|
7956
7969
|
parameters: [
|
|
7957
7970
|
{
|
|
@@ -7984,7 +7997,7 @@ var openapi_default = {
|
|
|
7984
7997
|
operationId: "deleteGoldenSample",
|
|
7985
7998
|
summary: "Delete a golden sample",
|
|
7986
7999
|
tags: [
|
|
7987
|
-
"
|
|
8000
|
+
"Platform"
|
|
7988
8001
|
],
|
|
7989
8002
|
parameters: [
|
|
7990
8003
|
{
|
|
@@ -8019,7 +8032,7 @@ var openapi_default = {
|
|
|
8019
8032
|
operationId: "listValidationRuns",
|
|
8020
8033
|
summary: "List validation runs",
|
|
8021
8034
|
tags: [
|
|
8022
|
-
"
|
|
8035
|
+
"Platform"
|
|
8023
8036
|
],
|
|
8024
8037
|
parameters: [
|
|
8025
8038
|
{
|
|
@@ -8071,7 +8084,7 @@ var openapi_default = {
|
|
|
8071
8084
|
summary: "Create a validation run",
|
|
8072
8085
|
description: "Start a new validation run against a golden sample dataset.",
|
|
8073
8086
|
tags: [
|
|
8074
|
-
"
|
|
8087
|
+
"Platform"
|
|
8075
8088
|
],
|
|
8076
8089
|
requestBody: {
|
|
8077
8090
|
required: true,
|
|
@@ -8128,7 +8141,7 @@ var openapi_default = {
|
|
|
8128
8141
|
operationId: "getValidationRun",
|
|
8129
8142
|
summary: "Get a validation run",
|
|
8130
8143
|
tags: [
|
|
8131
|
-
"
|
|
8144
|
+
"Platform"
|
|
8132
8145
|
],
|
|
8133
8146
|
parameters: [
|
|
8134
8147
|
{
|
|
@@ -8161,7 +8174,7 @@ var openapi_default = {
|
|
|
8161
8174
|
operationId: "deleteValidationRun",
|
|
8162
8175
|
summary: "Delete a validation run",
|
|
8163
8176
|
tags: [
|
|
8164
|
-
"
|
|
8177
|
+
"Platform"
|
|
8165
8178
|
],
|
|
8166
8179
|
parameters: [
|
|
8167
8180
|
{
|
|
@@ -8197,7 +8210,7 @@ var openapi_default = {
|
|
|
8197
8210
|
summary: "Get validation run results",
|
|
8198
8211
|
description: "Returns per-document and per-field accuracy results for the validation run.",
|
|
8199
8212
|
tags: [
|
|
8200
|
-
"
|
|
8213
|
+
"Platform"
|
|
8201
8214
|
],
|
|
8202
8215
|
parameters: [
|
|
8203
8216
|
{
|
|
@@ -8253,7 +8266,7 @@ var openapi_default = {
|
|
|
8253
8266
|
summary: "Get credit balance",
|
|
8254
8267
|
description: "Returns the current credit balance for the authenticated customer.",
|
|
8255
8268
|
tags: [
|
|
8256
|
-
"
|
|
8269
|
+
"Platform"
|
|
8257
8270
|
],
|
|
8258
8271
|
responses: {
|
|
8259
8272
|
"200": {
|
|
@@ -8300,7 +8313,7 @@ var openapi_default = {
|
|
|
8300
8313
|
summary: "Get credit history",
|
|
8301
8314
|
description: "Returns credit transaction history (purchases, deductions, adjustments).",
|
|
8302
8315
|
tags: [
|
|
8303
|
-
"
|
|
8316
|
+
"Platform"
|
|
8304
8317
|
],
|
|
8305
8318
|
parameters: [
|
|
8306
8319
|
{
|
|
@@ -8380,7 +8393,7 @@ var openapi_default = {
|
|
|
8380
8393
|
summary: "Get credit usage summary",
|
|
8381
8394
|
description: "Returns aggregate credit usage broken down by feature.",
|
|
8382
8395
|
tags: [
|
|
8383
|
-
"
|
|
8396
|
+
"Platform"
|
|
8384
8397
|
],
|
|
8385
8398
|
parameters: [
|
|
8386
8399
|
{
|
|
@@ -8452,7 +8465,7 @@ var openapi_default = {
|
|
|
8452
8465
|
summary: "Get daily credit usage",
|
|
8453
8466
|
description: "Returns per-day credit usage for the specified period (default last 30 days).",
|
|
8454
8467
|
tags: [
|
|
8455
|
-
"
|
|
8468
|
+
"Platform"
|
|
8456
8469
|
],
|
|
8457
8470
|
parameters: [
|
|
8458
8471
|
{
|
|
@@ -8521,7 +8534,7 @@ var openapi_default = {
|
|
|
8521
8534
|
summary: "Get credit usage log",
|
|
8522
8535
|
description: "Returns a detailed per-request usage log with model, tokens, and cost.",
|
|
8523
8536
|
tags: [
|
|
8524
|
-
"
|
|
8537
|
+
"Platform"
|
|
8525
8538
|
],
|
|
8526
8539
|
parameters: [
|
|
8527
8540
|
{
|
|
@@ -8600,7 +8613,7 @@ var openapi_default = {
|
|
|
8600
8613
|
operationId: "updateCaseStatus",
|
|
8601
8614
|
summary: "Update case status",
|
|
8602
8615
|
tags: [
|
|
8603
|
-
"
|
|
8616
|
+
"Intelligence"
|
|
8604
8617
|
],
|
|
8605
8618
|
parameters: [
|
|
8606
8619
|
{
|
|
@@ -8665,7 +8678,7 @@ var openapi_default = {
|
|
|
8665
8678
|
summary: "Get case edges",
|
|
8666
8679
|
description: "Returns the entity edges (evidence chain) connecting documents within the case.",
|
|
8667
8680
|
tags: [
|
|
8668
|
-
"
|
|
8681
|
+
"Intelligence"
|
|
8669
8682
|
],
|
|
8670
8683
|
parameters: [
|
|
8671
8684
|
{
|
|
@@ -8737,7 +8750,7 @@ var openapi_default = {
|
|
|
8737
8750
|
summary: "Confirm a case edge",
|
|
8738
8751
|
description: "Confirm a proposed entity edge between documents.",
|
|
8739
8752
|
tags: [
|
|
8740
|
-
"
|
|
8753
|
+
"Intelligence"
|
|
8741
8754
|
],
|
|
8742
8755
|
requestBody: {
|
|
8743
8756
|
required: true,
|
|
@@ -8803,7 +8816,7 @@ var openapi_default = {
|
|
|
8803
8816
|
summary: "Reject a case edge",
|
|
8804
8817
|
description: "Reject a proposed entity edge between documents.",
|
|
8805
8818
|
tags: [
|
|
8806
|
-
"
|
|
8819
|
+
"Intelligence"
|
|
8807
8820
|
],
|
|
8808
8821
|
requestBody: {
|
|
8809
8822
|
required: true,
|
|
@@ -8869,7 +8882,7 @@ var openapi_default = {
|
|
|
8869
8882
|
summary: "Split a case",
|
|
8870
8883
|
description: "Split a case into two separate cases by dividing documents.",
|
|
8871
8884
|
tags: [
|
|
8872
|
-
"
|
|
8885
|
+
"Intelligence"
|
|
8873
8886
|
],
|
|
8874
8887
|
parameters: [
|
|
8875
8888
|
{
|
|
@@ -8946,7 +8959,7 @@ var openapi_default = {
|
|
|
8946
8959
|
summary: "Merge cases",
|
|
8947
8960
|
description: "Merge another case into this one, combining all documents.",
|
|
8948
8961
|
tags: [
|
|
8949
|
-
"
|
|
8962
|
+
"Intelligence"
|
|
8950
8963
|
],
|
|
8951
8964
|
parameters: [
|
|
8952
8965
|
{
|
|
@@ -9010,7 +9023,7 @@ var openapi_default = {
|
|
|
9010
9023
|
summary: "Get case completeness",
|
|
9011
9024
|
description: "Returns a completeness assessment for the case (expected vs. present document types, missing fields).",
|
|
9012
9025
|
tags: [
|
|
9013
|
-
"
|
|
9026
|
+
"Intelligence"
|
|
9014
9027
|
],
|
|
9015
9028
|
parameters: [
|
|
9016
9029
|
{
|
|
@@ -9076,7 +9089,7 @@ var openapi_default = {
|
|
|
9076
9089
|
summary: "Pin documents to a case",
|
|
9077
9090
|
description: "Manually pin one or more documents to a case.",
|
|
9078
9091
|
tags: [
|
|
9079
|
-
"
|
|
9092
|
+
"Intelligence"
|
|
9080
9093
|
],
|
|
9081
9094
|
parameters: [
|
|
9082
9095
|
{
|
|
@@ -9144,7 +9157,7 @@ var openapi_default = {
|
|
|
9144
9157
|
summary: "Remove documents from a case",
|
|
9145
9158
|
description: "Remove one or more manually-pinned documents from a case.",
|
|
9146
9159
|
tags: [
|
|
9147
|
-
"
|
|
9160
|
+
"Intelligence"
|
|
9148
9161
|
],
|
|
9149
9162
|
parameters: [
|
|
9150
9163
|
{
|
|
@@ -9212,7 +9225,7 @@ var openapi_default = {
|
|
|
9212
9225
|
summary: "Sync batch status with provider",
|
|
9213
9226
|
description: "Force a status sync with the batch inference provider (Anthropic or Bedrock).",
|
|
9214
9227
|
tags: [
|
|
9215
|
-
"Batches"
|
|
9228
|
+
"Jobs & Batches"
|
|
9216
9229
|
],
|
|
9217
9230
|
parameters: [
|
|
9218
9231
|
{
|
|
@@ -9248,7 +9261,7 @@ var openapi_default = {
|
|
|
9248
9261
|
summary: "Cancel a batch inference run",
|
|
9249
9262
|
description: "Cancel an in-flight batch. Only batches in `accumulating` or `submitted` status can be cancelled.",
|
|
9250
9263
|
tags: [
|
|
9251
|
-
"Batches"
|
|
9264
|
+
"Jobs & Batches"
|
|
9252
9265
|
],
|
|
9253
9266
|
parameters: [
|
|
9254
9267
|
{
|
|
@@ -9287,7 +9300,7 @@ var openapi_default = {
|
|
|
9287
9300
|
summary: "Trigger a smart matching run",
|
|
9288
9301
|
description: "AI-driven matching run that auto-suggests field mappings and strategies based on schema and reference data.",
|
|
9289
9302
|
tags: [
|
|
9290
|
-
"
|
|
9303
|
+
"Intelligence"
|
|
9291
9304
|
],
|
|
9292
9305
|
requestBody: {
|
|
9293
9306
|
required: true,
|
|
@@ -9342,7 +9355,7 @@ var openapi_default = {
|
|
|
9342
9355
|
summary: "AI-resolve ambiguous matches",
|
|
9343
9356
|
description: "Use AI to resolve ambiguous match candidates where confidence is below the auto-accept threshold.",
|
|
9344
9357
|
tags: [
|
|
9345
|
-
"
|
|
9358
|
+
"Intelligence"
|
|
9346
9359
|
],
|
|
9347
9360
|
requestBody: {
|
|
9348
9361
|
required: true,
|
|
@@ -9405,7 +9418,7 @@ var openapi_default = {
|
|
|
9405
9418
|
summary: "List matching strategies",
|
|
9406
9419
|
description: "Returns available matching strategies and their configurations.",
|
|
9407
9420
|
tags: [
|
|
9408
|
-
"
|
|
9421
|
+
"Intelligence"
|
|
9409
9422
|
],
|
|
9410
9423
|
responses: {
|
|
9411
9424
|
"200": {
|
|
@@ -9455,7 +9468,7 @@ var openapi_default = {
|
|
|
9455
9468
|
operationId: "createMatchingStrategy",
|
|
9456
9469
|
summary: "Create a matching strategy",
|
|
9457
9470
|
tags: [
|
|
9458
|
-
"
|
|
9471
|
+
"Intelligence"
|
|
9459
9472
|
],
|
|
9460
9473
|
requestBody: {
|
|
9461
9474
|
required: true,
|
|
@@ -9514,7 +9527,7 @@ var openapi_default = {
|
|
|
9514
9527
|
operationId: "getMatchingStrategy",
|
|
9515
9528
|
summary: "Get a matching strategy",
|
|
9516
9529
|
tags: [
|
|
9517
|
-
"
|
|
9530
|
+
"Intelligence"
|
|
9518
9531
|
],
|
|
9519
9532
|
parameters: [
|
|
9520
9533
|
{
|
|
@@ -9548,7 +9561,7 @@ var openapi_default = {
|
|
|
9548
9561
|
operationId: "updateMatchingStrategy",
|
|
9549
9562
|
summary: "Update a matching strategy",
|
|
9550
9563
|
tags: [
|
|
9551
|
-
"
|
|
9564
|
+
"Intelligence"
|
|
9552
9565
|
],
|
|
9553
9566
|
parameters: [
|
|
9554
9567
|
{
|
|
@@ -9604,7 +9617,7 @@ var openapi_default = {
|
|
|
9604
9617
|
operationId: "deleteMatchingStrategy",
|
|
9605
9618
|
summary: "Delete a matching strategy",
|
|
9606
9619
|
tags: [
|
|
9607
|
-
"
|
|
9620
|
+
"Intelligence"
|
|
9608
9621
|
],
|
|
9609
9622
|
parameters: [
|
|
9610
9623
|
{
|
|
@@ -9640,7 +9653,7 @@ var openapi_default = {
|
|
|
9640
9653
|
summary: "Get matching run results",
|
|
9641
9654
|
description: "Returns per-document match results with top candidates and field-level evidence.",
|
|
9642
9655
|
tags: [
|
|
9643
|
-
"
|
|
9656
|
+
"Intelligence"
|
|
9644
9657
|
],
|
|
9645
9658
|
parameters: [
|
|
9646
9659
|
{
|
|
@@ -9685,7 +9698,7 @@ var openapi_default = {
|
|
|
9685
9698
|
summary: "Get matching run progress",
|
|
9686
9699
|
description: "Returns the processing progress for an in-flight matching run.",
|
|
9687
9700
|
tags: [
|
|
9688
|
-
"
|
|
9701
|
+
"Intelligence"
|
|
9689
9702
|
],
|
|
9690
9703
|
parameters: [
|
|
9691
9704
|
{
|
|
@@ -9737,7 +9750,7 @@ var openapi_default = {
|
|
|
9737
9750
|
summary: "Submit matching review decisions",
|
|
9738
9751
|
description: "Submit accept/reject decisions on match candidates.",
|
|
9739
9752
|
tags: [
|
|
9740
|
-
"
|
|
9753
|
+
"Intelligence"
|
|
9741
9754
|
],
|
|
9742
9755
|
requestBody: {
|
|
9743
9756
|
required: true,
|
|
@@ -9819,7 +9832,7 @@ var openapi_default = {
|
|
|
9819
9832
|
summary: "Assign review records",
|
|
9820
9833
|
description: "Assign one or more review records to a team member.",
|
|
9821
9834
|
tags: [
|
|
9822
|
-
"
|
|
9835
|
+
"Platform"
|
|
9823
9836
|
],
|
|
9824
9837
|
requestBody: {
|
|
9825
9838
|
required: true,
|
|
@@ -9885,7 +9898,7 @@ var openapi_default = {
|
|
|
9885
9898
|
summary: "Get review queue statistics",
|
|
9886
9899
|
description: "Returns aggregate statistics about the review queue (pending, approved, rejected counts).",
|
|
9887
9900
|
tags: [
|
|
9888
|
-
"
|
|
9901
|
+
"Platform"
|
|
9889
9902
|
],
|
|
9890
9903
|
responses: {
|
|
9891
9904
|
"200": {
|
|
@@ -9926,7 +9939,7 @@ var openapi_default = {
|
|
|
9926
9939
|
operationId: "listGroundTruthEntries",
|
|
9927
9940
|
summary: "List entries in a ground truth dataset",
|
|
9928
9941
|
tags: [
|
|
9929
|
-
"
|
|
9942
|
+
"Platform"
|
|
9930
9943
|
],
|
|
9931
9944
|
parameters: [
|
|
9932
9945
|
{
|
|
@@ -9980,7 +9993,7 @@ var openapi_default = {
|
|
|
9980
9993
|
operationId: "createGroundTruthEntry",
|
|
9981
9994
|
summary: "Add an entry to a ground truth dataset",
|
|
9982
9995
|
tags: [
|
|
9983
|
-
"
|
|
9996
|
+
"Platform"
|
|
9984
9997
|
],
|
|
9985
9998
|
parameters: [
|
|
9986
9999
|
{
|
|
@@ -10046,7 +10059,7 @@ var openapi_default = {
|
|
|
10046
10059
|
operationId: "updateGroundTruthEntry",
|
|
10047
10060
|
summary: "Update a ground truth entry",
|
|
10048
10061
|
tags: [
|
|
10049
|
-
"
|
|
10062
|
+
"Platform"
|
|
10050
10063
|
],
|
|
10051
10064
|
parameters: [
|
|
10052
10065
|
{
|
|
@@ -10110,7 +10123,7 @@ var openapi_default = {
|
|
|
10110
10123
|
operationId: "deleteGroundTruthEntry",
|
|
10111
10124
|
summary: "Delete a ground truth entry",
|
|
10112
10125
|
tags: [
|
|
10113
|
-
"
|
|
10126
|
+
"Platform"
|
|
10114
10127
|
],
|
|
10115
10128
|
parameters: [
|
|
10116
10129
|
{
|
|
@@ -10157,7 +10170,7 @@ var openapi_default = {
|
|
|
10157
10170
|
summary: "Get benchmark results",
|
|
10158
10171
|
description: "Returns per-document accuracy results for a benchmark run.",
|
|
10159
10172
|
tags: [
|
|
10160
|
-
"
|
|
10173
|
+
"Platform"
|
|
10161
10174
|
],
|
|
10162
10175
|
parameters: [
|
|
10163
10176
|
{
|
|
@@ -10201,7 +10214,7 @@ var openapi_default = {
|
|
|
10201
10214
|
summary: "Compare two benchmark runs",
|
|
10202
10215
|
description: "Returns accuracy deltas between the target benchmark and a comparison run.",
|
|
10203
10216
|
tags: [
|
|
10204
|
-
"
|
|
10217
|
+
"Platform"
|
|
10205
10218
|
],
|
|
10206
10219
|
parameters: [
|
|
10207
10220
|
{
|
|
@@ -10273,7 +10286,7 @@ var openapi_default = {
|
|
|
10273
10286
|
summary: "Create reference data from JSON",
|
|
10274
10287
|
description: "Create a new reference dataset by uploading JSON data directly (alternative to CSV/XLSX file upload).",
|
|
10275
10288
|
tags: [
|
|
10276
|
-
"
|
|
10289
|
+
"Intelligence"
|
|
10277
10290
|
],
|
|
10278
10291
|
requestBody: {
|
|
10279
10292
|
required: true,
|
|
@@ -10339,7 +10352,7 @@ var openapi_default = {
|
|
|
10339
10352
|
summary: "Get workspace context",
|
|
10340
10353
|
description: "Returns a snapshot of the workspace's current state for the embedded\nAI agent \u2014 document counts, active schemas, recent jobs, and feature\nflags. Useful for bootstrapping agent conversations.\n",
|
|
10341
10354
|
tags: [
|
|
10342
|
-
"
|
|
10355
|
+
"Platform"
|
|
10343
10356
|
],
|
|
10344
10357
|
responses: {
|
|
10345
10358
|
"200": {
|
|
@@ -10394,7 +10407,7 @@ var openapi_default = {
|
|
|
10394
10407
|
summary: "List available agent tools",
|
|
10395
10408
|
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",
|
|
10396
10409
|
tags: [
|
|
10397
|
-
"
|
|
10410
|
+
"Platform"
|
|
10398
10411
|
],
|
|
10399
10412
|
responses: {
|
|
10400
10413
|
"200": {
|
|
@@ -10543,8 +10556,13 @@ var openapi_default = {
|
|
|
10543
10556
|
$ref: "#/components/schemas/ErrorResponse"
|
|
10544
10557
|
},
|
|
10545
10558
|
example: {
|
|
10546
|
-
|
|
10547
|
-
|
|
10559
|
+
statusCode: 400,
|
|
10560
|
+
code: "VALIDATION_ERROR",
|
|
10561
|
+
error: "Bad Request",
|
|
10562
|
+
message: "name is required.",
|
|
10563
|
+
retryable: false,
|
|
10564
|
+
timestamp: "2026-04-25T14:30:00.000Z",
|
|
10565
|
+
path: "/v1/schemas"
|
|
10548
10566
|
}
|
|
10549
10567
|
}
|
|
10550
10568
|
}
|
|
@@ -10557,8 +10575,13 @@ var openapi_default = {
|
|
|
10557
10575
|
$ref: "#/components/schemas/ErrorResponse"
|
|
10558
10576
|
},
|
|
10559
10577
|
example: {
|
|
10560
|
-
|
|
10561
|
-
|
|
10578
|
+
statusCode: 401,
|
|
10579
|
+
code: "AUTH_REQUIRED",
|
|
10580
|
+
error: "Unauthorized",
|
|
10581
|
+
message: "Invalid or missing API key.",
|
|
10582
|
+
retryable: false,
|
|
10583
|
+
timestamp: "2026-04-25T14:30:00.000Z",
|
|
10584
|
+
path: "/v1/extract"
|
|
10562
10585
|
}
|
|
10563
10586
|
}
|
|
10564
10587
|
}
|
|
@@ -10571,8 +10594,13 @@ var openapi_default = {
|
|
|
10571
10594
|
$ref: "#/components/schemas/ErrorResponse"
|
|
10572
10595
|
},
|
|
10573
10596
|
example: {
|
|
10574
|
-
|
|
10575
|
-
|
|
10597
|
+
statusCode: 403,
|
|
10598
|
+
code: "INSUFFICIENT_PERMISSIONS",
|
|
10599
|
+
error: "Forbidden",
|
|
10600
|
+
message: "This key does not have the 'write' scope.",
|
|
10601
|
+
retryable: false,
|
|
10602
|
+
timestamp: "2026-04-25T14:30:00.000Z",
|
|
10603
|
+
path: "/v1/schemas"
|
|
10576
10604
|
}
|
|
10577
10605
|
}
|
|
10578
10606
|
}
|
|
@@ -10585,8 +10613,13 @@ var openapi_default = {
|
|
|
10585
10613
|
$ref: "#/components/schemas/ErrorResponse"
|
|
10586
10614
|
},
|
|
10587
10615
|
example: {
|
|
10588
|
-
|
|
10589
|
-
|
|
10616
|
+
statusCode: 404,
|
|
10617
|
+
code: "RESOURCE_NOT_FOUND",
|
|
10618
|
+
error: "Not Found",
|
|
10619
|
+
message: "Document 'f0e1d2c3-b4a5-9687-8765-432109876543' not found.",
|
|
10620
|
+
retryable: false,
|
|
10621
|
+
timestamp: "2026-04-25T14:30:00.000Z",
|
|
10622
|
+
path: "/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543"
|
|
10590
10623
|
}
|
|
10591
10624
|
}
|
|
10592
10625
|
}
|
|
@@ -10599,8 +10632,13 @@ var openapi_default = {
|
|
|
10599
10632
|
$ref: "#/components/schemas/ErrorResponse"
|
|
10600
10633
|
},
|
|
10601
10634
|
example: {
|
|
10602
|
-
|
|
10603
|
-
|
|
10635
|
+
statusCode: 409,
|
|
10636
|
+
code: "VALIDATION_ERROR",
|
|
10637
|
+
error: "Conflict",
|
|
10638
|
+
message: "Job is already completed. Cannot cancel.",
|
|
10639
|
+
retryable: false,
|
|
10640
|
+
timestamp: "2026-04-25T14:30:00.000Z",
|
|
10641
|
+
path: "/v1/jobs/c3d4e5f6-a7b8-9012-cdef-123456789012/cancel"
|
|
10604
10642
|
}
|
|
10605
10643
|
}
|
|
10606
10644
|
}
|
|
@@ -10613,8 +10651,13 @@ var openapi_default = {
|
|
|
10613
10651
|
$ref: "#/components/schemas/ErrorResponse"
|
|
10614
10652
|
},
|
|
10615
10653
|
example: {
|
|
10616
|
-
|
|
10617
|
-
|
|
10654
|
+
statusCode: 413,
|
|
10655
|
+
code: "FILE_TOO_LARGE",
|
|
10656
|
+
error: "Payload Too Large",
|
|
10657
|
+
message: "File exceeds the 500 MB limit.",
|
|
10658
|
+
retryable: false,
|
|
10659
|
+
timestamp: "2026-04-25T14:30:00.000Z",
|
|
10660
|
+
path: "/v1/extract"
|
|
10618
10661
|
}
|
|
10619
10662
|
}
|
|
10620
10663
|
}
|
|
@@ -10627,9 +10670,13 @@ var openapi_default = {
|
|
|
10627
10670
|
$ref: "#/components/schemas/ErrorResponse"
|
|
10628
10671
|
},
|
|
10629
10672
|
example: {
|
|
10630
|
-
|
|
10673
|
+
statusCode: 422,
|
|
10674
|
+
code: "EXTRACTION_FAILED",
|
|
10675
|
+
error: "Unprocessable Entity",
|
|
10631
10676
|
message: "Unable to extract fields from the provided document.",
|
|
10632
|
-
|
|
10677
|
+
retryable: false,
|
|
10678
|
+
timestamp: "2026-04-25T14:30:00.000Z",
|
|
10679
|
+
path: "/v1/extract",
|
|
10633
10680
|
links: {
|
|
10634
10681
|
dashboard: "https://app.talonic.com/documents/abc-123"
|
|
10635
10682
|
}
|
|
@@ -10656,11 +10703,13 @@ var openapi_default = {
|
|
|
10656
10703
|
$ref: "#/components/schemas/ErrorResponse"
|
|
10657
10704
|
},
|
|
10658
10705
|
example: {
|
|
10659
|
-
|
|
10706
|
+
statusCode: 429,
|
|
10707
|
+
code: "QUOTA_EXCEEDED",
|
|
10708
|
+
error: "Too Many Requests",
|
|
10660
10709
|
message: "Daily extract request limit (50) reached. Resets at midnight UTC.",
|
|
10661
|
-
|
|
10662
|
-
|
|
10663
|
-
|
|
10710
|
+
retryable: true,
|
|
10711
|
+
timestamp: "2026-04-25T23:45:00.000Z",
|
|
10712
|
+
path: "/v1/extract"
|
|
10664
10713
|
}
|
|
10665
10714
|
}
|
|
10666
10715
|
}
|
|
@@ -10673,9 +10722,13 @@ var openapi_default = {
|
|
|
10673
10722
|
$ref: "#/components/schemas/ErrorResponse"
|
|
10674
10723
|
},
|
|
10675
10724
|
example: {
|
|
10676
|
-
|
|
10725
|
+
statusCode: 500,
|
|
10726
|
+
code: "INTERNAL_ERROR",
|
|
10727
|
+
error: "Internal Server Error",
|
|
10677
10728
|
message: "An unexpected error occurred. Please try again or contact support.",
|
|
10678
|
-
|
|
10729
|
+
retryable: true,
|
|
10730
|
+
timestamp: "2026-04-25T14:30:00.000Z",
|
|
10731
|
+
path: "/v1/extract"
|
|
10679
10732
|
}
|
|
10680
10733
|
}
|
|
10681
10734
|
}
|
|
@@ -10685,29 +10738,143 @@ var openapi_default = {
|
|
|
10685
10738
|
ErrorResponse: {
|
|
10686
10739
|
type: "object",
|
|
10687
10740
|
required: [
|
|
10741
|
+
"statusCode",
|
|
10742
|
+
"code",
|
|
10688
10743
|
"error",
|
|
10689
|
-
"message"
|
|
10744
|
+
"message",
|
|
10745
|
+
"retryable",
|
|
10746
|
+
"timestamp",
|
|
10747
|
+
"path"
|
|
10690
10748
|
],
|
|
10691
10749
|
properties: {
|
|
10750
|
+
statusCode: {
|
|
10751
|
+
type: "integer",
|
|
10752
|
+
description: "HTTP status code.",
|
|
10753
|
+
example: 400
|
|
10754
|
+
},
|
|
10755
|
+
code: {
|
|
10756
|
+
type: "string",
|
|
10757
|
+
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",
|
|
10758
|
+
example: "VALIDATION_ERROR"
|
|
10759
|
+
},
|
|
10692
10760
|
error: {
|
|
10693
10761
|
type: "string",
|
|
10694
|
-
description: "
|
|
10762
|
+
description: "HTTP status name.",
|
|
10763
|
+
example: "Bad Request"
|
|
10695
10764
|
},
|
|
10696
10765
|
message: {
|
|
10697
10766
|
type: "string",
|
|
10698
|
-
|
|
10699
|
-
|
|
10767
|
+
description: "Human-readable error description.",
|
|
10768
|
+
example: "name is required."
|
|
10700
10769
|
},
|
|
10701
|
-
|
|
10770
|
+
retryable: {
|
|
10771
|
+
type: "boolean",
|
|
10772
|
+
description: "Whether the client should retry the request.",
|
|
10773
|
+
example: false
|
|
10774
|
+
},
|
|
10775
|
+
timestamp: {
|
|
10702
10776
|
type: "string",
|
|
10703
|
-
|
|
10777
|
+
format: "date-time",
|
|
10778
|
+
description: "ISO 8601 timestamp when the error occurred.",
|
|
10779
|
+
example: "2026-04-25T14:30:00.000Z"
|
|
10704
10780
|
},
|
|
10705
|
-
|
|
10781
|
+
path: {
|
|
10782
|
+
type: "string",
|
|
10783
|
+
description: "Request path that failed.",
|
|
10784
|
+
example: "/v1/schemas"
|
|
10785
|
+
}
|
|
10786
|
+
}
|
|
10787
|
+
},
|
|
10788
|
+
WebhookEvent: {
|
|
10789
|
+
type: "object",
|
|
10790
|
+
description: "Webhook delivery payload sent to configured destinations.",
|
|
10791
|
+
required: [
|
|
10792
|
+
"event"
|
|
10793
|
+
],
|
|
10794
|
+
properties: {
|
|
10795
|
+
event: {
|
|
10706
10796
|
type: "object",
|
|
10707
|
-
|
|
10708
|
-
|
|
10709
|
-
|
|
10710
|
-
|
|
10797
|
+
required: [
|
|
10798
|
+
"event_type",
|
|
10799
|
+
"event_id",
|
|
10800
|
+
"binding_id",
|
|
10801
|
+
"idempotency_key",
|
|
10802
|
+
"attempt",
|
|
10803
|
+
"delivered_at"
|
|
10804
|
+
],
|
|
10805
|
+
properties: {
|
|
10806
|
+
event_type: {
|
|
10807
|
+
type: "string",
|
|
10808
|
+
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",
|
|
10809
|
+
example: "document.extracted"
|
|
10810
|
+
},
|
|
10811
|
+
event_id: {
|
|
10812
|
+
type: "string",
|
|
10813
|
+
description: "Monotonically increasing event sequence ID.",
|
|
10814
|
+
example: "42"
|
|
10815
|
+
},
|
|
10816
|
+
binding_id: {
|
|
10817
|
+
type: "string",
|
|
10818
|
+
format: "uuid",
|
|
10819
|
+
description: "The delivery binding that matched this event.",
|
|
10820
|
+
example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
|
|
10821
|
+
},
|
|
10822
|
+
idempotency_key: {
|
|
10823
|
+
type: "string",
|
|
10824
|
+
description: "32-character hex key derived from binding_id + event_id. Stable across retries.",
|
|
10825
|
+
example: "c9f3a7e1b2d4f6a8e0c2d4f6a8e0c2d4"
|
|
10826
|
+
},
|
|
10827
|
+
attempt: {
|
|
10828
|
+
type: "integer",
|
|
10829
|
+
description: "Delivery attempt number (1\u20137).",
|
|
10830
|
+
example: 1
|
|
10831
|
+
},
|
|
10832
|
+
delivered_at: {
|
|
10833
|
+
type: "string",
|
|
10834
|
+
format: "date-time",
|
|
10835
|
+
description: "Timestamp of this delivery attempt.",
|
|
10836
|
+
example: "2026-04-25T14:30:00.000Z"
|
|
10837
|
+
}
|
|
10838
|
+
}
|
|
10839
|
+
},
|
|
10840
|
+
payload: {
|
|
10841
|
+
type: "object",
|
|
10842
|
+
description: "Serialized deliverable data. Shape depends on the deliverable type and serializer format configured on the binding.",
|
|
10843
|
+
additionalProperties: true,
|
|
10844
|
+
example: {
|
|
10845
|
+
document_id: "f0e1d2c3-b4a5-9687-8765-432109876543",
|
|
10846
|
+
filename: "invoice-042.pdf",
|
|
10847
|
+
status: "completed",
|
|
10848
|
+
data: {
|
|
10849
|
+
invoice_number: "INV-2024-0042",
|
|
10850
|
+
total_amount: 1250
|
|
10851
|
+
}
|
|
10852
|
+
}
|
|
10853
|
+
},
|
|
10854
|
+
content: {
|
|
10855
|
+
type: [
|
|
10856
|
+
"object",
|
|
10857
|
+
"null"
|
|
10858
|
+
],
|
|
10859
|
+
description: "Binary content envelope (for file-type serializers like CSV/XLSX). Null when payload is used instead.",
|
|
10860
|
+
properties: {
|
|
10861
|
+
mime: {
|
|
10862
|
+
type: "string",
|
|
10863
|
+
example: "text/csv"
|
|
10864
|
+
},
|
|
10865
|
+
encoding: {
|
|
10866
|
+
type: "string",
|
|
10867
|
+
enum: [
|
|
10868
|
+
"utf-8",
|
|
10869
|
+
"base64"
|
|
10870
|
+
],
|
|
10871
|
+
example: "utf-8"
|
|
10872
|
+
},
|
|
10873
|
+
data: {
|
|
10874
|
+
type: "string",
|
|
10875
|
+
description: "UTF-8 text or base64-encoded binary."
|
|
10876
|
+
}
|
|
10877
|
+
}
|
|
10711
10878
|
}
|
|
10712
10879
|
}
|
|
10713
10880
|
},
|