@talonic/docs 0.10.0 → 0.12.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/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## 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",
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 Lifecycle\n\nEnd-to-end async flow:\n\n**Step 1 — Submit extraction with `async: true`:**\n```\nPOST /v1/extract\nContent-Type: multipart/form-data\nAuthorization: Bearer tlnc_live_abc123\n\nfile=@contract.pdf\noptions={\"async\": true}\n```\nResponse `202 Accepted`:\n```json\n{\n \"request_id\": \"req_x7y8z9a0\",\n \"status\": \"processing\",\n \"document\": { \"id\": \"f0e1d2c3-...\" },\n \"poll_url\": \"/v1/documents/f0e1d2c3-...\"\n}\n```\n\n**Step 2 — Poll for completion:**\n```\nGET /v1/documents/f0e1d2c3-...\n```\nResponse `200` (when done): `\"status\": \"completed\"`\n\n**Step 3 — Retrieve results:**\n```\nGET /v1/documents/f0e1d2c3-.../extractions\n```\n\n**Alternative — Webhooks:** Configure a delivery destination and binding\nto receive `document.extracted` events via POST callback. See the\nDelivery tag for setup details.\n\n**Job status state machine:**\n`pending` → `queued` → `processing` → `complete` | `failed`\n\nCancelled jobs transition directly to `failed` from `pending` or `processing`.\n\n## Operational Details\n\n**Uptime SLA:**\n- Free: best effort\n- Pro: 99.5%\n- Enterprise: 99.9% (custom SLA available)\n\n**Timeouts:** Synchronous extractions time out after 120 seconds. For\ndocuments that may take longer, use `async: true`. Async jobs have no\ntimeout — they run to completion or failure.\n\n**Payload limits:**\n- File upload (extract, ingest): 500 MB\n- JSON request bodies (schemas, jobs): 1 MB\n- PATCH corrections: 1 MB\n\n**Idempotency keys:** Pass an `Idempotency-Key` header on POST requests.\nKeys are valid for 24 hours. A duplicate request returns the cached\nresponse with `cached: true` in the body. Keys are scoped per API key.\n",
7
7
  "contact": {
8
8
  "name": "Talonic Support",
9
9
  "email": "support@talonic.ai",
@@ -67,7 +67,7 @@
67
67
  },
68
68
  {
69
69
  "name": "Delivery",
70
- "description": "Outbound delivery. Configure destinations (seven live connectors: webhook, sftp,\ns3, azure_blob, google_drive, onedrive, google_sheets), create bindings that join\nsignal filters to deliverable types + destinations + serializers, and inspect the\nhistory/DLQ/events log. Every delivery is at-least-once with an idempotency key\non the wire.\n"
70
+ "description": "Outbound delivery. Configure destinations (webhook, sftp, s3, azure_blob,\ngoogle_drive, onedrive, google_sheets), create bindings that join signal\nfilters to deliverable types + serializers, and inspect delivery history.\n\n## Webhook Delivery Contract\n\n**Payload envelope:**\n```json\n{\n \"event\": {\n \"event_type\": \"document.extracted\",\n \"event_id\": \"42\",\n \"binding_id\": \"uuid\",\n \"idempotency_key\": \"a1b2c3...32-char-hex\",\n \"attempt\": 1,\n \"delivered_at\": \"2026-04-25T14:30:00.000Z\"\n },\n \"payload\": { \"...serialized data...\" }\n}\n```\n\n**Headers:** `X-Talonic-Event`, `X-Talonic-Delivery`, `X-Talonic-Signature`,\n`X-Talonic-Attempt`, `X-Talonic-Idempotency-Key`.\n\n**Signature verification (HMAC-SHA256):**\n```\nX-Talonic-Signature: t=1714060200000,v1=abc123...\nsigned = HMAC-SHA256(signing_secret, \"${timestamp}.${body}\")\n```\n\n**Event types:** `document.extracted`, `document.extraction_failed`,\n`run.dataspace.completed`, `run.dataspace.failed`,\n`result.dataspace.completed`, `result.approved`, `result.rejected`,\n`delivery.item.completed`, `delivery.item.failed` (17 total).\n\n**Retry policy:** Up to 7 attempts with exponential backoff:\n0s → 30s → 2m → 8m → 30m → 2h → 8h (~10.5h total).\nHTTP 429 and 5xx are retryable. HTTP 4xx (except 408) goes to DLQ immediately.\n\n**Dead-letter queue:** Failed deliveries land in the DLQ. Replay via\n`POST /v1/delivery/dlq/{id}/replay` which re-enqueues with attempt=1\nand the same idempotency key.\n"
71
71
  },
72
72
  {
73
73
  "name": "Filter",
@@ -142,6 +142,61 @@
142
142
  "description": "Workspace context snapshot and tool discovery for the embedded AI agent."
143
143
  }
144
144
  ],
145
+ "x-tagGroups": [
146
+ {
147
+ "name": "Getting Started",
148
+ "tags": [
149
+ "Extract"
150
+ ]
151
+ },
152
+ {
153
+ "name": "Core Resources",
154
+ "tags": [
155
+ "Documents",
156
+ "Extractions",
157
+ "Schemas",
158
+ "Jobs"
159
+ ]
160
+ },
161
+ {
162
+ "name": "Data Pipeline",
163
+ "tags": [
164
+ "Sources",
165
+ "Batches",
166
+ "Routing",
167
+ "Delivery",
168
+ "Filter",
169
+ "Review"
170
+ ]
171
+ },
172
+ {
173
+ "name": "Intelligence",
174
+ "tags": [
175
+ "Matching",
176
+ "Cases",
177
+ "Linking",
178
+ "Fields",
179
+ "Reference Data",
180
+ "Dialects",
181
+ "Document Types",
182
+ "Schema Graph",
183
+ "N-Shot",
184
+ "Resolutions"
185
+ ]
186
+ },
187
+ {
188
+ "name": "Platform",
189
+ "tags": [
190
+ "Usage",
191
+ "Credits",
192
+ "Quality",
193
+ "Telemetry",
194
+ "Validation",
195
+ "Structuring",
196
+ "Agent"
197
+ ]
198
+ }
199
+ ],
145
200
  "paths": {
146
201
  "/v1/extract": {
147
202
  "post": {
@@ -171,6 +226,7 @@
171
226
  "document_id": {
172
227
  "type": "string",
173
228
  "format": "uuid",
229
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543",
174
230
  "description": "ID of an already-uploaded document to re-extract."
175
231
  },
176
232
  "schema": {
@@ -180,6 +236,7 @@
180
236
  "schema_id": {
181
237
  "type": "string",
182
238
  "format": "uuid",
239
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
183
240
  "description": "ID of a saved schema to use for extraction."
184
241
  },
185
242
  "instructions": {
@@ -232,6 +289,77 @@
232
289
  "application/json": {
233
290
  "schema": {
234
291
  "$ref": "#/components/schemas/ExtractSyncResponse"
292
+ },
293
+ "example": {
294
+ "extraction_id": "d1a2b3c4-5678-9abc-def0-1234567890ab",
295
+ "request_id": "req_x7y8z9a0b1c2d3e4",
296
+ "status": "complete",
297
+ "document": {
298
+ "id": "f0e1d2c3-b4a5-9687-8765-432109876543",
299
+ "filename": "invoice-042.pdf",
300
+ "pages": 3,
301
+ "size_bytes": 245760,
302
+ "type_detected": "Invoice",
303
+ "language_detected": "en"
304
+ },
305
+ "data": {
306
+ "invoice_number": "INV-2024-0042",
307
+ "invoice_date": "2024-03-15",
308
+ "vendor_name": "Acme Corp",
309
+ "total_amount": 1250,
310
+ "currency": "EUR",
311
+ "line_items": [
312
+ {
313
+ "description": "Consulting services",
314
+ "quantity": 10,
315
+ "unit_price": 100,
316
+ "amount": 1000
317
+ },
318
+ {
319
+ "description": "Expenses",
320
+ "quantity": 1,
321
+ "unit_price": 250,
322
+ "amount": 250
323
+ }
324
+ ]
325
+ },
326
+ "schema": {
327
+ "source": "inferred",
328
+ "id": null,
329
+ "definition": {
330
+ "type": "object",
331
+ "properties": {
332
+ "invoice_number": {
333
+ "type": "string"
334
+ },
335
+ "total_amount": {
336
+ "type": "number"
337
+ }
338
+ }
339
+ },
340
+ "save_url": "https://app.talonic.com/schemas/save?from=d1a2b3c4-5678-9abc-def0-1234567890ab"
341
+ },
342
+ "confidence": {
343
+ "overall": 0.94,
344
+ "fields": {
345
+ "invoice_number": 0.99,
346
+ "invoice_date": 0.97,
347
+ "vendor_name": 0.88,
348
+ "total_amount": 0.98,
349
+ "currency": 0.95,
350
+ "line_items": 0.85
351
+ }
352
+ },
353
+ "processing": {
354
+ "duration_ms": 3420,
355
+ "pages_processed": 3,
356
+ "region": "eu-west"
357
+ },
358
+ "links": {
359
+ "self": "/v1/extractions/d1a2b3c4-5678-9abc-def0-1234567890ab",
360
+ "document": "/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543",
361
+ "dashboard": "https://app.talonic.com/extractions/d1a2b3c4-5678-9abc-def0-1234567890ab"
362
+ }
235
363
  }
236
364
  }
237
365
  }
@@ -317,7 +445,8 @@
317
445
  "in": "query",
318
446
  "schema": {
319
447
  "type": "string",
320
- "format": "uuid"
448
+ "format": "uuid",
449
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
321
450
  },
322
451
  "description": "Filter by source connection ID."
323
452
  },
@@ -403,6 +532,50 @@
403
532
  }
404
533
  }
405
534
  ]
535
+ },
536
+ "example": {
537
+ "data": [
538
+ {
539
+ "id": "f0e1d2c3-b4a5-9687-8765-432109876543",
540
+ "filename": "contract-2024.pdf",
541
+ "pages": 12,
542
+ "size_bytes": 1048576,
543
+ "mime_type": "application/pdf",
544
+ "type_detected": "Service Contract",
545
+ "language_detected": "en",
546
+ "status": "completed",
547
+ "source": {
548
+ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
549
+ "type": "api"
550
+ },
551
+ "triage": {
552
+ "sensitivity": "confidential",
553
+ "department": "Legal",
554
+ "jurisdiction": "EU",
555
+ "pii_detected": true,
556
+ "pii_categories": [
557
+ "name",
558
+ "address"
559
+ ],
560
+ "regulated_data": false,
561
+ "confidentiality_marking": "internal"
562
+ },
563
+ "extraction_count": 1,
564
+ "latest_extraction_id": "d1a2b3c4-5678-9abc-def0-1234567890ab",
565
+ "created_at": "2026-04-25T14:30:00.000Z",
566
+ "links": {
567
+ "self": "/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543",
568
+ "extractions": "/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543/extractions",
569
+ "dashboard": "https://app.talonic.com/documents/f0e1d2c3-b4a5-9687-8765-432109876543"
570
+ }
571
+ }
572
+ ],
573
+ "pagination": {
574
+ "total": 142,
575
+ "limit": 20,
576
+ "has_more": true,
577
+ "next_cursor": "ZDFhMmIzYzR8MjAyNi0wNC0yNVQxNDozMDowMC4wMDBa"
578
+ }
406
579
  }
407
580
  }
408
581
  }
@@ -576,16 +749,19 @@
576
749
  "properties": {
577
750
  "id": {
578
751
  "type": "string",
579
- "format": "uuid"
752
+ "format": "uuid",
753
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
580
754
  },
581
755
  "status": {
582
756
  "type": "string",
757
+ "example": "completed",
583
758
  "enum": [
584
759
  "processing"
585
760
  ]
586
761
  },
587
762
  "message": {
588
- "type": "string"
763
+ "type": "string",
764
+ "example": "Re-extraction started."
589
765
  },
590
766
  "links": {
591
767
  "type": "object",
@@ -646,10 +822,12 @@
646
822
  "document_id": {
647
823
  "type": "string",
648
824
  "format": "uuid",
825
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543",
649
826
  "description": "ID of the document the markdown was produced from."
650
827
  },
651
828
  "markdown": {
652
829
  "type": "string",
830
+ "example": "# Invoice INV-2024-0042\nVendor: Acme Corp...",
653
831
  "description": "Full OCR-converted markdown body."
654
832
  }
655
833
  }
@@ -691,7 +869,8 @@
691
869
  "in": "query",
692
870
  "schema": {
693
871
  "type": "string",
694
- "format": "uuid"
872
+ "format": "uuid",
873
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
695
874
  },
696
875
  "description": "Filter by document ID."
697
876
  },
@@ -845,8 +1024,15 @@
845
1024
  "description": "Key-value pairs of extracted field names and values.",
846
1025
  "example": {
847
1026
  "invoice_number": "INV-2024-0042",
1027
+ "invoice_date": "2024-03-15",
1028
+ "vendor_name": "Acme Corp",
1029
+ "vendor_address": "123 Main St, Berlin, DE",
848
1030
  "total_amount": 1250,
849
- "vendor_name": "Acme Corp"
1031
+ "currency": "EUR",
1032
+ "tax_rate": 19,
1033
+ "tax_amount": 199.58,
1034
+ "payment_terms": "Net 30",
1035
+ "due_date": "2024-04-14"
850
1036
  }
851
1037
  }
852
1038
  },
@@ -921,6 +1107,45 @@
921
1107
  "application/json": {
922
1108
  "schema": {
923
1109
  "$ref": "#/components/schemas/ExtractionResponse"
1110
+ },
1111
+ "example": {
1112
+ "id": "d1a2b3c4-5678-9abc-def0-1234567890ab",
1113
+ "status": "complete",
1114
+ "document": {
1115
+ "id": "f0e1d2c3-b4a5-9687-8765-432109876543",
1116
+ "filename": "invoice-042.pdf",
1117
+ "pages": 3,
1118
+ "type_detected": "Invoice"
1119
+ },
1120
+ "data": {
1121
+ "vendor_name": "Acme Corporation Ltd.",
1122
+ "total_amount": 1275.5,
1123
+ "invoice_number": "INV-2024-0042"
1124
+ },
1125
+ "confidence": {
1126
+ "overall": 0.96,
1127
+ "fields": {
1128
+ "vendor_name": 1,
1129
+ "total_amount": 1,
1130
+ "invoice_number": 0.99
1131
+ }
1132
+ },
1133
+ "locked_fields": [
1134
+ "vendor_name",
1135
+ "total_amount"
1136
+ ],
1137
+ "processing": {
1138
+ "duration_ms": 3420,
1139
+ "pages_processed": 3,
1140
+ "region": "eu-west"
1141
+ },
1142
+ "created_at": "2026-04-25T14:30:00.000Z",
1143
+ "links": {
1144
+ "self": "/v1/extractions/d1a2b3c4-5678-9abc-def0-1234567890ab",
1145
+ "data": "/v1/extractions/d1a2b3c4-5678-9abc-def0-1234567890ab/data",
1146
+ "document": "/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543",
1147
+ "dashboard": "https://app.talonic.com/extractions/d1a2b3c4-5678-9abc-def0-1234567890ab"
1148
+ }
924
1149
  }
925
1150
  }
926
1151
  }
@@ -1024,6 +1249,36 @@
1024
1249
  "application/json": {
1025
1250
  "schema": {
1026
1251
  "$ref": "#/components/schemas/SchemaCreateRequest"
1252
+ },
1253
+ "example": {
1254
+ "name": "Invoice Schema",
1255
+ "description": "Standard invoice fields for AP processing.",
1256
+ "definition": {
1257
+ "properties": {
1258
+ "invoice_number": {
1259
+ "type": "string",
1260
+ "title": "Invoice Number",
1261
+ "description": "Unique identifier on the invoice."
1262
+ },
1263
+ "vendor_name": {
1264
+ "type": "string",
1265
+ "title": "Vendor Name"
1266
+ },
1267
+ "total_amount": {
1268
+ "type": "number",
1269
+ "title": "Total Amount",
1270
+ "description": "Total invoice amount including tax."
1271
+ },
1272
+ "invoice_date": {
1273
+ "type": "string",
1274
+ "title": "Invoice Date"
1275
+ }
1276
+ },
1277
+ "required": [
1278
+ "invoice_number",
1279
+ "total_amount"
1280
+ ]
1281
+ }
1027
1282
  }
1028
1283
  }
1029
1284
  }
@@ -1035,6 +1290,47 @@
1035
1290
  "application/json": {
1036
1291
  "schema": {
1037
1292
  "$ref": "#/components/schemas/SchemaResponse"
1293
+ },
1294
+ "example": {
1295
+ "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
1296
+ "name": "Invoice Schema",
1297
+ "description": "Standard invoice fields for AP processing.",
1298
+ "definition": {
1299
+ "type": "object",
1300
+ "properties": {
1301
+ "invoice_number": {
1302
+ "type": "string",
1303
+ "title": "Invoice Number",
1304
+ "description": "Unique identifier on the invoice."
1305
+ },
1306
+ "vendor_name": {
1307
+ "type": "string",
1308
+ "title": "Vendor Name"
1309
+ },
1310
+ "total_amount": {
1311
+ "type": "number",
1312
+ "title": "Total Amount",
1313
+ "description": "Total invoice amount including tax."
1314
+ },
1315
+ "invoice_date": {
1316
+ "type": "string",
1317
+ "title": "Invoice Date"
1318
+ }
1319
+ },
1320
+ "required": [
1321
+ "invoice_number",
1322
+ "total_amount"
1323
+ ]
1324
+ },
1325
+ "field_count": 4,
1326
+ "version": 1,
1327
+ "created_at": "2026-04-25T14:30:00.000Z",
1328
+ "updated_at": "2026-04-25T14:30:00.000Z",
1329
+ "links": {
1330
+ "self": "/v1/schemas/b2c3d4e5-f6a7-8901-bcde-f12345678901",
1331
+ "extractions": "/v1/extractions?schema_id=b2c3d4e5-f6a7-8901-bcde-f12345678901",
1332
+ "dashboard": "https://app.talonic.com/schemas/b2c3d4e5-f6a7-8901-bcde-f12345678901"
1333
+ }
1038
1334
  }
1039
1335
  }
1040
1336
  }
@@ -1371,6 +1667,34 @@
1371
1667
  "application/json": {
1372
1668
  "schema": {
1373
1669
  "$ref": "#/components/schemas/JobResponse"
1670
+ },
1671
+ "example": {
1672
+ "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
1673
+ "name": "Q1 Invoice Processing",
1674
+ "status": "processing",
1675
+ "progress": 45,
1676
+ "estimated_seconds_remaining": null,
1677
+ "schema": {
1678
+ "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
1679
+ "name": "Invoice Schema"
1680
+ },
1681
+ "document_count": 150,
1682
+ "completed_documents": 67,
1683
+ "grid_stats": {
1684
+ "total_cells": 8850,
1685
+ "filled": 6200,
1686
+ "empty": 2650,
1687
+ "fill_rate": 0.7
1688
+ },
1689
+ "current_phase": "phase_2_execute",
1690
+ "created_at": "2026-04-25T14:30:00.000Z",
1691
+ "started_at": "2026-04-25T14:30:05.000Z",
1692
+ "completed_at": null,
1693
+ "links": {
1694
+ "self": "/v1/jobs/c3d4e5f6-a7b8-9012-cdef-123456789012",
1695
+ "cancel": "/v1/jobs/c3d4e5f6-a7b8-9012-cdef-123456789012/cancel",
1696
+ "dashboard": "https://app.talonic.com/jobs/c3d4e5f6-a7b8-9012-cdef-123456789012"
1697
+ }
1374
1698
  }
1375
1699
  }
1376
1700
  }
@@ -1523,6 +1847,10 @@
1523
1847
  "application/json": {
1524
1848
  "schema": {
1525
1849
  "$ref": "#/components/schemas/SourceCreateRequest"
1850
+ },
1851
+ "example": {
1852
+ "name": "Invoice Pipeline",
1853
+ "default_schema_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
1526
1854
  }
1527
1855
  }
1528
1856
  }
@@ -1548,6 +1876,24 @@
1548
1876
  }
1549
1877
  }
1550
1878
  ]
1879
+ },
1880
+ "example": {
1881
+ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
1882
+ "name": "Invoice Pipeline",
1883
+ "type": "api",
1884
+ "status": "active",
1885
+ "document_count": 0,
1886
+ "default_schema": {
1887
+ "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
1888
+ },
1889
+ "endpoint": "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/documents",
1890
+ "api_key": "tlnc_live_src_k8m2n4p6q9r1s3t5",
1891
+ "created_at": "2026-04-25T14:30:00.000Z",
1892
+ "links": {
1893
+ "self": "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
1894
+ "documents": "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/documents",
1895
+ "dashboard": "https://app.talonic.com/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
1896
+ }
1551
1897
  }
1552
1898
  }
1553
1899
  }
@@ -1733,6 +2079,17 @@
1733
2079
  "application/json": {
1734
2080
  "schema": {
1735
2081
  "$ref": "#/components/schemas/IngestDocumentResponse"
2082
+ },
2083
+ "example": {
2084
+ "document_id": "f0e1d2c3-b4a5-9687-8765-432109876543",
2085
+ "filename": "receipt-march.pdf",
2086
+ "status": "queued",
2087
+ "processing_mode": "realtime",
2088
+ "source_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
2089
+ "links": {
2090
+ "document": "/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543",
2091
+ "source": "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
2092
+ }
1736
2093
  }
1737
2094
  }
1738
2095
  }
@@ -2329,7 +2686,8 @@
2329
2686
  "in": "query",
2330
2687
  "schema": {
2331
2688
  "type": "string",
2332
- "format": "uuid"
2689
+ "format": "uuid",
2690
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
2333
2691
  },
2334
2692
  "description": "Filter to runs that belong to a specific matching configuration."
2335
2693
  }
@@ -4861,7 +5219,8 @@
4861
5219
  "in": "query",
4862
5220
  "schema": {
4863
5221
  "type": "string",
4864
- "format": "uuid"
5222
+ "format": "uuid",
5223
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
4865
5224
  },
4866
5225
  "description": "Filter by cluster."
4867
5226
  }
@@ -5007,10 +5366,12 @@
5007
5366
  "properties": {
5008
5367
  "id": {
5009
5368
  "type": "string",
5010
- "format": "uuid"
5369
+ "format": "uuid",
5370
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
5011
5371
  },
5012
5372
  "canonical_name": {
5013
- "type": "string"
5373
+ "type": "string",
5374
+ "example": "invoice_number"
5014
5375
  },
5015
5376
  "similarity": {
5016
5377
  "type": "number",
@@ -5031,6 +5392,7 @@
5031
5392
  },
5032
5393
  "message": {
5033
5394
  "type": "string",
5395
+ "example": "Re-extraction started.",
5034
5396
  "description": "Present when the field has no embedding."
5035
5397
  }
5036
5398
  }
@@ -5394,6 +5756,7 @@
5394
5756
  "source_run_id": {
5395
5757
  "type": "string",
5396
5758
  "format": "uuid",
5759
+ "example": "f2a3b4c5-d6e7-8901-fabc-012345678901",
5397
5760
  "description": "ID of the source run to resolve against."
5398
5761
  }
5399
5762
  }
@@ -5648,7 +6011,8 @@
5648
6011
  "type": "array",
5649
6012
  "items": {
5650
6013
  "type": "string",
5651
- "format": "uuid"
6014
+ "format": "uuid",
6015
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
5652
6016
  }
5653
6017
  }
5654
6018
  }
@@ -5824,10 +6188,12 @@
5824
6188
  "type": "object",
5825
6189
  "properties": {
5826
6190
  "status": {
5827
- "type": "string"
6191
+ "type": "string",
6192
+ "example": "completed"
5828
6193
  },
5829
6194
  "message": {
5830
- "type": "string"
6195
+ "type": "string",
6196
+ "example": "Re-extraction started."
5831
6197
  }
5832
6198
  }
5833
6199
  }
@@ -5860,7 +6226,8 @@
5860
6226
  "type": "object",
5861
6227
  "properties": {
5862
6228
  "status": {
5863
- "type": "string"
6229
+ "type": "string",
6230
+ "example": "completed"
5864
6231
  },
5865
6232
  "processed": {
5866
6233
  "type": "integer"
@@ -5870,7 +6237,8 @@
5870
6237
  },
5871
6238
  "started_at": {
5872
6239
  "type": "string",
5873
- "format": "date-time"
6240
+ "format": "date-time",
6241
+ "example": "2026-04-25T14:30:00.000Z"
5874
6242
  }
5875
6243
  }
5876
6244
  }
@@ -5938,7 +6306,8 @@
5938
6306
  "required": true,
5939
6307
  "schema": {
5940
6308
  "type": "string",
5941
- "format": "uuid"
6309
+ "format": "uuid",
6310
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
5942
6311
  },
5943
6312
  "description": "Job run ID."
5944
6313
  }
@@ -5982,7 +6351,8 @@
5982
6351
  "required": true,
5983
6352
  "schema": {
5984
6353
  "type": "string",
5985
- "format": "uuid"
6354
+ "format": "uuid",
6355
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
5986
6356
  },
5987
6357
  "description": "Job run ID."
5988
6358
  }
@@ -6034,7 +6404,8 @@
6034
6404
  "required": true,
6035
6405
  "schema": {
6036
6406
  "type": "string",
6037
- "format": "uuid"
6407
+ "format": "uuid",
6408
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
6038
6409
  },
6039
6410
  "description": "Job run ID."
6040
6411
  },
@@ -6044,7 +6415,8 @@
6044
6415
  "required": true,
6045
6416
  "schema": {
6046
6417
  "type": "string",
6047
- "format": "uuid"
6418
+ "format": "uuid",
6419
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
6048
6420
  },
6049
6421
  "description": "Document ID to compare."
6050
6422
  },
@@ -6097,7 +6469,8 @@
6097
6469
  "required": true,
6098
6470
  "schema": {
6099
6471
  "type": "string",
6100
- "format": "uuid"
6472
+ "format": "uuid",
6473
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
6101
6474
  },
6102
6475
  "description": "Job run ID."
6103
6476
  }
@@ -6116,10 +6489,12 @@
6116
6489
  "properties": {
6117
6490
  "document_id": {
6118
6491
  "type": "string",
6119
- "format": "uuid"
6492
+ "format": "uuid",
6493
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
6120
6494
  },
6121
6495
  "field_name": {
6122
- "type": "string"
6496
+ "type": "string",
6497
+ "example": "invoice_number"
6123
6498
  },
6124
6499
  "value": {
6125
6500
  "description": "The override value to apply."
@@ -6175,7 +6550,8 @@
6175
6550
  "required": true,
6176
6551
  "schema": {
6177
6552
  "type": "string",
6178
- "format": "uuid"
6553
+ "format": "uuid",
6554
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
6179
6555
  },
6180
6556
  "description": "Job run ID."
6181
6557
  }
@@ -6194,10 +6570,12 @@
6194
6570
  "properties": {
6195
6571
  "document_id": {
6196
6572
  "type": "string",
6197
- "format": "uuid"
6573
+ "format": "uuid",
6574
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
6198
6575
  },
6199
6576
  "field_name": {
6200
- "type": "string"
6577
+ "type": "string",
6578
+ "example": "invoice_number"
6201
6579
  },
6202
6580
  "decision": {
6203
6581
  "type": "string",
@@ -6348,7 +6726,8 @@
6348
6726
  },
6349
6727
  "created_at": {
6350
6728
  "type": "string",
6351
- "format": "date-time"
6729
+ "format": "date-time",
6730
+ "example": "2026-04-25T14:30:00.000Z"
6352
6731
  }
6353
6732
  }
6354
6733
  }
@@ -6411,7 +6790,8 @@
6411
6790
  },
6412
6791
  "created_at": {
6413
6792
  "type": "string",
6414
- "format": "date-time"
6793
+ "format": "date-time",
6794
+ "example": "2026-04-25T14:30:00.000Z"
6415
6795
  }
6416
6796
  }
6417
6797
  }
@@ -6561,11 +6941,13 @@
6561
6941
  "properties": {
6562
6942
  "source_class_id": {
6563
6943
  "type": "string",
6564
- "format": "uuid"
6944
+ "format": "uuid",
6945
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
6565
6946
  },
6566
6947
  "target_class_id": {
6567
6948
  "type": "string",
6568
- "format": "uuid"
6949
+ "format": "uuid",
6950
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
6569
6951
  },
6570
6952
  "relationship": {
6571
6953
  "type": "string"
@@ -6617,7 +6999,8 @@
6617
6999
  },
6618
7000
  "class_id": {
6619
7001
  "type": "string",
6620
- "format": "uuid"
7002
+ "format": "uuid",
7003
+ "example": "a7b8c9d0-e1f2-3456-abcd-567890123456"
6621
7004
  },
6622
7005
  "class_name": {
6623
7006
  "type": "string"
@@ -7180,7 +7563,8 @@
7180
7563
  "properties": {
7181
7564
  "rule_id": {
7182
7565
  "type": "string",
7183
- "format": "uuid"
7566
+ "format": "uuid",
7567
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
7184
7568
  }
7185
7569
  }
7186
7570
  }
@@ -7238,7 +7622,8 @@
7238
7622
  "properties": {
7239
7623
  "check_id": {
7240
7624
  "type": "string",
7241
- "format": "uuid"
7625
+ "format": "uuid",
7626
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
7242
7627
  },
7243
7628
  "check_name": {
7244
7629
  "type": "string"
@@ -7346,10 +7731,12 @@
7346
7731
  "properties": {
7347
7732
  "id": {
7348
7733
  "type": "string",
7349
- "format": "uuid"
7734
+ "format": "uuid",
7735
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
7350
7736
  },
7351
7737
  "status": {
7352
- "type": "string"
7738
+ "type": "string",
7739
+ "example": "completed"
7353
7740
  }
7354
7741
  }
7355
7742
  }
@@ -7390,10 +7777,12 @@
7390
7777
  "properties": {
7391
7778
  "id": {
7392
7779
  "type": "string",
7393
- "format": "uuid"
7780
+ "format": "uuid",
7781
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
7394
7782
  },
7395
7783
  "status": {
7396
- "type": "string"
7784
+ "type": "string",
7785
+ "example": "completed"
7397
7786
  }
7398
7787
  }
7399
7788
  }
@@ -7427,7 +7816,8 @@
7427
7816
  "required": true,
7428
7817
  "schema": {
7429
7818
  "type": "string",
7430
- "format": "uuid"
7819
+ "format": "uuid",
7820
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
7431
7821
  },
7432
7822
  "description": "Structuring run ID."
7433
7823
  }
@@ -7821,11 +8211,13 @@
7821
8211
  "golden_sample_id": {
7822
8212
  "type": "string",
7823
8213
  "format": "uuid",
8214
+ "example": "e5f6a7b8-c9d0-1234-efab-345678901234",
7824
8215
  "description": "Golden sample dataset to validate against."
7825
8216
  },
7826
8217
  "schema_id": {
7827
8218
  "type": "string",
7828
8219
  "format": "uuid",
8220
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
7829
8221
  "description": "Optional schema to scope the validation."
7830
8222
  }
7831
8223
  }
@@ -8005,11 +8397,13 @@
8005
8397
  "format": "float"
8006
8398
  },
8007
8399
  "currency": {
8008
- "type": "string"
8400
+ "type": "string",
8401
+ "example": "USD"
8009
8402
  },
8010
8403
  "updated_at": {
8011
8404
  "type": "string",
8012
- "format": "date-time"
8405
+ "format": "date-time",
8406
+ "example": "2026-04-25T14:30:00.000Z"
8013
8407
  }
8014
8408
  }
8015
8409
  }
@@ -8064,7 +8458,8 @@
8064
8458
  "properties": {
8065
8459
  "id": {
8066
8460
  "type": "string",
8067
- "format": "uuid"
8461
+ "format": "uuid",
8462
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8068
8463
  },
8069
8464
  "type": {
8070
8465
  "type": "string",
@@ -8082,7 +8477,8 @@
8082
8477
  },
8083
8478
  "created_at": {
8084
8479
  "type": "string",
8085
- "format": "date-time"
8480
+ "format": "date-time",
8481
+ "example": "2026-04-25T14:30:00.000Z"
8086
8482
  }
8087
8483
  }
8088
8484
  }
@@ -8302,7 +8698,8 @@
8302
8698
  },
8303
8699
  "created_at": {
8304
8700
  "type": "string",
8305
- "format": "date-time"
8701
+ "format": "date-time",
8702
+ "example": "2026-04-25T14:30:00.000Z"
8306
8703
  }
8307
8704
  }
8308
8705
  }
@@ -8353,6 +8750,7 @@
8353
8750
  "properties": {
8354
8751
  "status": {
8355
8752
  "type": "string",
8753
+ "example": "completed",
8356
8754
  "description": "New status (e.g. open, in_review, resolved, archived)."
8357
8755
  }
8358
8756
  }
@@ -8420,11 +8818,13 @@
8420
8818
  "properties": {
8421
8819
  "source_document_id": {
8422
8820
  "type": "string",
8423
- "format": "uuid"
8821
+ "format": "uuid",
8822
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8424
8823
  },
8425
8824
  "target_document_id": {
8426
8825
  "type": "string",
8427
- "format": "uuid"
8826
+ "format": "uuid",
8827
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8428
8828
  },
8429
8829
  "entity_value": {
8430
8830
  "type": "string"
@@ -8478,11 +8878,13 @@
8478
8878
  "properties": {
8479
8879
  "source_document_id": {
8480
8880
  "type": "string",
8481
- "format": "uuid"
8881
+ "format": "uuid",
8882
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8482
8883
  },
8483
8884
  "target_document_id": {
8484
8885
  "type": "string",
8485
- "format": "uuid"
8886
+ "format": "uuid",
8887
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8486
8888
  },
8487
8889
  "entity_value": {
8488
8890
  "type": "string"
@@ -8542,11 +8944,13 @@
8542
8944
  "properties": {
8543
8945
  "source_document_id": {
8544
8946
  "type": "string",
8545
- "format": "uuid"
8947
+ "format": "uuid",
8948
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8546
8949
  },
8547
8950
  "target_document_id": {
8548
8951
  "type": "string",
8549
- "format": "uuid"
8952
+ "format": "uuid",
8953
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8550
8954
  },
8551
8955
  "entity_value": {
8552
8956
  "type": "string"
@@ -8617,7 +9021,8 @@
8617
9021
  "type": "array",
8618
9022
  "items": {
8619
9023
  "type": "string",
8620
- "format": "uuid"
9024
+ "format": "uuid",
9025
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8621
9026
  },
8622
9027
  "description": "Document IDs to move to the new case."
8623
9028
  }
@@ -8823,7 +9228,8 @@
8823
9228
  "type": "array",
8824
9229
  "items": {
8825
9230
  "type": "string",
8826
- "format": "uuid"
9231
+ "format": "uuid",
9232
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8827
9233
  }
8828
9234
  }
8829
9235
  }
@@ -8890,7 +9296,8 @@
8890
9296
  "type": "array",
8891
9297
  "items": {
8892
9298
  "type": "string",
8893
- "format": "uuid"
9299
+ "format": "uuid",
9300
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8894
9301
  }
8895
9302
  }
8896
9303
  }
@@ -9020,6 +9427,7 @@
9020
9427
  "config_id": {
9021
9428
  "type": "string",
9022
9429
  "format": "uuid",
9430
+ "example": "c9d0e1f2-a3b4-5678-cdef-789012345678",
9023
9431
  "description": "Matching configuration ID."
9024
9432
  }
9025
9433
  }
@@ -9074,6 +9482,7 @@
9074
9482
  "run_id": {
9075
9483
  "type": "string",
9076
9484
  "format": "uuid",
9485
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
9077
9486
  "description": "Matching run ID to resolve."
9078
9487
  }
9079
9488
  }
@@ -9138,7 +9547,8 @@
9138
9547
  "properties": {
9139
9548
  "id": {
9140
9549
  "type": "string",
9141
- "format": "uuid"
9550
+ "format": "uuid",
9551
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
9142
9552
  },
9143
9553
  "name": {
9144
9554
  "type": "string"
@@ -9416,7 +9826,8 @@
9416
9826
  "type": "object",
9417
9827
  "properties": {
9418
9828
  "status": {
9419
- "type": "string"
9829
+ "type": "string",
9830
+ "example": "completed"
9420
9831
  },
9421
9832
  "processed": {
9422
9833
  "type": "integer"
@@ -9475,7 +9886,8 @@
9475
9886
  "properties": {
9476
9887
  "document_id": {
9477
9888
  "type": "string",
9478
- "format": "uuid"
9889
+ "format": "uuid",
9890
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
9479
9891
  },
9480
9892
  "reference_id": {
9481
9893
  "type": "string"
@@ -9549,12 +9961,14 @@
9549
9961
  "type": "array",
9550
9962
  "items": {
9551
9963
  "type": "string",
9552
- "format": "uuid"
9964
+ "format": "uuid",
9965
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
9553
9966
  }
9554
9967
  },
9555
9968
  "assignee_id": {
9556
9969
  "type": "string",
9557
9970
  "format": "uuid",
9971
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
9558
9972
  "description": "User ID of the assignee."
9559
9973
  }
9560
9974
  }
@@ -9710,14 +10124,16 @@
9710
10124
  "properties": {
9711
10125
  "document_id": {
9712
10126
  "type": "string",
9713
- "format": "uuid"
10127
+ "format": "uuid",
10128
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
9714
10129
  },
9715
10130
  "expected_data": {
9716
10131
  "type": "object",
9717
10132
  "additionalProperties": true
9718
10133
  },
9719
10134
  "notes": {
9720
- "type": "string"
10135
+ "type": "string",
10136
+ "example": "Reviewed and confirmed."
9721
10137
  }
9722
10138
  }
9723
10139
  }
@@ -9767,7 +10183,8 @@
9767
10183
  "required": true,
9768
10184
  "schema": {
9769
10185
  "type": "string",
9770
- "format": "uuid"
10186
+ "format": "uuid",
10187
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
9771
10188
  },
9772
10189
  "description": "Entry ID."
9773
10190
  }
@@ -9784,7 +10201,8 @@
9784
10201
  "additionalProperties": true
9785
10202
  },
9786
10203
  "notes": {
9787
- "type": "string"
10204
+ "type": "string",
10205
+ "example": "Reviewed and confirmed."
9788
10206
  }
9789
10207
  }
9790
10208
  }
@@ -9829,7 +10247,8 @@
9829
10247
  "required": true,
9830
10248
  "schema": {
9831
10249
  "type": "string",
9832
- "format": "uuid"
10250
+ "format": "uuid",
10251
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
9833
10252
  },
9834
10253
  "description": "Entry ID."
9835
10254
  }
@@ -9919,7 +10338,8 @@
9919
10338
  "required": true,
9920
10339
  "schema": {
9921
10340
  "type": "string",
9922
- "format": "uuid"
10341
+ "format": "uuid",
10342
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
9923
10343
  },
9924
10344
  "description": "ID of the benchmark run to compare against."
9925
10345
  }
@@ -10172,7 +10592,8 @@
10172
10592
  "required": true,
10173
10593
  "schema": {
10174
10594
  "type": "string",
10175
- "format": "uuid"
10595
+ "format": "uuid",
10596
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10176
10597
  },
10177
10598
  "description": "Resource UUID."
10178
10599
  },
@@ -10247,8 +10668,13 @@
10247
10668
  "$ref": "#/components/schemas/ErrorResponse"
10248
10669
  },
10249
10670
  "example": {
10250
- "error": "validation_error",
10251
- "message": "name is required."
10671
+ "statusCode": 400,
10672
+ "code": "VALIDATION_ERROR",
10673
+ "error": "Bad Request",
10674
+ "message": "name is required.",
10675
+ "retryable": false,
10676
+ "timestamp": "2026-04-25T14:30:00.000Z",
10677
+ "path": "/v1/schemas"
10252
10678
  }
10253
10679
  }
10254
10680
  }
@@ -10261,8 +10687,13 @@
10261
10687
  "$ref": "#/components/schemas/ErrorResponse"
10262
10688
  },
10263
10689
  "example": {
10264
- "error": "unauthorized",
10265
- "message": "Invalid or missing API key."
10690
+ "statusCode": 401,
10691
+ "code": "AUTH_REQUIRED",
10692
+ "error": "Unauthorized",
10693
+ "message": "Invalid or missing API key.",
10694
+ "retryable": false,
10695
+ "timestamp": "2026-04-25T14:30:00.000Z",
10696
+ "path": "/v1/extract"
10266
10697
  }
10267
10698
  }
10268
10699
  }
@@ -10275,8 +10706,13 @@
10275
10706
  "$ref": "#/components/schemas/ErrorResponse"
10276
10707
  },
10277
10708
  "example": {
10278
- "error": "insufficient_scope",
10279
- "message": "This key does not have the 'write' scope."
10709
+ "statusCode": 403,
10710
+ "code": "INSUFFICIENT_PERMISSIONS",
10711
+ "error": "Forbidden",
10712
+ "message": "This key does not have the 'write' scope.",
10713
+ "retryable": false,
10714
+ "timestamp": "2026-04-25T14:30:00.000Z",
10715
+ "path": "/v1/schemas"
10280
10716
  }
10281
10717
  }
10282
10718
  }
@@ -10289,8 +10725,13 @@
10289
10725
  "$ref": "#/components/schemas/ErrorResponse"
10290
10726
  },
10291
10727
  "example": {
10292
- "error": "not_found",
10293
- "message": "Document 'abc-123' not found."
10728
+ "statusCode": 404,
10729
+ "code": "RESOURCE_NOT_FOUND",
10730
+ "error": "Not Found",
10731
+ "message": "Document 'f0e1d2c3-b4a5-9687-8765-432109876543' not found.",
10732
+ "retryable": false,
10733
+ "timestamp": "2026-04-25T14:30:00.000Z",
10734
+ "path": "/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543"
10294
10735
  }
10295
10736
  }
10296
10737
  }
@@ -10303,8 +10744,13 @@
10303
10744
  "$ref": "#/components/schemas/ErrorResponse"
10304
10745
  },
10305
10746
  "example": {
10306
- "error": "conflict",
10307
- "message": "Job is already completed. Cannot cancel."
10747
+ "statusCode": 409,
10748
+ "code": "VALIDATION_ERROR",
10749
+ "error": "Conflict",
10750
+ "message": "Job is already completed. Cannot cancel.",
10751
+ "retryable": false,
10752
+ "timestamp": "2026-04-25T14:30:00.000Z",
10753
+ "path": "/v1/jobs/c3d4e5f6-a7b8-9012-cdef-123456789012/cancel"
10308
10754
  }
10309
10755
  }
10310
10756
  }
@@ -10317,8 +10763,13 @@
10317
10763
  "$ref": "#/components/schemas/ErrorResponse"
10318
10764
  },
10319
10765
  "example": {
10320
- "error": "payload_too_large",
10321
- "message": "File exceeds the 500 MB limit."
10766
+ "statusCode": 413,
10767
+ "code": "FILE_TOO_LARGE",
10768
+ "error": "Payload Too Large",
10769
+ "message": "File exceeds the 500 MB limit.",
10770
+ "retryable": false,
10771
+ "timestamp": "2026-04-25T14:30:00.000Z",
10772
+ "path": "/v1/extract"
10322
10773
  }
10323
10774
  }
10324
10775
  }
@@ -10331,9 +10782,13 @@
10331
10782
  "$ref": "#/components/schemas/ErrorResponse"
10332
10783
  },
10333
10784
  "example": {
10334
- "error": "extraction_failed",
10785
+ "statusCode": 422,
10786
+ "code": "EXTRACTION_FAILED",
10787
+ "error": "Unprocessable Entity",
10335
10788
  "message": "Unable to extract fields from the provided document.",
10336
- "request_id": "req_abc123",
10789
+ "retryable": false,
10790
+ "timestamp": "2026-04-25T14:30:00.000Z",
10791
+ "path": "/v1/extract",
10337
10792
  "links": {
10338
10793
  "dashboard": "https://app.talonic.com/documents/abc-123"
10339
10794
  }
@@ -10360,11 +10815,13 @@
10360
10815
  "$ref": "#/components/schemas/ErrorResponse"
10361
10816
  },
10362
10817
  "example": {
10363
- "error": "rate_limit_exceeded",
10818
+ "statusCode": 429,
10819
+ "code": "QUOTA_EXCEEDED",
10820
+ "error": "Too Many Requests",
10364
10821
  "message": "Daily extract request limit (50) reached. Resets at midnight UTC.",
10365
- "limit": 50,
10366
- "used": 50,
10367
- "reset_at": "2026-04-05T00:00:00.000Z"
10822
+ "retryable": true,
10823
+ "timestamp": "2026-04-25T23:45:00.000Z",
10824
+ "path": "/v1/extract"
10368
10825
  }
10369
10826
  }
10370
10827
  }
@@ -10377,9 +10834,13 @@
10377
10834
  "$ref": "#/components/schemas/ErrorResponse"
10378
10835
  },
10379
10836
  "example": {
10380
- "error": "internal_error",
10837
+ "statusCode": 500,
10838
+ "code": "INTERNAL_ERROR",
10839
+ "error": "Internal Server Error",
10381
10840
  "message": "An unexpected error occurred. Please try again or contact support.",
10382
- "request_id": "req_xyz789"
10841
+ "retryable": true,
10842
+ "timestamp": "2026-04-25T14:30:00.000Z",
10843
+ "path": "/v1/extract"
10383
10844
  }
10384
10845
  }
10385
10846
  }
@@ -10389,28 +10850,50 @@
10389
10850
  "ErrorResponse": {
10390
10851
  "type": "object",
10391
10852
  "required": [
10853
+ "statusCode",
10854
+ "code",
10392
10855
  "error",
10393
- "message"
10856
+ "message",
10857
+ "retryable",
10858
+ "timestamp",
10859
+ "path"
10394
10860
  ],
10395
10861
  "properties": {
10862
+ "statusCode": {
10863
+ "type": "integer",
10864
+ "description": "HTTP status code.",
10865
+ "example": 400
10866
+ },
10867
+ "code": {
10868
+ "type": "string",
10869
+ "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",
10870
+ "example": "VALIDATION_ERROR"
10871
+ },
10396
10872
  "error": {
10397
10873
  "type": "string",
10398
- "description": "Machine-readable error code."
10874
+ "description": "HTTP status name.",
10875
+ "example": "Bad Request"
10399
10876
  },
10400
10877
  "message": {
10401
10878
  "type": "string",
10402
- "description": "Human-readable error description."
10879
+ "description": "Human-readable error description.",
10880
+ "example": "name is required."
10403
10881
  },
10404
- "request_id": {
10882
+ "retryable": {
10883
+ "type": "boolean",
10884
+ "description": "Whether the client should retry the request.",
10885
+ "example": false
10886
+ },
10887
+ "timestamp": {
10405
10888
  "type": "string",
10406
- "description": "Request ID for support reference."
10889
+ "format": "date-time",
10890
+ "description": "ISO 8601 timestamp when the error occurred.",
10891
+ "example": "2026-04-25T14:30:00.000Z"
10407
10892
  },
10408
- "links": {
10409
- "type": "object",
10410
- "additionalProperties": {
10411
- "type": "string"
10412
- },
10413
- "description": "Related resource links."
10893
+ "path": {
10894
+ "type": "string",
10895
+ "description": "Request path that failed.",
10896
+ "example": "/v1/schemas"
10414
10897
  }
10415
10898
  }
10416
10899
  },
@@ -10470,7 +10953,8 @@
10470
10953
  },
10471
10954
  "id": {
10472
10955
  "type": "string",
10473
- "format": "uuid"
10956
+ "format": "uuid",
10957
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10474
10958
  }
10475
10959
  }
10476
10960
  },
@@ -10486,17 +10970,19 @@
10486
10970
  "properties": {
10487
10971
  "extraction_id": {
10488
10972
  "type": "string",
10489
- "format": "uuid"
10973
+ "format": "uuid",
10974
+ "example": "d1a2b3c4-5678-9abc-def0-1234567890ab"
10490
10975
  },
10491
10976
  "request_id": {
10492
10977
  "type": "string",
10493
- "format": "uuid"
10978
+ "example": "req_x7y8z9a0b1c2d3e4"
10494
10979
  },
10495
10980
  "status": {
10496
10981
  "type": "string",
10497
10982
  "enum": [
10498
10983
  "complete"
10499
- ]
10984
+ ],
10985
+ "example": "complete"
10500
10986
  },
10501
10987
  "document": {
10502
10988
  "$ref": "#/components/schemas/ExtractDocumentSummary"
@@ -10523,7 +11009,8 @@
10523
11009
  "string",
10524
11010
  "null"
10525
11011
  ],
10526
- "format": "uuid"
11012
+ "format": "uuid",
11013
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10527
11014
  },
10528
11015
  "definition": {
10529
11016
  "type": "object",
@@ -10608,10 +11095,12 @@
10608
11095
  "properties": {
10609
11096
  "request_id": {
10610
11097
  "type": "string",
10611
- "format": "uuid"
11098
+ "format": "uuid",
11099
+ "example": "req_x7y8z9a0b1c2d3e4"
10612
11100
  },
10613
11101
  "status": {
10614
11102
  "type": "string",
11103
+ "example": "completed",
10615
11104
  "enum": [
10616
11105
  "processing"
10617
11106
  ]
@@ -10626,10 +11115,12 @@
10626
11115
  "properties": {
10627
11116
  "id": {
10628
11117
  "type": "string",
10629
- "format": "uuid"
11118
+ "format": "uuid",
11119
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10630
11120
  },
10631
11121
  "status": {
10632
11122
  "type": "string",
11123
+ "example": "completed",
10633
11124
  "enum": [
10634
11125
  "queued"
10635
11126
  ]
@@ -10651,10 +11142,12 @@
10651
11142
  "properties": {
10652
11143
  "id": {
10653
11144
  "type": "string",
10654
- "format": "uuid"
11145
+ "format": "uuid",
11146
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10655
11147
  },
10656
11148
  "filename": {
10657
- "type": "string"
11149
+ "type": "string",
11150
+ "example": "invoice-042.pdf"
10658
11151
  },
10659
11152
  "pages": {
10660
11153
  "type": "integer"
@@ -10677,7 +11170,8 @@
10677
11170
  "properties": {
10678
11171
  "id": {
10679
11172
  "type": "string",
10680
- "format": "uuid"
11173
+ "format": "uuid",
11174
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10681
11175
  },
10682
11176
  "filename": {
10683
11177
  "type": "string",
@@ -10719,7 +11213,8 @@
10719
11213
  "properties": {
10720
11214
  "id": {
10721
11215
  "type": "string",
10722
- "format": "uuid"
11216
+ "format": "uuid",
11217
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10723
11218
  },
10724
11219
  "filename": {
10725
11220
  "type": "string",
@@ -10753,6 +11248,7 @@
10753
11248
  },
10754
11249
  "status": {
10755
11250
  "type": "string",
11251
+ "example": "completed",
10756
11252
  "enum": [
10757
11253
  "pending",
10758
11254
  "processing",
@@ -10768,7 +11264,8 @@
10768
11264
  "string",
10769
11265
  "null"
10770
11266
  ],
10771
- "format": "uuid"
11267
+ "format": "uuid",
11268
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10772
11269
  },
10773
11270
  "type": {
10774
11271
  "type": "string",
@@ -10785,11 +11282,13 @@
10785
11282
  "string",
10786
11283
  "null"
10787
11284
  ],
10788
- "format": "uuid"
11285
+ "format": "uuid",
11286
+ "example": "d1a2b3c4-5678-9abc-def0-1234567890ab"
10789
11287
  },
10790
11288
  "created_at": {
10791
11289
  "type": "string",
10792
- "format": "date-time"
11290
+ "format": "date-time",
11291
+ "example": "2026-04-25T14:30:00.000Z"
10793
11292
  },
10794
11293
  "links": {
10795
11294
  "type": "object",
@@ -10813,10 +11312,12 @@
10813
11312
  "properties": {
10814
11313
  "id": {
10815
11314
  "type": "string",
10816
- "format": "uuid"
11315
+ "format": "uuid",
11316
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10817
11317
  },
10818
11318
  "status": {
10819
11319
  "type": "string",
11320
+ "example": "completed",
10820
11321
  "enum": [
10821
11322
  "complete",
10822
11323
  "failed",
@@ -10825,10 +11326,12 @@
10825
11326
  },
10826
11327
  "document_id": {
10827
11328
  "type": "string",
10828
- "format": "uuid"
11329
+ "format": "uuid",
11330
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
10829
11331
  },
10830
11332
  "document_filename": {
10831
- "type": "string"
11333
+ "type": "string",
11334
+ "example": "invoice-042.pdf"
10832
11335
  },
10833
11336
  "confidence_overall": {
10834
11337
  "type": "number",
@@ -10836,7 +11339,8 @@
10836
11339
  },
10837
11340
  "created_at": {
10838
11341
  "type": "string",
10839
- "format": "date-time"
11342
+ "format": "date-time",
11343
+ "example": "2026-04-25T14:30:00.000Z"
10840
11344
  },
10841
11345
  "links": {
10842
11346
  "type": "object",
@@ -10863,10 +11367,12 @@
10863
11367
  "properties": {
10864
11368
  "id": {
10865
11369
  "type": "string",
10866
- "format": "uuid"
11370
+ "format": "uuid",
11371
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10867
11372
  },
10868
11373
  "status": {
10869
11374
  "type": "string",
11375
+ "example": "completed",
10870
11376
  "enum": [
10871
11377
  "complete",
10872
11378
  "failed",
@@ -10878,10 +11384,12 @@
10878
11384
  "properties": {
10879
11385
  "id": {
10880
11386
  "type": "string",
10881
- "format": "uuid"
11387
+ "format": "uuid",
11388
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10882
11389
  },
10883
11390
  "filename": {
10884
- "type": "string"
11391
+ "type": "string",
11392
+ "example": "invoice-042.pdf"
10885
11393
  },
10886
11394
  "pages": {
10887
11395
  "type": "integer"
@@ -10934,13 +11442,15 @@
10934
11442
  "type": "integer"
10935
11443
  },
10936
11444
  "region": {
10937
- "type": "string"
11445
+ "type": "string",
11446
+ "example": "eu-west"
10938
11447
  }
10939
11448
  }
10940
11449
  },
10941
11450
  "created_at": {
10942
11451
  "type": "string",
10943
- "format": "date-time"
11452
+ "format": "date-time",
11453
+ "example": "2026-04-25T14:30:00.000Z"
10944
11454
  },
10945
11455
  "links": {
10946
11456
  "type": "object",
@@ -10972,7 +11482,8 @@
10972
11482
  "properties": {
10973
11483
  "id": {
10974
11484
  "type": "string",
10975
- "format": "uuid"
11485
+ "format": "uuid",
11486
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10976
11487
  },
10977
11488
  "name": {
10978
11489
  "type": "string",
@@ -11045,11 +11556,13 @@
11045
11556
  },
11046
11557
  "created_at": {
11047
11558
  "type": "string",
11048
- "format": "date-time"
11559
+ "format": "date-time",
11560
+ "example": "2026-04-25T14:30:00.000Z"
11049
11561
  },
11050
11562
  "updated_at": {
11051
11563
  "type": "string",
11052
- "format": "date-time"
11564
+ "format": "date-time",
11565
+ "example": "2026-04-25T14:30:00.000Z"
11053
11566
  },
11054
11567
  "links": {
11055
11568
  "type": "object",
@@ -11126,13 +11639,16 @@
11126
11639
  ],
11127
11640
  "properties": {
11128
11641
  "field_name": {
11129
- "type": "string"
11642
+ "type": "string",
11643
+ "example": "invoice_number"
11130
11644
  },
11131
11645
  "display_name": {
11132
- "type": "string"
11646
+ "type": "string",
11647
+ "example": "Invoice Number"
11133
11648
  },
11134
11649
  "data_type": {
11135
- "type": "string"
11650
+ "type": "string",
11651
+ "example": "string"
11136
11652
  },
11137
11653
  "description": {
11138
11654
  "type": "string"
@@ -11196,13 +11712,16 @@
11196
11712
  ],
11197
11713
  "properties": {
11198
11714
  "field_name": {
11199
- "type": "string"
11715
+ "type": "string",
11716
+ "example": "invoice_number"
11200
11717
  },
11201
11718
  "display_name": {
11202
- "type": "string"
11719
+ "type": "string",
11720
+ "example": "Invoice Number"
11203
11721
  },
11204
11722
  "data_type": {
11205
- "type": "string"
11723
+ "type": "string",
11724
+ "example": "string"
11206
11725
  },
11207
11726
  "description": {
11208
11727
  "type": "string"
@@ -11224,7 +11743,8 @@
11224
11743
  "properties": {
11225
11744
  "id": {
11226
11745
  "type": "string",
11227
- "format": "uuid"
11746
+ "format": "uuid",
11747
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11228
11748
  },
11229
11749
  "name": {
11230
11750
  "type": [
@@ -11235,6 +11755,7 @@
11235
11755
  },
11236
11756
  "status": {
11237
11757
  "type": "string",
11758
+ "example": "completed",
11238
11759
  "enum": [
11239
11760
  "pending",
11240
11761
  "queued",
@@ -11265,7 +11786,8 @@
11265
11786
  "properties": {
11266
11787
  "id": {
11267
11788
  "type": "string",
11268
- "format": "uuid"
11789
+ "format": "uuid",
11790
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11269
11791
  },
11270
11792
  "name": {
11271
11793
  "type": "string"
@@ -11336,27 +11858,31 @@
11336
11858
  "type": "string"
11337
11859
  },
11338
11860
  "message": {
11339
- "type": "string"
11861
+ "type": "string",
11862
+ "example": "Re-extraction started."
11340
11863
  }
11341
11864
  }
11342
11865
  },
11343
11866
  "created_at": {
11344
11867
  "type": "string",
11345
- "format": "date-time"
11868
+ "format": "date-time",
11869
+ "example": "2026-04-25T14:30:00.000Z"
11346
11870
  },
11347
11871
  "started_at": {
11348
11872
  "type": [
11349
11873
  "string",
11350
11874
  "null"
11351
11875
  ],
11352
- "format": "date-time"
11876
+ "format": "date-time",
11877
+ "example": "2026-04-25T14:30:00.000Z"
11353
11878
  },
11354
11879
  "completed_at": {
11355
11880
  "type": [
11356
11881
  "string",
11357
11882
  "null"
11358
11883
  ],
11359
- "format": "date-time"
11884
+ "format": "date-time",
11885
+ "example": "2026-04-25T14:30:00.000Z"
11360
11886
  },
11361
11887
  "links": {
11362
11888
  "type": "object",
@@ -11387,7 +11913,8 @@
11387
11913
  "properties": {
11388
11914
  "id": {
11389
11915
  "type": "string",
11390
- "format": "uuid"
11916
+ "format": "uuid",
11917
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11391
11918
  },
11392
11919
  "name": {
11393
11920
  "type": "string",
@@ -11399,12 +11926,12 @@
11399
11926
  },
11400
11927
  "status": {
11401
11928
  "type": "string",
11929
+ "example": "completed",
11402
11930
  "enum": [
11403
11931
  "active",
11404
11932
  "syncing",
11405
11933
  "error"
11406
- ],
11407
- "example": "active"
11934
+ ]
11408
11935
  },
11409
11936
  "document_count": {
11410
11937
  "type": "integer",
@@ -11418,7 +11945,8 @@
11418
11945
  "properties": {
11419
11946
  "id": {
11420
11947
  "type": "string",
11421
- "format": "uuid"
11948
+ "format": "uuid",
11949
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11422
11950
  }
11423
11951
  }
11424
11952
  },
@@ -11429,7 +11957,8 @@
11429
11957
  },
11430
11958
  "created_at": {
11431
11959
  "type": "string",
11432
- "format": "date-time"
11960
+ "format": "date-time",
11961
+ "example": "2026-04-25T14:30:00.000Z"
11433
11962
  },
11434
11963
  "links": {
11435
11964
  "type": "object",
@@ -11462,6 +11991,7 @@
11462
11991
  "default_schema_id": {
11463
11992
  "type": "string",
11464
11993
  "format": "uuid",
11994
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
11465
11995
  "description": "Optional schema ID to apply by default to documents in this source."
11466
11996
  }
11467
11997
  }
@@ -11478,6 +12008,7 @@
11478
12008
  "null"
11479
12009
  ],
11480
12010
  "format": "uuid",
12011
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
11481
12012
  "description": "Set to null to remove the default schema."
11482
12013
  }
11483
12014
  }
@@ -11488,13 +12019,16 @@
11488
12019
  "document_id": {
11489
12020
  "type": "string",
11490
12021
  "format": "uuid",
12022
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543",
11491
12023
  "description": "ID of the created document (absent if duplicate)."
11492
12024
  },
11493
12025
  "filename": {
11494
- "type": "string"
12026
+ "type": "string",
12027
+ "example": "invoice-042.pdf"
11495
12028
  },
11496
12029
  "status": {
11497
12030
  "type": "string",
12031
+ "example": "completed",
11498
12032
  "enum": [
11499
12033
  "queued",
11500
12034
  "duplicate"
@@ -11503,10 +12037,12 @@
11503
12037
  },
11504
12038
  "source_id": {
11505
12039
  "type": "string",
11506
- "format": "uuid"
12040
+ "format": "uuid",
12041
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11507
12042
  },
11508
12043
  "message": {
11509
12044
  "type": "string",
12045
+ "example": "Re-extraction started.",
11510
12046
  "description": "Present when status is `duplicate`."
11511
12047
  },
11512
12048
  "existing_document_id": {
@@ -11515,6 +12051,7 @@
11515
12051
  "null"
11516
12052
  ],
11517
12053
  "format": "uuid",
12054
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
11518
12055
  "description": "Present when status is `duplicate`."
11519
12056
  },
11520
12057
  "links": {
@@ -11535,13 +12072,16 @@
11535
12072
  "properties": {
11536
12073
  "id": {
11537
12074
  "type": "string",
11538
- "format": "uuid"
12075
+ "format": "uuid",
12076
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11539
12077
  },
11540
12078
  "filename": {
11541
- "type": "string"
12079
+ "type": "string",
12080
+ "example": "invoice-042.pdf"
11542
12081
  },
11543
12082
  "status": {
11544
12083
  "type": "string",
12084
+ "example": "completed",
11545
12085
  "enum": [
11546
12086
  "pending",
11547
12087
  "processing",
@@ -11560,7 +12100,8 @@
11560
12100
  },
11561
12101
  "created_at": {
11562
12102
  "type": "string",
11563
- "format": "date-time"
12103
+ "format": "date-time",
12104
+ "example": "2026-04-25T14:30:00.000Z"
11564
12105
  },
11565
12106
  "links": {
11566
12107
  "type": "object",
@@ -11581,15 +12122,16 @@
11581
12122
  "schema_id": {
11582
12123
  "type": "string",
11583
12124
  "format": "uuid",
11584
- "description": "User schema UUID to run this job against.",
11585
- "example": "ae4b0e25-12c4-4db0-9d21-f2d6c9c2d4c1"
12125
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
12126
+ "description": "User schema UUID to run this job against."
11586
12127
  },
11587
12128
  "document_ids": {
11588
12129
  "type": "array",
11589
12130
  "description": "Optional list of document UUIDs to process. If omitted or empty, all\ncompleted documents for the authenticated customer are used.\n",
11590
12131
  "items": {
11591
12132
  "type": "string",
11592
- "format": "uuid"
12133
+ "format": "uuid",
12134
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11593
12135
  }
11594
12136
  },
11595
12137
  "name": {
@@ -11614,10 +12156,12 @@
11614
12156
  "id": {
11615
12157
  "type": "string",
11616
12158
  "format": "uuid",
12159
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
11617
12160
  "description": "The newly created job's UUID."
11618
12161
  },
11619
12162
  "status": {
11620
12163
  "type": "string",
12164
+ "example": "completed",
11621
12165
  "enum": [
11622
12166
  "pending"
11623
12167
  ],
@@ -11653,7 +12197,8 @@
11653
12197
  "properties": {
11654
12198
  "job_id": {
11655
12199
  "type": "string",
11656
- "format": "uuid"
12200
+ "format": "uuid",
12201
+ "example": "c3d4e5f6-a7b8-9012-cdef-123456789012"
11657
12202
  },
11658
12203
  "job_status": {
11659
12204
  "type": "string",
@@ -11674,7 +12219,8 @@
11674
12219
  "properties": {
11675
12220
  "id": {
11676
12221
  "type": "string",
11677
- "format": "uuid"
12222
+ "format": "uuid",
12223
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11678
12224
  },
11679
12225
  "name": {
11680
12226
  "type": "string"
@@ -11695,17 +12241,21 @@
11695
12241
  "id": {
11696
12242
  "type": "string",
11697
12243
  "format": "uuid",
12244
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
11698
12245
  "description": "The result row's UUID."
11699
12246
  },
11700
12247
  "document_id": {
11701
12248
  "type": "string",
11702
- "format": "uuid"
12249
+ "format": "uuid",
12250
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
11703
12251
  },
11704
12252
  "filename": {
11705
- "type": "string"
12253
+ "type": "string",
12254
+ "example": "invoice-042.pdf"
11706
12255
  },
11707
12256
  "status": {
11708
12257
  "type": "string",
12258
+ "example": "completed",
11709
12259
  "description": "Per-row status (e.g. `complete`, `partial`, `failed`)."
11710
12260
  },
11711
12261
  "values": {
@@ -11754,7 +12304,8 @@
11754
12304
  "properties": {
11755
12305
  "id": {
11756
12306
  "type": "string",
11757
- "format": "uuid"
12307
+ "format": "uuid",
12308
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11758
12309
  },
11759
12310
  "name": {
11760
12311
  "type": "string",
@@ -11770,14 +12321,16 @@
11770
12321
  },
11771
12322
  "created_at": {
11772
12323
  "type": "string",
11773
- "format": "date-time"
12324
+ "format": "date-time",
12325
+ "example": "2026-04-25T14:30:00.000Z"
11774
12326
  },
11775
12327
  "updated_at": {
11776
12328
  "type": [
11777
12329
  "string",
11778
12330
  "null"
11779
12331
  ],
11780
- "format": "date-time"
12332
+ "format": "date-time",
12333
+ "example": "2026-04-25T14:30:00.000Z"
11781
12334
  },
11782
12335
  "links": {
11783
12336
  "type": "object",
@@ -11928,14 +12481,14 @@
11928
12481
  },
11929
12482
  "match_type": {
11930
12483
  "type": "string",
12484
+ "example": "exact",
11931
12485
  "enum": [
11932
12486
  "exact",
11933
12487
  "fuzzy",
11934
12488
  "date_range",
11935
12489
  "numeric_range"
11936
12490
  ],
11937
- "description": "Matching strategy applied to this pair.",
11938
- "example": "fuzzy"
12491
+ "description": "Matching strategy applied to this pair."
11939
12492
  },
11940
12493
  "weight": {
11941
12494
  "type": "number",
@@ -11958,7 +12511,8 @@
11958
12511
  "properties": {
11959
12512
  "id": {
11960
12513
  "type": "string",
11961
- "format": "uuid"
12514
+ "format": "uuid",
12515
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11962
12516
  },
11963
12517
  "name": {
11964
12518
  "type": "string",
@@ -11966,7 +12520,8 @@
11966
12520
  },
11967
12521
  "reference_data_id": {
11968
12522
  "type": "string",
11969
- "format": "uuid"
12523
+ "format": "uuid",
12524
+ "example": "b8c9d0e1-f2a3-4567-bcde-678901234567"
11970
12525
  },
11971
12526
  "target_type": {
11972
12527
  "type": "string",
@@ -11998,14 +12553,16 @@
11998
12553
  },
11999
12554
  "created_at": {
12000
12555
  "type": "string",
12001
- "format": "date-time"
12556
+ "format": "date-time",
12557
+ "example": "2026-04-25T14:30:00.000Z"
12002
12558
  },
12003
12559
  "updated_at": {
12004
12560
  "type": [
12005
12561
  "string",
12006
12562
  "null"
12007
12563
  ],
12008
- "format": "date-time"
12564
+ "format": "date-time",
12565
+ "example": "2026-04-25T14:30:00.000Z"
12009
12566
  },
12010
12567
  "links": {
12011
12568
  "type": "object",
@@ -12035,6 +12592,7 @@
12035
12592
  "reference_data_id": {
12036
12593
  "type": "string",
12037
12594
  "format": "uuid",
12595
+ "example": "b8c9d0e1-f2a3-4567-bcde-678901234567",
12038
12596
  "description": "UUID of the reference dataset to match against."
12039
12597
  },
12040
12598
  "field_mappings": {
@@ -12112,14 +12670,17 @@
12112
12670
  "properties": {
12113
12671
  "id": {
12114
12672
  "type": "string",
12115
- "format": "uuid"
12673
+ "format": "uuid",
12674
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12116
12675
  },
12117
12676
  "matching_config_id": {
12118
12677
  "type": "string",
12119
- "format": "uuid"
12678
+ "format": "uuid",
12679
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12120
12680
  },
12121
12681
  "status": {
12122
12682
  "type": "string",
12683
+ "example": "completed",
12123
12684
  "enum": [
12124
12685
  "queued",
12125
12686
  "running",
@@ -12156,14 +12717,16 @@
12156
12717
  "string",
12157
12718
  "null"
12158
12719
  ],
12159
- "format": "date-time"
12720
+ "format": "date-time",
12721
+ "example": "2026-04-25T14:30:00.000Z"
12160
12722
  },
12161
12723
  "completed_at": {
12162
12724
  "type": [
12163
12725
  "string",
12164
12726
  "null"
12165
12727
  ],
12166
- "format": "date-time"
12728
+ "format": "date-time",
12729
+ "example": "2026-04-25T14:30:00.000Z"
12167
12730
  },
12168
12731
  "error": {
12169
12732
  "type": [
@@ -12173,7 +12736,8 @@
12173
12736
  },
12174
12737
  "created_at": {
12175
12738
  "type": "string",
12176
- "format": "date-time"
12739
+ "format": "date-time",
12740
+ "example": "2026-04-25T14:30:00.000Z"
12177
12741
  },
12178
12742
  "links": {
12179
12743
  "type": "object",
@@ -12212,11 +12776,13 @@
12212
12776
  "properties": {
12213
12777
  "id": {
12214
12778
  "type": "string",
12215
- "format": "uuid"
12779
+ "format": "uuid",
12780
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12216
12781
  },
12217
12782
  "document_id": {
12218
12783
  "type": "string",
12219
- "format": "uuid"
12784
+ "format": "uuid",
12785
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
12220
12786
  },
12221
12787
  "document_filename": {
12222
12788
  "type": [
@@ -12229,7 +12795,8 @@
12229
12795
  "string",
12230
12796
  "null"
12231
12797
  ],
12232
- "format": "uuid"
12798
+ "format": "uuid",
12799
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12233
12800
  },
12234
12801
  "confidence": {
12235
12802
  "type": "number",
@@ -12239,6 +12806,7 @@
12239
12806
  },
12240
12807
  "status": {
12241
12808
  "type": "string",
12809
+ "example": "completed",
12242
12810
  "description": "Per-result status (e.g. `auto_accepted`, `needs_review`, `no_match`)."
12243
12811
  },
12244
12812
  "evidence": {
@@ -12261,15 +12829,16 @@
12261
12829
  "properties": {
12262
12830
  "id": {
12263
12831
  "type": "string",
12264
- "format": "uuid"
12832
+ "format": "uuid",
12833
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12265
12834
  },
12266
12835
  "name": {
12267
12836
  "type": "string"
12268
12837
  },
12269
12838
  "trigger_type": {
12270
12839
  "type": "string",
12271
- "description": "Trigger kind. Always `document_classified` for rules created via this API.",
12272
- "example": "document_classified"
12840
+ "example": "document_classified",
12841
+ "description": "Trigger kind. Always `document_classified` for rules created via this API."
12273
12842
  },
12274
12843
  "conditions": {
12275
12844
  "type": "object",
@@ -12278,8 +12847,8 @@
12278
12847
  },
12279
12848
  "action_type": {
12280
12849
  "type": "string",
12281
- "description": "Resolved action kind. Defaults to `route_to_schema` when not specified on the request body.",
12282
- "example": "route_to_schema"
12850
+ "example": "route_to_schema",
12851
+ "description": "Resolved action kind. Defaults to `route_to_schema` when not specified on the request body."
12283
12852
  },
12284
12853
  "actions": {
12285
12854
  "type": "object",
@@ -12305,18 +12874,21 @@
12305
12874
  "string",
12306
12875
  "null"
12307
12876
  ],
12308
- "format": "uuid"
12877
+ "format": "uuid",
12878
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12309
12879
  },
12310
12880
  "created_at": {
12311
12881
  "type": "string",
12312
- "format": "date-time"
12882
+ "format": "date-time",
12883
+ "example": "2026-04-25T14:30:00.000Z"
12313
12884
  },
12314
12885
  "updated_at": {
12315
12886
  "type": [
12316
12887
  "string",
12317
12888
  "null"
12318
12889
  ],
12319
- "format": "date-time"
12890
+ "format": "date-time",
12891
+ "example": "2026-04-25T14:30:00.000Z"
12320
12892
  },
12321
12893
  "links": {
12322
12894
  "type": "object",
@@ -12403,11 +12975,13 @@
12403
12975
  "properties": {
12404
12976
  "id": {
12405
12977
  "type": "string",
12406
- "format": "uuid"
12978
+ "format": "uuid",
12979
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12407
12980
  },
12408
12981
  "customer_id": {
12409
12982
  "type": "string",
12410
- "format": "uuid"
12983
+ "format": "uuid",
12984
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12411
12985
  },
12412
12986
  "name": {
12413
12987
  "type": "string",
@@ -12446,7 +13020,8 @@
12446
13020
  "string",
12447
13021
  "null"
12448
13022
  ],
12449
- "format": "date-time"
13023
+ "format": "date-time",
13024
+ "example": "2026-04-25T14:30:00.000Z"
12450
13025
  },
12451
13026
  "last_delivery_status": {
12452
13027
  "type": [
@@ -12456,11 +13031,13 @@
12456
13031
  },
12457
13032
  "created_at": {
12458
13033
  "type": "string",
12459
- "format": "date-time"
13034
+ "format": "date-time",
13035
+ "example": "2026-04-25T14:30:00.000Z"
12460
13036
  },
12461
13037
  "updated_at": {
12462
13038
  "type": "string",
12463
- "format": "date-time"
13039
+ "format": "date-time",
13040
+ "example": "2026-04-25T14:30:00.000Z"
12464
13041
  }
12465
13042
  }
12466
13043
  },
@@ -12687,11 +13264,13 @@
12687
13264
  "properties": {
12688
13265
  "id": {
12689
13266
  "type": "string",
12690
- "format": "uuid"
13267
+ "format": "uuid",
13268
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12691
13269
  },
12692
13270
  "customer_id": {
12693
13271
  "type": "string",
12694
- "format": "uuid"
13272
+ "format": "uuid",
13273
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12695
13274
  },
12696
13275
  "name": {
12697
13276
  "type": "string"
@@ -12705,7 +13284,8 @@
12705
13284
  },
12706
13285
  "destination_id": {
12707
13286
  "type": "string",
12708
- "format": "uuid"
13287
+ "format": "uuid",
13288
+ "example": "e1f2a3b4-c5d6-7890-efab-901234567890"
12709
13289
  },
12710
13290
  "field_map": {
12711
13291
  "$ref": "#/components/schemas/FieldMap"
@@ -12732,11 +13312,13 @@
12732
13312
  },
12733
13313
  "created_at": {
12734
13314
  "type": "string",
12735
- "format": "date-time"
13315
+ "format": "date-time",
13316
+ "example": "2026-04-25T14:30:00.000Z"
12736
13317
  },
12737
13318
  "updated_at": {
12738
13319
  "type": "string",
12739
- "format": "date-time"
13320
+ "format": "date-time",
13321
+ "example": "2026-04-25T14:30:00.000Z"
12740
13322
  }
12741
13323
  }
12742
13324
  },
@@ -12761,7 +13343,8 @@
12761
13343
  },
12762
13344
  "destination_id": {
12763
13345
  "type": "string",
12764
- "format": "uuid"
13346
+ "format": "uuid",
13347
+ "example": "e1f2a3b4-c5d6-7890-efab-901234567890"
12765
13348
  },
12766
13349
  "field_map": {
12767
13350
  "$ref": "#/components/schemas/FieldMap"
@@ -12796,7 +13379,8 @@
12796
13379
  },
12797
13380
  "destination_id": {
12798
13381
  "type": "string",
12799
- "format": "uuid"
13382
+ "format": "uuid",
13383
+ "example": "e1f2a3b4-c5d6-7890-efab-901234567890"
12800
13384
  },
12801
13385
  "field_map": {
12802
13386
  "$ref": "#/components/schemas/FieldMap"
@@ -12832,15 +13416,18 @@
12832
13416
  "properties": {
12833
13417
  "id": {
12834
13418
  "type": "string",
12835
- "format": "uuid"
13419
+ "format": "uuid",
13420
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12836
13421
  },
12837
13422
  "customer_id": {
12838
13423
  "type": "string",
12839
- "format": "uuid"
13424
+ "format": "uuid",
13425
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12840
13426
  },
12841
13427
  "binding_id": {
12842
13428
  "type": "string",
12843
- "format": "uuid"
13429
+ "format": "uuid",
13430
+ "example": "d0e1f2a3-b4c5-6789-defa-890123456789"
12844
13431
  },
12845
13432
  "event_id": {
12846
13433
  "type": "string",
@@ -12852,6 +13439,7 @@
12852
13439
  },
12853
13440
  "status": {
12854
13441
  "type": "string",
13442
+ "example": "completed",
12855
13443
  "enum": [
12856
13444
  "in_flight",
12857
13445
  "succeeded",
@@ -12903,11 +13491,13 @@
12903
13491
  "string",
12904
13492
  "null"
12905
13493
  ],
12906
- "format": "date-time"
13494
+ "format": "date-time",
13495
+ "example": "2026-04-25T14:30:00.000Z"
12907
13496
  },
12908
13497
  "created_at": {
12909
13498
  "type": "string",
12910
- "format": "date-time"
13499
+ "format": "date-time",
13500
+ "example": "2026-04-25T14:30:00.000Z"
12911
13501
  }
12912
13502
  }
12913
13503
  },
@@ -12926,15 +13516,18 @@
12926
13516
  "properties": {
12927
13517
  "id": {
12928
13518
  "type": "string",
12929
- "format": "uuid"
13519
+ "format": "uuid",
13520
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12930
13521
  },
12931
13522
  "customer_id": {
12932
13523
  "type": "string",
12933
- "format": "uuid"
13524
+ "format": "uuid",
13525
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12934
13526
  },
12935
13527
  "binding_id": {
12936
13528
  "type": "string",
12937
- "format": "uuid"
13529
+ "format": "uuid",
13530
+ "example": "d0e1f2a3-b4c5-6789-defa-890123456789"
12938
13531
  },
12939
13532
  "event_id": {
12940
13533
  "type": "string",
@@ -12946,10 +13539,12 @@
12946
13539
  "null"
12947
13540
  ],
12948
13541
  "format": "uuid",
13542
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
12949
13543
  "description": "FK to the last DeliveryItem attempt (nullable — `ON DELETE SET NULL`)."
12950
13544
  },
12951
13545
  "error_code": {
12952
- "type": "string"
13546
+ "type": "string",
13547
+ "example": "delivery_timeout"
12953
13548
  },
12954
13549
  "error_message": {
12955
13550
  "type": [
@@ -12962,7 +13557,8 @@
12962
13557
  },
12963
13558
  "created_at": {
12964
13559
  "type": "string",
12965
- "format": "date-time"
13560
+ "format": "date-time",
13561
+ "example": "2026-04-25T14:30:00.000Z"
12966
13562
  }
12967
13563
  }
12968
13564
  },
@@ -12984,7 +13580,8 @@
12984
13580
  },
12985
13581
  "customer_id": {
12986
13582
  "type": "string",
12987
- "format": "uuid"
13583
+ "format": "uuid",
13584
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12988
13585
  },
12989
13586
  "event_type": {
12990
13587
  "type": "string"
@@ -13002,14 +13599,16 @@
13002
13599
  },
13003
13600
  "created_at": {
13004
13601
  "type": "string",
13005
- "format": "date-time"
13602
+ "format": "date-time",
13603
+ "example": "2026-04-25T14:30:00.000Z"
13006
13604
  },
13007
13605
  "processed_at": {
13008
13606
  "type": [
13009
13607
  "string",
13010
13608
  "null"
13011
13609
  ],
13012
- "format": "date-time"
13610
+ "format": "date-time",
13611
+ "example": "2026-04-25T14:30:00.000Z"
13013
13612
  },
13014
13613
  "processing_attempts": {
13015
13614
  "type": "integer"
@@ -13046,6 +13645,7 @@
13046
13645
  },
13047
13646
  "label": {
13048
13647
  "type": "string",
13648
+ "example": "Customer Onboarding",
13049
13649
  "description": "Short human-readable label, e.g. \"Document markdown content\". Falls back to `type` if unknown."
13050
13650
  },
13051
13651
  "description": {
@@ -13852,6 +14452,7 @@
13852
14452
  "source_id": {
13853
14453
  "type": "string",
13854
14454
  "format": "uuid",
14455
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
13855
14456
  "description": "Optional source connection UUID to narrow the result set."
13856
14457
  },
13857
14458
  "conditions": {
@@ -13960,31 +14561,36 @@
13960
14561
  "properties": {
13961
14562
  "id": {
13962
14563
  "type": "string",
13963
- "format": "uuid"
14564
+ "format": "uuid",
14565
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
13964
14566
  },
13965
14567
  "run_id": {
13966
14568
  "type": [
13967
14569
  "string",
13968
14570
  "null"
13969
14571
  ],
13970
- "format": "uuid"
14572
+ "format": "uuid",
14573
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
13971
14574
  },
13972
14575
  "document_id": {
13973
14576
  "type": [
13974
14577
  "string",
13975
14578
  "null"
13976
14579
  ],
13977
- "format": "uuid"
14580
+ "format": "uuid",
14581
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
13978
14582
  },
13979
14583
  "schema_id": {
13980
14584
  "type": [
13981
14585
  "string",
13982
14586
  "null"
13983
14587
  ],
13984
- "format": "uuid"
14588
+ "format": "uuid",
14589
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
13985
14590
  },
13986
14591
  "status": {
13987
14592
  "type": "string",
14593
+ "example": "completed",
13988
14594
  "description": "Review status (e.g. `pending`, `approved`, `rejected`)."
13989
14595
  },
13990
14596
  "overall_confidence": {
@@ -14013,11 +14619,13 @@
14013
14619
  "string",
14014
14620
  "null"
14015
14621
  ],
14016
- "format": "date-time"
14622
+ "format": "date-time",
14623
+ "example": "2026-04-25T14:30:00.000Z"
14017
14624
  },
14018
14625
  "created_at": {
14019
14626
  "type": "string",
14020
- "format": "date-time"
14627
+ "format": "date-time",
14628
+ "example": "2026-04-25T14:30:00.000Z"
14021
14629
  },
14022
14630
  "links": {
14023
14631
  "type": "object",
@@ -14095,7 +14703,8 @@
14095
14703
  "description": "Non-empty list of validation-record UUIDs.",
14096
14704
  "items": {
14097
14705
  "type": "string",
14098
- "format": "uuid"
14706
+ "format": "uuid",
14707
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14099
14708
  }
14100
14709
  },
14101
14710
  "action": {
@@ -14135,10 +14744,12 @@
14135
14744
  "properties": {
14136
14745
  "id": {
14137
14746
  "type": "string",
14138
- "format": "uuid"
14747
+ "format": "uuid",
14748
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14139
14749
  },
14140
14750
  "status": {
14141
14751
  "type": "string",
14752
+ "example": "completed",
14142
14753
  "description": "Per-record outcome (`approved`, `rejected`, or `error`)."
14143
14754
  },
14144
14755
  "error": {
@@ -14159,7 +14770,8 @@
14159
14770
  "properties": {
14160
14771
  "id": {
14161
14772
  "type": "string",
14162
- "format": "uuid"
14773
+ "format": "uuid",
14774
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14163
14775
  },
14164
14776
  "name": {
14165
14777
  "type": "string"
@@ -14175,7 +14787,8 @@
14175
14787
  "string",
14176
14788
  "null"
14177
14789
  ],
14178
- "format": "uuid"
14790
+ "format": "uuid",
14791
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
14179
14792
  },
14180
14793
  "document_count": {
14181
14794
  "type": [
@@ -14185,7 +14798,8 @@
14185
14798
  },
14186
14799
  "created_at": {
14187
14800
  "type": "string",
14188
- "format": "date-time"
14801
+ "format": "date-time",
14802
+ "example": "2026-04-25T14:30:00.000Z"
14189
14803
  },
14190
14804
  "links": {
14191
14805
  "type": "object",
@@ -14236,14 +14850,16 @@
14236
14850
  "properties": {
14237
14851
  "id": {
14238
14852
  "type": "string",
14239
- "format": "uuid"
14853
+ "format": "uuid",
14854
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14240
14855
  },
14241
14856
  "document_id": {
14242
14857
  "type": [
14243
14858
  "string",
14244
14859
  "null"
14245
14860
  ],
14246
- "format": "uuid"
14861
+ "format": "uuid",
14862
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
14247
14863
  },
14248
14864
  "expected_data": {
14249
14865
  "type": "object",
@@ -14258,7 +14874,8 @@
14258
14874
  },
14259
14875
  "created_at": {
14260
14876
  "type": "string",
14261
- "format": "date-time"
14877
+ "format": "date-time",
14878
+ "example": "2026-04-25T14:30:00.000Z"
14262
14879
  }
14263
14880
  }
14264
14881
  },
@@ -14271,7 +14888,8 @@
14271
14888
  "properties": {
14272
14889
  "id": {
14273
14890
  "type": "string",
14274
- "format": "uuid"
14891
+ "format": "uuid",
14892
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14275
14893
  },
14276
14894
  "name": {
14277
14895
  "type": [
@@ -14284,17 +14902,20 @@
14284
14902
  "string",
14285
14903
  "null"
14286
14904
  ],
14287
- "format": "uuid"
14905
+ "format": "uuid",
14906
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14288
14907
  },
14289
14908
  "user_schema_id": {
14290
14909
  "type": [
14291
14910
  "string",
14292
14911
  "null"
14293
14912
  ],
14294
- "format": "uuid"
14913
+ "format": "uuid",
14914
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
14295
14915
  },
14296
14916
  "status": {
14297
14917
  "type": "string",
14918
+ "example": "completed",
14298
14919
  "description": "Benchmark run status."
14299
14920
  },
14300
14921
  "accuracy_overall": {
@@ -14347,18 +14968,21 @@
14347
14968
  "string",
14348
14969
  "null"
14349
14970
  ],
14350
- "format": "uuid"
14971
+ "format": "uuid",
14972
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14351
14973
  },
14352
14974
  "created_at": {
14353
14975
  "type": "string",
14354
- "format": "date-time"
14976
+ "format": "date-time",
14977
+ "example": "2026-04-25T14:30:00.000Z"
14355
14978
  },
14356
14979
  "completed_at": {
14357
14980
  "type": [
14358
14981
  "string",
14359
14982
  "null"
14360
14983
  ],
14361
- "format": "date-time"
14984
+ "format": "date-time",
14985
+ "example": "2026-04-25T14:30:00.000Z"
14362
14986
  },
14363
14987
  "links": {
14364
14988
  "type": "object",
@@ -14396,21 +15020,24 @@
14396
15020
  "properties": {
14397
15021
  "id": {
14398
15022
  "type": "string",
14399
- "format": "uuid"
15023
+ "format": "uuid",
15024
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14400
15025
  },
14401
15026
  "document_id": {
14402
15027
  "type": [
14403
15028
  "string",
14404
15029
  "null"
14405
15030
  ],
14406
- "format": "uuid"
15031
+ "format": "uuid",
15032
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
14407
15033
  },
14408
15034
  "ground_truth_entry_id": {
14409
15035
  "type": [
14410
15036
  "string",
14411
15037
  "null"
14412
15038
  ],
14413
- "format": "uuid"
15039
+ "format": "uuid",
15040
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14414
15041
  },
14415
15042
  "accuracy": {
14416
15043
  "type": [
@@ -14428,7 +15055,8 @@
14428
15055
  },
14429
15056
  "created_at": {
14430
15057
  "type": "string",
14431
- "format": "date-time"
15058
+ "format": "date-time",
15059
+ "example": "2026-04-25T14:30:00.000Z"
14432
15060
  }
14433
15061
  }
14434
15062
  },
@@ -14448,10 +15076,12 @@
14448
15076
  "properties": {
14449
15077
  "id": {
14450
15078
  "type": "string",
14451
- "format": "uuid"
15079
+ "format": "uuid",
15080
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14452
15081
  },
14453
15082
  "status": {
14454
15083
  "type": "string",
15084
+ "example": "completed",
14455
15085
  "enum": [
14456
15086
  "accumulating",
14457
15087
  "submitted",
@@ -14463,6 +15093,7 @@
14463
15093
  },
14464
15094
  "provider": {
14465
15095
  "type": "string",
15096
+ "example": "anthropic",
14466
15097
  "enum": [
14467
15098
  "anthropic",
14468
15099
  "bedrock"
@@ -14485,14 +15116,16 @@
14485
15116
  "string",
14486
15117
  "null"
14487
15118
  ],
14488
- "format": "date-time"
15119
+ "format": "date-time",
15120
+ "example": "2026-04-25T14:30:00.000Z"
14489
15121
  },
14490
15122
  "completed_at": {
14491
15123
  "type": [
14492
15124
  "string",
14493
15125
  "null"
14494
15126
  ],
14495
- "format": "date-time"
15127
+ "format": "date-time",
15128
+ "example": "2026-04-25T14:30:00.000Z"
14496
15129
  },
14497
15130
  "error_message": {
14498
15131
  "type": [
@@ -14502,11 +15135,13 @@
14502
15135
  },
14503
15136
  "created_at": {
14504
15137
  "type": "string",
14505
- "format": "date-time"
15138
+ "format": "date-time",
15139
+ "example": "2026-04-25T14:30:00.000Z"
14506
15140
  },
14507
15141
  "updated_at": {
14508
15142
  "type": "string",
14509
- "format": "date-time"
15143
+ "format": "date-time",
15144
+ "example": "2026-04-25T14:30:00.000Z"
14510
15145
  },
14511
15146
  "links": {
14512
15147
  "type": "object",
@@ -14539,11 +15174,13 @@
14539
15174
  "properties": {
14540
15175
  "id": {
14541
15176
  "type": "string",
14542
- "format": "uuid"
15177
+ "format": "uuid",
15178
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14543
15179
  },
14544
15180
  "document_id": {
14545
15181
  "type": "string",
14546
- "format": "uuid"
15182
+ "format": "uuid",
15183
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
14547
15184
  },
14548
15185
  "document_filename": {
14549
15186
  "type": [
@@ -14558,7 +15195,8 @@
14558
15195
  ]
14559
15196
  },
14560
15197
  "status": {
14561
- "type": "string"
15198
+ "type": "string",
15199
+ "example": "completed"
14562
15200
  },
14563
15201
  "error_message": {
14564
15202
  "type": [
@@ -14568,14 +15206,16 @@
14568
15206
  },
14569
15207
  "created_at": {
14570
15208
  "type": "string",
14571
- "format": "date-time"
15209
+ "format": "date-time",
15210
+ "example": "2026-04-25T14:30:00.000Z"
14572
15211
  },
14573
15212
  "processed_at": {
14574
15213
  "type": [
14575
15214
  "string",
14576
15215
  "null"
14577
15216
  ],
14578
- "format": "date-time"
15217
+ "format": "date-time",
15218
+ "example": "2026-04-25T14:30:00.000Z"
14579
15219
  }
14580
15220
  }
14581
15221
  }
@@ -14600,6 +15240,7 @@
14600
15240
  },
14601
15241
  "case_key": {
14602
15242
  "type": "string",
15243
+ "example": "7a3f2b1c",
14603
15244
  "pattern": "^[a-fA-F0-9]{8,64}$"
14604
15245
  },
14605
15246
  "label": {
@@ -14616,7 +15257,8 @@
14616
15257
  "string",
14617
15258
  "null"
14618
15259
  ],
14619
- "format": "date-time"
15260
+ "format": "date-time",
15261
+ "example": "2026-04-25T14:30:00.000Z"
14620
15262
  },
14621
15263
  "links": {
14622
15264
  "type": "object",
@@ -14642,7 +15284,8 @@
14642
15284
  "type": "string"
14643
15285
  },
14644
15286
  "case_key": {
14645
- "type": "string"
15287
+ "type": "string",
15288
+ "example": "7a3f2b1c"
14646
15289
  },
14647
15290
  "label": {
14648
15291
  "type": [
@@ -14663,10 +15306,12 @@
14663
15306
  "properties": {
14664
15307
  "id": {
14665
15308
  "type": "string",
14666
- "format": "uuid"
15309
+ "format": "uuid",
15310
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14667
15311
  },
14668
15312
  "filename": {
14669
- "type": "string"
15313
+ "type": "string",
15314
+ "example": "invoice-042.pdf"
14670
15315
  },
14671
15316
  "document_type": {
14672
15317
  "type": [
@@ -14679,7 +15324,8 @@
14679
15324
  "string",
14680
15325
  "null"
14681
15326
  ],
14682
- "format": "date-time"
15327
+ "format": "date-time",
15328
+ "example": "2026-04-25T14:30:00.000Z"
14683
15329
  }
14684
15330
  }
14685
15331
  }
@@ -14692,7 +15338,8 @@
14692
15338
  "string",
14693
15339
  "null"
14694
15340
  ],
14695
- "format": "date-time"
15341
+ "format": "date-time",
15342
+ "example": "2026-04-25T14:30:00.000Z"
14696
15343
  },
14697
15344
  "links": {
14698
15345
  "type": "object",
@@ -14718,7 +15365,8 @@
14718
15365
  "properties": {
14719
15366
  "id": {
14720
15367
  "type": "string",
14721
- "format": "uuid"
15368
+ "format": "uuid",
15369
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14722
15370
  },
14723
15371
  "name": {
14724
15372
  "type": "string"
@@ -14762,10 +15410,12 @@
14762
15410
  "properties": {
14763
15411
  "id": {
14764
15412
  "type": "string",
14765
- "format": "uuid"
15413
+ "format": "uuid",
15414
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14766
15415
  },
14767
15416
  "canonical_name": {
14768
- "type": "string"
15417
+ "type": "string",
15418
+ "example": "invoice_number"
14769
15419
  },
14770
15420
  "display_name": {
14771
15421
  "type": [
@@ -14774,7 +15424,8 @@
14774
15424
  ]
14775
15425
  },
14776
15426
  "data_type": {
14777
- "type": "string"
15427
+ "type": "string",
15428
+ "example": "string"
14778
15429
  },
14779
15430
  "tier": {
14780
15431
  "type": "integer"
@@ -14796,11 +15447,13 @@
14796
15447
  },
14797
15448
  "created_at": {
14798
15449
  "type": "string",
14799
- "format": "date-time"
15450
+ "format": "date-time",
15451
+ "example": "2026-04-25T14:30:00.000Z"
14800
15452
  },
14801
15453
  "updated_at": {
14802
15454
  "type": "string",
14803
- "format": "date-time"
15455
+ "format": "date-time",
15456
+ "example": "2026-04-25T14:30:00.000Z"
14804
15457
  },
14805
15458
  "links": {
14806
15459
  "type": "object",
@@ -14831,11 +15484,13 @@
14831
15484
  "properties": {
14832
15485
  "id": {
14833
15486
  "type": "string",
14834
- "format": "uuid"
15487
+ "format": "uuid",
15488
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14835
15489
  },
14836
15490
  "document_id": {
14837
15491
  "type": "string",
14838
- "format": "uuid"
15492
+ "format": "uuid",
15493
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
14839
15494
  },
14840
15495
  "document_filename": {
14841
15496
  "type": [
@@ -14854,7 +15509,8 @@
14854
15509
  },
14855
15510
  "created_at": {
14856
15511
  "type": "string",
14857
- "format": "date-time"
15512
+ "format": "date-time",
15513
+ "example": "2026-04-25T14:30:00.000Z"
14858
15514
  }
14859
15515
  }
14860
15516
  }
@@ -14878,10 +15534,12 @@
14878
15534
  "properties": {
14879
15535
  "id": {
14880
15536
  "type": "string",
14881
- "format": "uuid"
15537
+ "format": "uuid",
15538
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14882
15539
  },
14883
15540
  "canonical_name": {
14884
- "type": "string"
15541
+ "type": "string",
15542
+ "example": "invoice_number"
14885
15543
  },
14886
15544
  "display_name": {
14887
15545
  "type": [
@@ -14890,7 +15548,8 @@
14890
15548
  ]
14891
15549
  },
14892
15550
  "data_type": {
14893
- "type": "string"
15551
+ "type": "string",
15552
+ "example": "string"
14894
15553
  },
14895
15554
  "tier": {
14896
15555
  "type": "integer"
@@ -14937,7 +15596,8 @@
14937
15596
  "properties": {
14938
15597
  "id": {
14939
15598
  "type": "string",
14940
- "format": "uuid"
15599
+ "format": "uuid",
15600
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14941
15601
  },
14942
15602
  "name": {
14943
15603
  "type": "string"
@@ -14954,7 +15614,8 @@
14954
15614
  },
14955
15615
  "created_at": {
14956
15616
  "type": "string",
14957
- "format": "date-time"
15617
+ "format": "date-time",
15618
+ "example": "2026-04-25T14:30:00.000Z"
14958
15619
  },
14959
15620
  "links": {
14960
15621
  "type": "object",
@@ -14987,11 +15648,13 @@
14987
15648
  "properties": {
14988
15649
  "from": {
14989
15650
  "type": "string",
14990
- "format": "date-time"
15651
+ "format": "date-time",
15652
+ "example": "2026-04-25T14:30:00.000Z"
14991
15653
  },
14992
15654
  "to": {
14993
15655
  "type": "string",
14994
- "format": "date-time"
15656
+ "format": "date-time",
15657
+ "example": "2026-04-25T14:30:00.000Z"
14995
15658
  }
14996
15659
  }
14997
15660
  },
@@ -15065,7 +15728,8 @@
15065
15728
  "properties": {
15066
15729
  "document_id": {
15067
15730
  "type": "string",
15068
- "format": "uuid"
15731
+ "format": "uuid",
15732
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
15069
15733
  },
15070
15734
  "totals": {
15071
15735
  "type": "object",
@@ -15131,7 +15795,8 @@
15131
15795
  },
15132
15796
  "created_at": {
15133
15797
  "type": "string",
15134
- "format": "date-time"
15798
+ "format": "date-time",
15799
+ "example": "2026-04-25T14:30:00.000Z"
15135
15800
  }
15136
15801
  }
15137
15802
  }
@@ -15160,14 +15825,17 @@
15160
15825
  "properties": {
15161
15826
  "id": {
15162
15827
  "type": "string",
15163
- "format": "uuid"
15828
+ "format": "uuid",
15829
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15164
15830
  },
15165
15831
  "source_run_id": {
15166
15832
  "type": "string",
15167
- "format": "uuid"
15833
+ "format": "uuid",
15834
+ "example": "f2a3b4c5-d6e7-8901-fabc-012345678901"
15168
15835
  },
15169
15836
  "status": {
15170
15837
  "type": "string",
15838
+ "example": "completed",
15171
15839
  "enum": [
15172
15840
  "pending",
15173
15841
  "running",
@@ -15183,14 +15851,16 @@
15183
15851
  },
15184
15852
  "created_at": {
15185
15853
  "type": "string",
15186
- "format": "date-time"
15854
+ "format": "date-time",
15855
+ "example": "2026-04-25T14:30:00.000Z"
15187
15856
  },
15188
15857
  "completed_at": {
15189
15858
  "type": [
15190
15859
  "string",
15191
15860
  "null"
15192
15861
  ],
15193
- "format": "date-time"
15862
+ "format": "date-time",
15863
+ "example": "2026-04-25T14:30:00.000Z"
15194
15864
  },
15195
15865
  "links": {
15196
15866
  "type": "object",
@@ -15213,10 +15883,12 @@
15213
15883
  ],
15214
15884
  "properties": {
15215
15885
  "field_name": {
15216
- "type": "string"
15886
+ "type": "string",
15887
+ "example": "invoice_number"
15217
15888
  },
15218
15889
  "category": {
15219
15890
  "type": "string",
15891
+ "example": "identity",
15220
15892
  "enum": [
15221
15893
  "identity",
15222
15894
  "transaction",
@@ -15248,7 +15920,8 @@
15248
15920
  "properties": {
15249
15921
  "id": {
15250
15922
  "type": "string",
15251
- "format": "uuid"
15923
+ "format": "uuid",
15924
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15252
15925
  },
15253
15926
  "name": {
15254
15927
  "type": "string"
@@ -15267,11 +15940,13 @@
15267
15940
  },
15268
15941
  "created_at": {
15269
15942
  "type": "string",
15270
- "format": "date-time"
15943
+ "format": "date-time",
15944
+ "example": "2026-04-25T14:30:00.000Z"
15271
15945
  },
15272
15946
  "updated_at": {
15273
15947
  "type": "string",
15274
- "format": "date-time"
15948
+ "format": "date-time",
15949
+ "example": "2026-04-25T14:30:00.000Z"
15275
15950
  },
15276
15951
  "links": {
15277
15952
  "type": "object",
@@ -15297,11 +15972,13 @@
15297
15972
  "properties": {
15298
15973
  "id": {
15299
15974
  "type": "string",
15300
- "format": "uuid"
15975
+ "format": "uuid",
15976
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15301
15977
  },
15302
15978
  "class_id": {
15303
15979
  "type": "string",
15304
- "format": "uuid"
15980
+ "format": "uuid",
15981
+ "example": "a7b8c9d0-e1f2-3456-abcd-567890123456"
15305
15982
  },
15306
15983
  "from_version": {
15307
15984
  "type": [
@@ -15317,6 +15994,7 @@
15317
15994
  },
15318
15995
  "status": {
15319
15996
  "type": "string",
15997
+ "example": "completed",
15320
15998
  "enum": [
15321
15999
  "pending",
15322
16000
  "approved",
@@ -15333,14 +16011,16 @@
15333
16011
  },
15334
16012
  "created_at": {
15335
16013
  "type": "string",
15336
- "format": "date-time"
16014
+ "format": "date-time",
16015
+ "example": "2026-04-25T14:30:00.000Z"
15337
16016
  },
15338
16017
  "decided_at": {
15339
16018
  "type": [
15340
16019
  "string",
15341
16020
  "null"
15342
16021
  ],
15343
- "format": "date-time"
16022
+ "format": "date-time",
16023
+ "example": "2026-04-25T14:30:00.000Z"
15344
16024
  }
15345
16025
  }
15346
16026
  },
@@ -15355,7 +16035,8 @@
15355
16035
  "properties": {
15356
16036
  "id": {
15357
16037
  "type": "string",
15358
- "format": "uuid"
16038
+ "format": "uuid",
16039
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15359
16040
  },
15360
16041
  "name": {
15361
16042
  "type": "string"
@@ -15379,11 +16060,13 @@
15379
16060
  },
15380
16061
  "created_at": {
15381
16062
  "type": "string",
15382
- "format": "date-time"
16063
+ "format": "date-time",
16064
+ "example": "2026-04-25T14:30:00.000Z"
15383
16065
  },
15384
16066
  "updated_at": {
15385
16067
  "type": "string",
15386
- "format": "date-time"
16068
+ "format": "date-time",
16069
+ "example": "2026-04-25T14:30:00.000Z"
15387
16070
  }
15388
16071
  }
15389
16072
  },
@@ -15425,7 +16108,8 @@
15425
16108
  "properties": {
15426
16109
  "id": {
15427
16110
  "type": "string",
15428
- "format": "uuid"
16111
+ "format": "uuid",
16112
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15429
16113
  },
15430
16114
  "name": {
15431
16115
  "type": "string"
@@ -15441,7 +16125,8 @@
15441
16125
  "string",
15442
16126
  "null"
15443
16127
  ],
15444
- "format": "uuid"
16128
+ "format": "uuid",
16129
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
15445
16130
  },
15446
16131
  "rules": {
15447
16132
  "type": "array",
@@ -15450,7 +16135,8 @@
15450
16135
  "properties": {
15451
16136
  "id": {
15452
16137
  "type": "string",
15453
- "format": "uuid"
16138
+ "format": "uuid",
16139
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15454
16140
  },
15455
16141
  "type": {
15456
16142
  "type": "string"
@@ -15464,11 +16150,13 @@
15464
16150
  },
15465
16151
  "created_at": {
15466
16152
  "type": "string",
15467
- "format": "date-time"
16153
+ "format": "date-time",
16154
+ "example": "2026-04-25T14:30:00.000Z"
15468
16155
  },
15469
16156
  "updated_at": {
15470
16157
  "type": "string",
15471
- "format": "date-time"
16158
+ "format": "date-time",
16159
+ "example": "2026-04-25T14:30:00.000Z"
15472
16160
  }
15473
16161
  }
15474
16162
  },
@@ -15486,7 +16174,8 @@
15486
16174
  },
15487
16175
  "schema_id": {
15488
16176
  "type": "string",
15489
- "format": "uuid"
16177
+ "format": "uuid",
16178
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
15490
16179
  }
15491
16180
  }
15492
16181
  },
@@ -15500,7 +16189,8 @@
15500
16189
  "properties": {
15501
16190
  "id": {
15502
16191
  "type": "string",
15503
- "format": "uuid"
16192
+ "format": "uuid",
16193
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15504
16194
  },
15505
16195
  "name": {
15506
16196
  "type": "string"
@@ -15519,7 +16209,8 @@
15519
16209
  },
15520
16210
  "created_at": {
15521
16211
  "type": "string",
15522
- "format": "date-time"
16212
+ "format": "date-time",
16213
+ "example": "2026-04-25T14:30:00.000Z"
15523
16214
  },
15524
16215
  "links": {
15525
16216
  "type": "object",
@@ -15541,21 +16232,25 @@
15541
16232
  "properties": {
15542
16233
  "id": {
15543
16234
  "type": "string",
15544
- "format": "uuid"
16235
+ "format": "uuid",
16236
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15545
16237
  },
15546
16238
  "golden_sample_id": {
15547
16239
  "type": "string",
15548
- "format": "uuid"
16240
+ "format": "uuid",
16241
+ "example": "e5f6a7b8-c9d0-1234-efab-345678901234"
15549
16242
  },
15550
16243
  "schema_id": {
15551
16244
  "type": [
15552
16245
  "string",
15553
16246
  "null"
15554
16247
  ],
15555
- "format": "uuid"
16248
+ "format": "uuid",
16249
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
15556
16250
  },
15557
16251
  "status": {
15558
16252
  "type": "string",
16253
+ "example": "completed",
15559
16254
  "enum": [
15560
16255
  "pending",
15561
16256
  "running",
@@ -15578,14 +16273,16 @@
15578
16273
  },
15579
16274
  "created_at": {
15580
16275
  "type": "string",
15581
- "format": "date-time"
16276
+ "format": "date-time",
16277
+ "example": "2026-04-25T14:30:00.000Z"
15582
16278
  },
15583
16279
  "completed_at": {
15584
16280
  "type": [
15585
16281
  "string",
15586
16282
  "null"
15587
16283
  ],
15588
- "format": "date-time"
16284
+ "format": "date-time",
16285
+ "example": "2026-04-25T14:30:00.000Z"
15589
16286
  },
15590
16287
  "links": {
15591
16288
  "type": "object",