@talonic/docs 0.10.0 → 0.11.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",
7
7
  "contact": {
8
8
  "name": "Talonic Support",
9
9
  "email": "support@talonic.ai",
@@ -171,6 +171,7 @@
171
171
  "document_id": {
172
172
  "type": "string",
173
173
  "format": "uuid",
174
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543",
174
175
  "description": "ID of an already-uploaded document to re-extract."
175
176
  },
176
177
  "schema": {
@@ -180,6 +181,7 @@
180
181
  "schema_id": {
181
182
  "type": "string",
182
183
  "format": "uuid",
184
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
183
185
  "description": "ID of a saved schema to use for extraction."
184
186
  },
185
187
  "instructions": {
@@ -232,6 +234,77 @@
232
234
  "application/json": {
233
235
  "schema": {
234
236
  "$ref": "#/components/schemas/ExtractSyncResponse"
237
+ },
238
+ "example": {
239
+ "extraction_id": "d1a2b3c4-5678-9abc-def0-1234567890ab",
240
+ "request_id": "req_x7y8z9a0b1c2d3e4",
241
+ "status": "complete",
242
+ "document": {
243
+ "id": "f0e1d2c3-b4a5-9687-8765-432109876543",
244
+ "filename": "invoice-042.pdf",
245
+ "pages": 3,
246
+ "size_bytes": 245760,
247
+ "type_detected": "Invoice",
248
+ "language_detected": "en"
249
+ },
250
+ "data": {
251
+ "invoice_number": "INV-2024-0042",
252
+ "invoice_date": "2024-03-15",
253
+ "vendor_name": "Acme Corp",
254
+ "total_amount": 1250,
255
+ "currency": "EUR",
256
+ "line_items": [
257
+ {
258
+ "description": "Consulting services",
259
+ "quantity": 10,
260
+ "unit_price": 100,
261
+ "amount": 1000
262
+ },
263
+ {
264
+ "description": "Expenses",
265
+ "quantity": 1,
266
+ "unit_price": 250,
267
+ "amount": 250
268
+ }
269
+ ]
270
+ },
271
+ "schema": {
272
+ "source": "inferred",
273
+ "id": null,
274
+ "definition": {
275
+ "type": "object",
276
+ "properties": {
277
+ "invoice_number": {
278
+ "type": "string"
279
+ },
280
+ "total_amount": {
281
+ "type": "number"
282
+ }
283
+ }
284
+ },
285
+ "save_url": "https://app.talonic.com/schemas/save?from=d1a2b3c4-5678-9abc-def0-1234567890ab"
286
+ },
287
+ "confidence": {
288
+ "overall": 0.94,
289
+ "fields": {
290
+ "invoice_number": 0.99,
291
+ "invoice_date": 0.97,
292
+ "vendor_name": 0.88,
293
+ "total_amount": 0.98,
294
+ "currency": 0.95,
295
+ "line_items": 0.85
296
+ }
297
+ },
298
+ "processing": {
299
+ "duration_ms": 3420,
300
+ "pages_processed": 3,
301
+ "region": "eu-west"
302
+ },
303
+ "links": {
304
+ "self": "/v1/extractions/d1a2b3c4-5678-9abc-def0-1234567890ab",
305
+ "document": "/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543",
306
+ "dashboard": "https://app.talonic.com/extractions/d1a2b3c4-5678-9abc-def0-1234567890ab"
307
+ }
235
308
  }
236
309
  }
237
310
  }
@@ -317,7 +390,8 @@
317
390
  "in": "query",
318
391
  "schema": {
319
392
  "type": "string",
320
- "format": "uuid"
393
+ "format": "uuid",
394
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
321
395
  },
322
396
  "description": "Filter by source connection ID."
323
397
  },
@@ -403,6 +477,50 @@
403
477
  }
404
478
  }
405
479
  ]
480
+ },
481
+ "example": {
482
+ "data": [
483
+ {
484
+ "id": "f0e1d2c3-b4a5-9687-8765-432109876543",
485
+ "filename": "contract-2024.pdf",
486
+ "pages": 12,
487
+ "size_bytes": 1048576,
488
+ "mime_type": "application/pdf",
489
+ "type_detected": "Service Contract",
490
+ "language_detected": "en",
491
+ "status": "completed",
492
+ "source": {
493
+ "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
494
+ "type": "api"
495
+ },
496
+ "triage": {
497
+ "sensitivity": "confidential",
498
+ "department": "Legal",
499
+ "jurisdiction": "EU",
500
+ "pii_detected": true,
501
+ "pii_categories": [
502
+ "name",
503
+ "address"
504
+ ],
505
+ "regulated_data": false,
506
+ "confidentiality_marking": "internal"
507
+ },
508
+ "extraction_count": 1,
509
+ "latest_extraction_id": "d1a2b3c4-5678-9abc-def0-1234567890ab",
510
+ "created_at": "2026-04-25T14:30:00.000Z",
511
+ "links": {
512
+ "self": "/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543",
513
+ "extractions": "/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543/extractions",
514
+ "dashboard": "https://app.talonic.com/documents/f0e1d2c3-b4a5-9687-8765-432109876543"
515
+ }
516
+ }
517
+ ],
518
+ "pagination": {
519
+ "total": 142,
520
+ "limit": 20,
521
+ "has_more": true,
522
+ "next_cursor": "ZDFhMmIzYzR8MjAyNi0wNC0yNVQxNDozMDowMC4wMDBa"
523
+ }
406
524
  }
407
525
  }
408
526
  }
@@ -576,16 +694,19 @@
576
694
  "properties": {
577
695
  "id": {
578
696
  "type": "string",
579
- "format": "uuid"
697
+ "format": "uuid",
698
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
580
699
  },
581
700
  "status": {
582
701
  "type": "string",
702
+ "example": "completed",
583
703
  "enum": [
584
704
  "processing"
585
705
  ]
586
706
  },
587
707
  "message": {
588
- "type": "string"
708
+ "type": "string",
709
+ "example": "Re-extraction started."
589
710
  },
590
711
  "links": {
591
712
  "type": "object",
@@ -646,10 +767,12 @@
646
767
  "document_id": {
647
768
  "type": "string",
648
769
  "format": "uuid",
770
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543",
649
771
  "description": "ID of the document the markdown was produced from."
650
772
  },
651
773
  "markdown": {
652
774
  "type": "string",
775
+ "example": "# Invoice INV-2024-0042\nVendor: Acme Corp...",
653
776
  "description": "Full OCR-converted markdown body."
654
777
  }
655
778
  }
@@ -691,7 +814,8 @@
691
814
  "in": "query",
692
815
  "schema": {
693
816
  "type": "string",
694
- "format": "uuid"
817
+ "format": "uuid",
818
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
695
819
  },
696
820
  "description": "Filter by document ID."
697
821
  },
@@ -845,8 +969,15 @@
845
969
  "description": "Key-value pairs of extracted field names and values.",
846
970
  "example": {
847
971
  "invoice_number": "INV-2024-0042",
972
+ "invoice_date": "2024-03-15",
973
+ "vendor_name": "Acme Corp",
974
+ "vendor_address": "123 Main St, Berlin, DE",
848
975
  "total_amount": 1250,
849
- "vendor_name": "Acme Corp"
976
+ "currency": "EUR",
977
+ "tax_rate": 19,
978
+ "tax_amount": 199.58,
979
+ "payment_terms": "Net 30",
980
+ "due_date": "2024-04-14"
850
981
  }
851
982
  }
852
983
  },
@@ -1024,6 +1155,36 @@
1024
1155
  "application/json": {
1025
1156
  "schema": {
1026
1157
  "$ref": "#/components/schemas/SchemaCreateRequest"
1158
+ },
1159
+ "example": {
1160
+ "name": "Invoice Schema",
1161
+ "description": "Standard invoice fields for AP processing.",
1162
+ "definition": {
1163
+ "properties": {
1164
+ "invoice_number": {
1165
+ "type": "string",
1166
+ "title": "Invoice Number",
1167
+ "description": "Unique identifier on the invoice."
1168
+ },
1169
+ "vendor_name": {
1170
+ "type": "string",
1171
+ "title": "Vendor Name"
1172
+ },
1173
+ "total_amount": {
1174
+ "type": "number",
1175
+ "title": "Total Amount",
1176
+ "description": "Total invoice amount including tax."
1177
+ },
1178
+ "invoice_date": {
1179
+ "type": "string",
1180
+ "title": "Invoice Date"
1181
+ }
1182
+ },
1183
+ "required": [
1184
+ "invoice_number",
1185
+ "total_amount"
1186
+ ]
1187
+ }
1027
1188
  }
1028
1189
  }
1029
1190
  }
@@ -1035,6 +1196,47 @@
1035
1196
  "application/json": {
1036
1197
  "schema": {
1037
1198
  "$ref": "#/components/schemas/SchemaResponse"
1199
+ },
1200
+ "example": {
1201
+ "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
1202
+ "name": "Invoice Schema",
1203
+ "description": "Standard invoice fields for AP processing.",
1204
+ "definition": {
1205
+ "type": "object",
1206
+ "properties": {
1207
+ "invoice_number": {
1208
+ "type": "string",
1209
+ "title": "Invoice Number",
1210
+ "description": "Unique identifier on the invoice."
1211
+ },
1212
+ "vendor_name": {
1213
+ "type": "string",
1214
+ "title": "Vendor Name"
1215
+ },
1216
+ "total_amount": {
1217
+ "type": "number",
1218
+ "title": "Total Amount",
1219
+ "description": "Total invoice amount including tax."
1220
+ },
1221
+ "invoice_date": {
1222
+ "type": "string",
1223
+ "title": "Invoice Date"
1224
+ }
1225
+ },
1226
+ "required": [
1227
+ "invoice_number",
1228
+ "total_amount"
1229
+ ]
1230
+ },
1231
+ "field_count": 4,
1232
+ "version": 1,
1233
+ "created_at": "2026-04-25T14:30:00.000Z",
1234
+ "updated_at": "2026-04-25T14:30:00.000Z",
1235
+ "links": {
1236
+ "self": "/v1/schemas/b2c3d4e5-f6a7-8901-bcde-f12345678901",
1237
+ "extractions": "/v1/extractions?schema_id=b2c3d4e5-f6a7-8901-bcde-f12345678901",
1238
+ "dashboard": "https://app.talonic.com/schemas/b2c3d4e5-f6a7-8901-bcde-f12345678901"
1239
+ }
1038
1240
  }
1039
1241
  }
1040
1242
  }
@@ -1733,6 +1935,17 @@
1733
1935
  "application/json": {
1734
1936
  "schema": {
1735
1937
  "$ref": "#/components/schemas/IngestDocumentResponse"
1938
+ },
1939
+ "example": {
1940
+ "document_id": "f0e1d2c3-b4a5-9687-8765-432109876543",
1941
+ "filename": "receipt-march.pdf",
1942
+ "status": "queued",
1943
+ "processing_mode": "realtime",
1944
+ "source_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
1945
+ "links": {
1946
+ "document": "/v1/documents/f0e1d2c3-b4a5-9687-8765-432109876543",
1947
+ "source": "/v1/sources/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
1948
+ }
1736
1949
  }
1737
1950
  }
1738
1951
  }
@@ -2329,7 +2542,8 @@
2329
2542
  "in": "query",
2330
2543
  "schema": {
2331
2544
  "type": "string",
2332
- "format": "uuid"
2545
+ "format": "uuid",
2546
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
2333
2547
  },
2334
2548
  "description": "Filter to runs that belong to a specific matching configuration."
2335
2549
  }
@@ -4861,7 +5075,8 @@
4861
5075
  "in": "query",
4862
5076
  "schema": {
4863
5077
  "type": "string",
4864
- "format": "uuid"
5078
+ "format": "uuid",
5079
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
4865
5080
  },
4866
5081
  "description": "Filter by cluster."
4867
5082
  }
@@ -5007,10 +5222,12 @@
5007
5222
  "properties": {
5008
5223
  "id": {
5009
5224
  "type": "string",
5010
- "format": "uuid"
5225
+ "format": "uuid",
5226
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
5011
5227
  },
5012
5228
  "canonical_name": {
5013
- "type": "string"
5229
+ "type": "string",
5230
+ "example": "invoice_number"
5014
5231
  },
5015
5232
  "similarity": {
5016
5233
  "type": "number",
@@ -5031,6 +5248,7 @@
5031
5248
  },
5032
5249
  "message": {
5033
5250
  "type": "string",
5251
+ "example": "Re-extraction started.",
5034
5252
  "description": "Present when the field has no embedding."
5035
5253
  }
5036
5254
  }
@@ -5394,6 +5612,7 @@
5394
5612
  "source_run_id": {
5395
5613
  "type": "string",
5396
5614
  "format": "uuid",
5615
+ "example": "f2a3b4c5-d6e7-8901-fabc-012345678901",
5397
5616
  "description": "ID of the source run to resolve against."
5398
5617
  }
5399
5618
  }
@@ -5648,7 +5867,8 @@
5648
5867
  "type": "array",
5649
5868
  "items": {
5650
5869
  "type": "string",
5651
- "format": "uuid"
5870
+ "format": "uuid",
5871
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
5652
5872
  }
5653
5873
  }
5654
5874
  }
@@ -5824,10 +6044,12 @@
5824
6044
  "type": "object",
5825
6045
  "properties": {
5826
6046
  "status": {
5827
- "type": "string"
6047
+ "type": "string",
6048
+ "example": "completed"
5828
6049
  },
5829
6050
  "message": {
5830
- "type": "string"
6051
+ "type": "string",
6052
+ "example": "Re-extraction started."
5831
6053
  }
5832
6054
  }
5833
6055
  }
@@ -5860,7 +6082,8 @@
5860
6082
  "type": "object",
5861
6083
  "properties": {
5862
6084
  "status": {
5863
- "type": "string"
6085
+ "type": "string",
6086
+ "example": "completed"
5864
6087
  },
5865
6088
  "processed": {
5866
6089
  "type": "integer"
@@ -5870,7 +6093,8 @@
5870
6093
  },
5871
6094
  "started_at": {
5872
6095
  "type": "string",
5873
- "format": "date-time"
6096
+ "format": "date-time",
6097
+ "example": "2026-04-25T14:30:00.000Z"
5874
6098
  }
5875
6099
  }
5876
6100
  }
@@ -5938,7 +6162,8 @@
5938
6162
  "required": true,
5939
6163
  "schema": {
5940
6164
  "type": "string",
5941
- "format": "uuid"
6165
+ "format": "uuid",
6166
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
5942
6167
  },
5943
6168
  "description": "Job run ID."
5944
6169
  }
@@ -5982,7 +6207,8 @@
5982
6207
  "required": true,
5983
6208
  "schema": {
5984
6209
  "type": "string",
5985
- "format": "uuid"
6210
+ "format": "uuid",
6211
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
5986
6212
  },
5987
6213
  "description": "Job run ID."
5988
6214
  }
@@ -6034,7 +6260,8 @@
6034
6260
  "required": true,
6035
6261
  "schema": {
6036
6262
  "type": "string",
6037
- "format": "uuid"
6263
+ "format": "uuid",
6264
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
6038
6265
  },
6039
6266
  "description": "Job run ID."
6040
6267
  },
@@ -6044,7 +6271,8 @@
6044
6271
  "required": true,
6045
6272
  "schema": {
6046
6273
  "type": "string",
6047
- "format": "uuid"
6274
+ "format": "uuid",
6275
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
6048
6276
  },
6049
6277
  "description": "Document ID to compare."
6050
6278
  },
@@ -6097,7 +6325,8 @@
6097
6325
  "required": true,
6098
6326
  "schema": {
6099
6327
  "type": "string",
6100
- "format": "uuid"
6328
+ "format": "uuid",
6329
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
6101
6330
  },
6102
6331
  "description": "Job run ID."
6103
6332
  }
@@ -6116,10 +6345,12 @@
6116
6345
  "properties": {
6117
6346
  "document_id": {
6118
6347
  "type": "string",
6119
- "format": "uuid"
6348
+ "format": "uuid",
6349
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
6120
6350
  },
6121
6351
  "field_name": {
6122
- "type": "string"
6352
+ "type": "string",
6353
+ "example": "invoice_number"
6123
6354
  },
6124
6355
  "value": {
6125
6356
  "description": "The override value to apply."
@@ -6175,7 +6406,8 @@
6175
6406
  "required": true,
6176
6407
  "schema": {
6177
6408
  "type": "string",
6178
- "format": "uuid"
6409
+ "format": "uuid",
6410
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
6179
6411
  },
6180
6412
  "description": "Job run ID."
6181
6413
  }
@@ -6194,10 +6426,12 @@
6194
6426
  "properties": {
6195
6427
  "document_id": {
6196
6428
  "type": "string",
6197
- "format": "uuid"
6429
+ "format": "uuid",
6430
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
6198
6431
  },
6199
6432
  "field_name": {
6200
- "type": "string"
6433
+ "type": "string",
6434
+ "example": "invoice_number"
6201
6435
  },
6202
6436
  "decision": {
6203
6437
  "type": "string",
@@ -6348,7 +6582,8 @@
6348
6582
  },
6349
6583
  "created_at": {
6350
6584
  "type": "string",
6351
- "format": "date-time"
6585
+ "format": "date-time",
6586
+ "example": "2026-04-25T14:30:00.000Z"
6352
6587
  }
6353
6588
  }
6354
6589
  }
@@ -6411,7 +6646,8 @@
6411
6646
  },
6412
6647
  "created_at": {
6413
6648
  "type": "string",
6414
- "format": "date-time"
6649
+ "format": "date-time",
6650
+ "example": "2026-04-25T14:30:00.000Z"
6415
6651
  }
6416
6652
  }
6417
6653
  }
@@ -6561,11 +6797,13 @@
6561
6797
  "properties": {
6562
6798
  "source_class_id": {
6563
6799
  "type": "string",
6564
- "format": "uuid"
6800
+ "format": "uuid",
6801
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
6565
6802
  },
6566
6803
  "target_class_id": {
6567
6804
  "type": "string",
6568
- "format": "uuid"
6805
+ "format": "uuid",
6806
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
6569
6807
  },
6570
6808
  "relationship": {
6571
6809
  "type": "string"
@@ -6617,7 +6855,8 @@
6617
6855
  },
6618
6856
  "class_id": {
6619
6857
  "type": "string",
6620
- "format": "uuid"
6858
+ "format": "uuid",
6859
+ "example": "a7b8c9d0-e1f2-3456-abcd-567890123456"
6621
6860
  },
6622
6861
  "class_name": {
6623
6862
  "type": "string"
@@ -7180,7 +7419,8 @@
7180
7419
  "properties": {
7181
7420
  "rule_id": {
7182
7421
  "type": "string",
7183
- "format": "uuid"
7422
+ "format": "uuid",
7423
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
7184
7424
  }
7185
7425
  }
7186
7426
  }
@@ -7238,7 +7478,8 @@
7238
7478
  "properties": {
7239
7479
  "check_id": {
7240
7480
  "type": "string",
7241
- "format": "uuid"
7481
+ "format": "uuid",
7482
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
7242
7483
  },
7243
7484
  "check_name": {
7244
7485
  "type": "string"
@@ -7346,10 +7587,12 @@
7346
7587
  "properties": {
7347
7588
  "id": {
7348
7589
  "type": "string",
7349
- "format": "uuid"
7590
+ "format": "uuid",
7591
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
7350
7592
  },
7351
7593
  "status": {
7352
- "type": "string"
7594
+ "type": "string",
7595
+ "example": "completed"
7353
7596
  }
7354
7597
  }
7355
7598
  }
@@ -7390,10 +7633,12 @@
7390
7633
  "properties": {
7391
7634
  "id": {
7392
7635
  "type": "string",
7393
- "format": "uuid"
7636
+ "format": "uuid",
7637
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
7394
7638
  },
7395
7639
  "status": {
7396
- "type": "string"
7640
+ "type": "string",
7641
+ "example": "completed"
7397
7642
  }
7398
7643
  }
7399
7644
  }
@@ -7427,7 +7672,8 @@
7427
7672
  "required": true,
7428
7673
  "schema": {
7429
7674
  "type": "string",
7430
- "format": "uuid"
7675
+ "format": "uuid",
7676
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
7431
7677
  },
7432
7678
  "description": "Structuring run ID."
7433
7679
  }
@@ -7821,11 +8067,13 @@
7821
8067
  "golden_sample_id": {
7822
8068
  "type": "string",
7823
8069
  "format": "uuid",
8070
+ "example": "e5f6a7b8-c9d0-1234-efab-345678901234",
7824
8071
  "description": "Golden sample dataset to validate against."
7825
8072
  },
7826
8073
  "schema_id": {
7827
8074
  "type": "string",
7828
8075
  "format": "uuid",
8076
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
7829
8077
  "description": "Optional schema to scope the validation."
7830
8078
  }
7831
8079
  }
@@ -8005,11 +8253,13 @@
8005
8253
  "format": "float"
8006
8254
  },
8007
8255
  "currency": {
8008
- "type": "string"
8256
+ "type": "string",
8257
+ "example": "USD"
8009
8258
  },
8010
8259
  "updated_at": {
8011
8260
  "type": "string",
8012
- "format": "date-time"
8261
+ "format": "date-time",
8262
+ "example": "2026-04-25T14:30:00.000Z"
8013
8263
  }
8014
8264
  }
8015
8265
  }
@@ -8064,7 +8314,8 @@
8064
8314
  "properties": {
8065
8315
  "id": {
8066
8316
  "type": "string",
8067
- "format": "uuid"
8317
+ "format": "uuid",
8318
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8068
8319
  },
8069
8320
  "type": {
8070
8321
  "type": "string",
@@ -8082,7 +8333,8 @@
8082
8333
  },
8083
8334
  "created_at": {
8084
8335
  "type": "string",
8085
- "format": "date-time"
8336
+ "format": "date-time",
8337
+ "example": "2026-04-25T14:30:00.000Z"
8086
8338
  }
8087
8339
  }
8088
8340
  }
@@ -8302,7 +8554,8 @@
8302
8554
  },
8303
8555
  "created_at": {
8304
8556
  "type": "string",
8305
- "format": "date-time"
8557
+ "format": "date-time",
8558
+ "example": "2026-04-25T14:30:00.000Z"
8306
8559
  }
8307
8560
  }
8308
8561
  }
@@ -8353,6 +8606,7 @@
8353
8606
  "properties": {
8354
8607
  "status": {
8355
8608
  "type": "string",
8609
+ "example": "completed",
8356
8610
  "description": "New status (e.g. open, in_review, resolved, archived)."
8357
8611
  }
8358
8612
  }
@@ -8420,11 +8674,13 @@
8420
8674
  "properties": {
8421
8675
  "source_document_id": {
8422
8676
  "type": "string",
8423
- "format": "uuid"
8677
+ "format": "uuid",
8678
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8424
8679
  },
8425
8680
  "target_document_id": {
8426
8681
  "type": "string",
8427
- "format": "uuid"
8682
+ "format": "uuid",
8683
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8428
8684
  },
8429
8685
  "entity_value": {
8430
8686
  "type": "string"
@@ -8478,11 +8734,13 @@
8478
8734
  "properties": {
8479
8735
  "source_document_id": {
8480
8736
  "type": "string",
8481
- "format": "uuid"
8737
+ "format": "uuid",
8738
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8482
8739
  },
8483
8740
  "target_document_id": {
8484
8741
  "type": "string",
8485
- "format": "uuid"
8742
+ "format": "uuid",
8743
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8486
8744
  },
8487
8745
  "entity_value": {
8488
8746
  "type": "string"
@@ -8542,11 +8800,13 @@
8542
8800
  "properties": {
8543
8801
  "source_document_id": {
8544
8802
  "type": "string",
8545
- "format": "uuid"
8803
+ "format": "uuid",
8804
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8546
8805
  },
8547
8806
  "target_document_id": {
8548
8807
  "type": "string",
8549
- "format": "uuid"
8808
+ "format": "uuid",
8809
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8550
8810
  },
8551
8811
  "entity_value": {
8552
8812
  "type": "string"
@@ -8617,7 +8877,8 @@
8617
8877
  "type": "array",
8618
8878
  "items": {
8619
8879
  "type": "string",
8620
- "format": "uuid"
8880
+ "format": "uuid",
8881
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8621
8882
  },
8622
8883
  "description": "Document IDs to move to the new case."
8623
8884
  }
@@ -8823,7 +9084,8 @@
8823
9084
  "type": "array",
8824
9085
  "items": {
8825
9086
  "type": "string",
8826
- "format": "uuid"
9087
+ "format": "uuid",
9088
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8827
9089
  }
8828
9090
  }
8829
9091
  }
@@ -8890,7 +9152,8 @@
8890
9152
  "type": "array",
8891
9153
  "items": {
8892
9154
  "type": "string",
8893
- "format": "uuid"
9155
+ "format": "uuid",
9156
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
8894
9157
  }
8895
9158
  }
8896
9159
  }
@@ -9020,6 +9283,7 @@
9020
9283
  "config_id": {
9021
9284
  "type": "string",
9022
9285
  "format": "uuid",
9286
+ "example": "c9d0e1f2-a3b4-5678-cdef-789012345678",
9023
9287
  "description": "Matching configuration ID."
9024
9288
  }
9025
9289
  }
@@ -9074,6 +9338,7 @@
9074
9338
  "run_id": {
9075
9339
  "type": "string",
9076
9340
  "format": "uuid",
9341
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
9077
9342
  "description": "Matching run ID to resolve."
9078
9343
  }
9079
9344
  }
@@ -9138,7 +9403,8 @@
9138
9403
  "properties": {
9139
9404
  "id": {
9140
9405
  "type": "string",
9141
- "format": "uuid"
9406
+ "format": "uuid",
9407
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
9142
9408
  },
9143
9409
  "name": {
9144
9410
  "type": "string"
@@ -9416,7 +9682,8 @@
9416
9682
  "type": "object",
9417
9683
  "properties": {
9418
9684
  "status": {
9419
- "type": "string"
9685
+ "type": "string",
9686
+ "example": "completed"
9420
9687
  },
9421
9688
  "processed": {
9422
9689
  "type": "integer"
@@ -9475,7 +9742,8 @@
9475
9742
  "properties": {
9476
9743
  "document_id": {
9477
9744
  "type": "string",
9478
- "format": "uuid"
9745
+ "format": "uuid",
9746
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
9479
9747
  },
9480
9748
  "reference_id": {
9481
9749
  "type": "string"
@@ -9549,12 +9817,14 @@
9549
9817
  "type": "array",
9550
9818
  "items": {
9551
9819
  "type": "string",
9552
- "format": "uuid"
9820
+ "format": "uuid",
9821
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
9553
9822
  }
9554
9823
  },
9555
9824
  "assignee_id": {
9556
9825
  "type": "string",
9557
9826
  "format": "uuid",
9827
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
9558
9828
  "description": "User ID of the assignee."
9559
9829
  }
9560
9830
  }
@@ -9710,14 +9980,16 @@
9710
9980
  "properties": {
9711
9981
  "document_id": {
9712
9982
  "type": "string",
9713
- "format": "uuid"
9983
+ "format": "uuid",
9984
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
9714
9985
  },
9715
9986
  "expected_data": {
9716
9987
  "type": "object",
9717
9988
  "additionalProperties": true
9718
9989
  },
9719
9990
  "notes": {
9720
- "type": "string"
9991
+ "type": "string",
9992
+ "example": "Reviewed and confirmed."
9721
9993
  }
9722
9994
  }
9723
9995
  }
@@ -9767,7 +10039,8 @@
9767
10039
  "required": true,
9768
10040
  "schema": {
9769
10041
  "type": "string",
9770
- "format": "uuid"
10042
+ "format": "uuid",
10043
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
9771
10044
  },
9772
10045
  "description": "Entry ID."
9773
10046
  }
@@ -9784,7 +10057,8 @@
9784
10057
  "additionalProperties": true
9785
10058
  },
9786
10059
  "notes": {
9787
- "type": "string"
10060
+ "type": "string",
10061
+ "example": "Reviewed and confirmed."
9788
10062
  }
9789
10063
  }
9790
10064
  }
@@ -9829,7 +10103,8 @@
9829
10103
  "required": true,
9830
10104
  "schema": {
9831
10105
  "type": "string",
9832
- "format": "uuid"
10106
+ "format": "uuid",
10107
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
9833
10108
  },
9834
10109
  "description": "Entry ID."
9835
10110
  }
@@ -9919,7 +10194,8 @@
9919
10194
  "required": true,
9920
10195
  "schema": {
9921
10196
  "type": "string",
9922
- "format": "uuid"
10197
+ "format": "uuid",
10198
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
9923
10199
  },
9924
10200
  "description": "ID of the benchmark run to compare against."
9925
10201
  }
@@ -10172,7 +10448,8 @@
10172
10448
  "required": true,
10173
10449
  "schema": {
10174
10450
  "type": "string",
10175
- "format": "uuid"
10451
+ "format": "uuid",
10452
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10176
10453
  },
10177
10454
  "description": "Resource UUID."
10178
10455
  },
@@ -10399,6 +10676,7 @@
10399
10676
  },
10400
10677
  "message": {
10401
10678
  "type": "string",
10679
+ "example": "Re-extraction started.",
10402
10680
  "description": "Human-readable error description."
10403
10681
  },
10404
10682
  "request_id": {
@@ -10470,7 +10748,8 @@
10470
10748
  },
10471
10749
  "id": {
10472
10750
  "type": "string",
10473
- "format": "uuid"
10751
+ "format": "uuid",
10752
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10474
10753
  }
10475
10754
  }
10476
10755
  },
@@ -10486,17 +10765,19 @@
10486
10765
  "properties": {
10487
10766
  "extraction_id": {
10488
10767
  "type": "string",
10489
- "format": "uuid"
10768
+ "format": "uuid",
10769
+ "example": "d1a2b3c4-5678-9abc-def0-1234567890ab"
10490
10770
  },
10491
10771
  "request_id": {
10492
10772
  "type": "string",
10493
- "format": "uuid"
10773
+ "example": "req_x7y8z9a0b1c2d3e4"
10494
10774
  },
10495
10775
  "status": {
10496
10776
  "type": "string",
10497
10777
  "enum": [
10498
10778
  "complete"
10499
- ]
10779
+ ],
10780
+ "example": "complete"
10500
10781
  },
10501
10782
  "document": {
10502
10783
  "$ref": "#/components/schemas/ExtractDocumentSummary"
@@ -10523,7 +10804,8 @@
10523
10804
  "string",
10524
10805
  "null"
10525
10806
  ],
10526
- "format": "uuid"
10807
+ "format": "uuid",
10808
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10527
10809
  },
10528
10810
  "definition": {
10529
10811
  "type": "object",
@@ -10608,10 +10890,12 @@
10608
10890
  "properties": {
10609
10891
  "request_id": {
10610
10892
  "type": "string",
10611
- "format": "uuid"
10893
+ "format": "uuid",
10894
+ "example": "req_x7y8z9a0b1c2d3e4"
10612
10895
  },
10613
10896
  "status": {
10614
10897
  "type": "string",
10898
+ "example": "completed",
10615
10899
  "enum": [
10616
10900
  "processing"
10617
10901
  ]
@@ -10626,10 +10910,12 @@
10626
10910
  "properties": {
10627
10911
  "id": {
10628
10912
  "type": "string",
10629
- "format": "uuid"
10913
+ "format": "uuid",
10914
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10630
10915
  },
10631
10916
  "status": {
10632
10917
  "type": "string",
10918
+ "example": "completed",
10633
10919
  "enum": [
10634
10920
  "queued"
10635
10921
  ]
@@ -10651,10 +10937,12 @@
10651
10937
  "properties": {
10652
10938
  "id": {
10653
10939
  "type": "string",
10654
- "format": "uuid"
10940
+ "format": "uuid",
10941
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10655
10942
  },
10656
10943
  "filename": {
10657
- "type": "string"
10944
+ "type": "string",
10945
+ "example": "invoice-042.pdf"
10658
10946
  },
10659
10947
  "pages": {
10660
10948
  "type": "integer"
@@ -10677,7 +10965,8 @@
10677
10965
  "properties": {
10678
10966
  "id": {
10679
10967
  "type": "string",
10680
- "format": "uuid"
10968
+ "format": "uuid",
10969
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10681
10970
  },
10682
10971
  "filename": {
10683
10972
  "type": "string",
@@ -10719,7 +11008,8 @@
10719
11008
  "properties": {
10720
11009
  "id": {
10721
11010
  "type": "string",
10722
- "format": "uuid"
11011
+ "format": "uuid",
11012
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10723
11013
  },
10724
11014
  "filename": {
10725
11015
  "type": "string",
@@ -10753,6 +11043,7 @@
10753
11043
  },
10754
11044
  "status": {
10755
11045
  "type": "string",
11046
+ "example": "completed",
10756
11047
  "enum": [
10757
11048
  "pending",
10758
11049
  "processing",
@@ -10768,7 +11059,8 @@
10768
11059
  "string",
10769
11060
  "null"
10770
11061
  ],
10771
- "format": "uuid"
11062
+ "format": "uuid",
11063
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10772
11064
  },
10773
11065
  "type": {
10774
11066
  "type": "string",
@@ -10785,11 +11077,13 @@
10785
11077
  "string",
10786
11078
  "null"
10787
11079
  ],
10788
- "format": "uuid"
11080
+ "format": "uuid",
11081
+ "example": "d1a2b3c4-5678-9abc-def0-1234567890ab"
10789
11082
  },
10790
11083
  "created_at": {
10791
11084
  "type": "string",
10792
- "format": "date-time"
11085
+ "format": "date-time",
11086
+ "example": "2026-04-25T14:30:00.000Z"
10793
11087
  },
10794
11088
  "links": {
10795
11089
  "type": "object",
@@ -10813,10 +11107,12 @@
10813
11107
  "properties": {
10814
11108
  "id": {
10815
11109
  "type": "string",
10816
- "format": "uuid"
11110
+ "format": "uuid",
11111
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10817
11112
  },
10818
11113
  "status": {
10819
11114
  "type": "string",
11115
+ "example": "completed",
10820
11116
  "enum": [
10821
11117
  "complete",
10822
11118
  "failed",
@@ -10825,10 +11121,12 @@
10825
11121
  },
10826
11122
  "document_id": {
10827
11123
  "type": "string",
10828
- "format": "uuid"
11124
+ "format": "uuid",
11125
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
10829
11126
  },
10830
11127
  "document_filename": {
10831
- "type": "string"
11128
+ "type": "string",
11129
+ "example": "invoice-042.pdf"
10832
11130
  },
10833
11131
  "confidence_overall": {
10834
11132
  "type": "number",
@@ -10836,7 +11134,8 @@
10836
11134
  },
10837
11135
  "created_at": {
10838
11136
  "type": "string",
10839
- "format": "date-time"
11137
+ "format": "date-time",
11138
+ "example": "2026-04-25T14:30:00.000Z"
10840
11139
  },
10841
11140
  "links": {
10842
11141
  "type": "object",
@@ -10863,10 +11162,12 @@
10863
11162
  "properties": {
10864
11163
  "id": {
10865
11164
  "type": "string",
10866
- "format": "uuid"
11165
+ "format": "uuid",
11166
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10867
11167
  },
10868
11168
  "status": {
10869
11169
  "type": "string",
11170
+ "example": "completed",
10870
11171
  "enum": [
10871
11172
  "complete",
10872
11173
  "failed",
@@ -10878,10 +11179,12 @@
10878
11179
  "properties": {
10879
11180
  "id": {
10880
11181
  "type": "string",
10881
- "format": "uuid"
11182
+ "format": "uuid",
11183
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10882
11184
  },
10883
11185
  "filename": {
10884
- "type": "string"
11186
+ "type": "string",
11187
+ "example": "invoice-042.pdf"
10885
11188
  },
10886
11189
  "pages": {
10887
11190
  "type": "integer"
@@ -10934,13 +11237,15 @@
10934
11237
  "type": "integer"
10935
11238
  },
10936
11239
  "region": {
10937
- "type": "string"
11240
+ "type": "string",
11241
+ "example": "eu-west"
10938
11242
  }
10939
11243
  }
10940
11244
  },
10941
11245
  "created_at": {
10942
11246
  "type": "string",
10943
- "format": "date-time"
11247
+ "format": "date-time",
11248
+ "example": "2026-04-25T14:30:00.000Z"
10944
11249
  },
10945
11250
  "links": {
10946
11251
  "type": "object",
@@ -10972,7 +11277,8 @@
10972
11277
  "properties": {
10973
11278
  "id": {
10974
11279
  "type": "string",
10975
- "format": "uuid"
11280
+ "format": "uuid",
11281
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
10976
11282
  },
10977
11283
  "name": {
10978
11284
  "type": "string",
@@ -11045,11 +11351,13 @@
11045
11351
  },
11046
11352
  "created_at": {
11047
11353
  "type": "string",
11048
- "format": "date-time"
11354
+ "format": "date-time",
11355
+ "example": "2026-04-25T14:30:00.000Z"
11049
11356
  },
11050
11357
  "updated_at": {
11051
11358
  "type": "string",
11052
- "format": "date-time"
11359
+ "format": "date-time",
11360
+ "example": "2026-04-25T14:30:00.000Z"
11053
11361
  },
11054
11362
  "links": {
11055
11363
  "type": "object",
@@ -11126,13 +11434,16 @@
11126
11434
  ],
11127
11435
  "properties": {
11128
11436
  "field_name": {
11129
- "type": "string"
11437
+ "type": "string",
11438
+ "example": "invoice_number"
11130
11439
  },
11131
11440
  "display_name": {
11132
- "type": "string"
11441
+ "type": "string",
11442
+ "example": "Invoice Number"
11133
11443
  },
11134
11444
  "data_type": {
11135
- "type": "string"
11445
+ "type": "string",
11446
+ "example": "string"
11136
11447
  },
11137
11448
  "description": {
11138
11449
  "type": "string"
@@ -11196,13 +11507,16 @@
11196
11507
  ],
11197
11508
  "properties": {
11198
11509
  "field_name": {
11199
- "type": "string"
11510
+ "type": "string",
11511
+ "example": "invoice_number"
11200
11512
  },
11201
11513
  "display_name": {
11202
- "type": "string"
11514
+ "type": "string",
11515
+ "example": "Invoice Number"
11203
11516
  },
11204
11517
  "data_type": {
11205
- "type": "string"
11518
+ "type": "string",
11519
+ "example": "string"
11206
11520
  },
11207
11521
  "description": {
11208
11522
  "type": "string"
@@ -11224,7 +11538,8 @@
11224
11538
  "properties": {
11225
11539
  "id": {
11226
11540
  "type": "string",
11227
- "format": "uuid"
11541
+ "format": "uuid",
11542
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11228
11543
  },
11229
11544
  "name": {
11230
11545
  "type": [
@@ -11235,6 +11550,7 @@
11235
11550
  },
11236
11551
  "status": {
11237
11552
  "type": "string",
11553
+ "example": "completed",
11238
11554
  "enum": [
11239
11555
  "pending",
11240
11556
  "queued",
@@ -11265,7 +11581,8 @@
11265
11581
  "properties": {
11266
11582
  "id": {
11267
11583
  "type": "string",
11268
- "format": "uuid"
11584
+ "format": "uuid",
11585
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11269
11586
  },
11270
11587
  "name": {
11271
11588
  "type": "string"
@@ -11336,27 +11653,31 @@
11336
11653
  "type": "string"
11337
11654
  },
11338
11655
  "message": {
11339
- "type": "string"
11656
+ "type": "string",
11657
+ "example": "Re-extraction started."
11340
11658
  }
11341
11659
  }
11342
11660
  },
11343
11661
  "created_at": {
11344
11662
  "type": "string",
11345
- "format": "date-time"
11663
+ "format": "date-time",
11664
+ "example": "2026-04-25T14:30:00.000Z"
11346
11665
  },
11347
11666
  "started_at": {
11348
11667
  "type": [
11349
11668
  "string",
11350
11669
  "null"
11351
11670
  ],
11352
- "format": "date-time"
11671
+ "format": "date-time",
11672
+ "example": "2026-04-25T14:30:00.000Z"
11353
11673
  },
11354
11674
  "completed_at": {
11355
11675
  "type": [
11356
11676
  "string",
11357
11677
  "null"
11358
11678
  ],
11359
- "format": "date-time"
11679
+ "format": "date-time",
11680
+ "example": "2026-04-25T14:30:00.000Z"
11360
11681
  },
11361
11682
  "links": {
11362
11683
  "type": "object",
@@ -11387,7 +11708,8 @@
11387
11708
  "properties": {
11388
11709
  "id": {
11389
11710
  "type": "string",
11390
- "format": "uuid"
11711
+ "format": "uuid",
11712
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11391
11713
  },
11392
11714
  "name": {
11393
11715
  "type": "string",
@@ -11399,12 +11721,12 @@
11399
11721
  },
11400
11722
  "status": {
11401
11723
  "type": "string",
11724
+ "example": "completed",
11402
11725
  "enum": [
11403
11726
  "active",
11404
11727
  "syncing",
11405
11728
  "error"
11406
- ],
11407
- "example": "active"
11729
+ ]
11408
11730
  },
11409
11731
  "document_count": {
11410
11732
  "type": "integer",
@@ -11418,7 +11740,8 @@
11418
11740
  "properties": {
11419
11741
  "id": {
11420
11742
  "type": "string",
11421
- "format": "uuid"
11743
+ "format": "uuid",
11744
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11422
11745
  }
11423
11746
  }
11424
11747
  },
@@ -11429,7 +11752,8 @@
11429
11752
  },
11430
11753
  "created_at": {
11431
11754
  "type": "string",
11432
- "format": "date-time"
11755
+ "format": "date-time",
11756
+ "example": "2026-04-25T14:30:00.000Z"
11433
11757
  },
11434
11758
  "links": {
11435
11759
  "type": "object",
@@ -11462,6 +11786,7 @@
11462
11786
  "default_schema_id": {
11463
11787
  "type": "string",
11464
11788
  "format": "uuid",
11789
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
11465
11790
  "description": "Optional schema ID to apply by default to documents in this source."
11466
11791
  }
11467
11792
  }
@@ -11478,6 +11803,7 @@
11478
11803
  "null"
11479
11804
  ],
11480
11805
  "format": "uuid",
11806
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
11481
11807
  "description": "Set to null to remove the default schema."
11482
11808
  }
11483
11809
  }
@@ -11488,13 +11814,16 @@
11488
11814
  "document_id": {
11489
11815
  "type": "string",
11490
11816
  "format": "uuid",
11817
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543",
11491
11818
  "description": "ID of the created document (absent if duplicate)."
11492
11819
  },
11493
11820
  "filename": {
11494
- "type": "string"
11821
+ "type": "string",
11822
+ "example": "invoice-042.pdf"
11495
11823
  },
11496
11824
  "status": {
11497
11825
  "type": "string",
11826
+ "example": "completed",
11498
11827
  "enum": [
11499
11828
  "queued",
11500
11829
  "duplicate"
@@ -11503,10 +11832,12 @@
11503
11832
  },
11504
11833
  "source_id": {
11505
11834
  "type": "string",
11506
- "format": "uuid"
11835
+ "format": "uuid",
11836
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11507
11837
  },
11508
11838
  "message": {
11509
11839
  "type": "string",
11840
+ "example": "Re-extraction started.",
11510
11841
  "description": "Present when status is `duplicate`."
11511
11842
  },
11512
11843
  "existing_document_id": {
@@ -11515,6 +11846,7 @@
11515
11846
  "null"
11516
11847
  ],
11517
11848
  "format": "uuid",
11849
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
11518
11850
  "description": "Present when status is `duplicate`."
11519
11851
  },
11520
11852
  "links": {
@@ -11535,13 +11867,16 @@
11535
11867
  "properties": {
11536
11868
  "id": {
11537
11869
  "type": "string",
11538
- "format": "uuid"
11870
+ "format": "uuid",
11871
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11539
11872
  },
11540
11873
  "filename": {
11541
- "type": "string"
11874
+ "type": "string",
11875
+ "example": "invoice-042.pdf"
11542
11876
  },
11543
11877
  "status": {
11544
11878
  "type": "string",
11879
+ "example": "completed",
11545
11880
  "enum": [
11546
11881
  "pending",
11547
11882
  "processing",
@@ -11560,7 +11895,8 @@
11560
11895
  },
11561
11896
  "created_at": {
11562
11897
  "type": "string",
11563
- "format": "date-time"
11898
+ "format": "date-time",
11899
+ "example": "2026-04-25T14:30:00.000Z"
11564
11900
  },
11565
11901
  "links": {
11566
11902
  "type": "object",
@@ -11581,15 +11917,16 @@
11581
11917
  "schema_id": {
11582
11918
  "type": "string",
11583
11919
  "format": "uuid",
11584
- "description": "User schema UUID to run this job against.",
11585
- "example": "ae4b0e25-12c4-4db0-9d21-f2d6c9c2d4c1"
11920
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
11921
+ "description": "User schema UUID to run this job against."
11586
11922
  },
11587
11923
  "document_ids": {
11588
11924
  "type": "array",
11589
11925
  "description": "Optional list of document UUIDs to process. If omitted or empty, all\ncompleted documents for the authenticated customer are used.\n",
11590
11926
  "items": {
11591
11927
  "type": "string",
11592
- "format": "uuid"
11928
+ "format": "uuid",
11929
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11593
11930
  }
11594
11931
  },
11595
11932
  "name": {
@@ -11614,10 +11951,12 @@
11614
11951
  "id": {
11615
11952
  "type": "string",
11616
11953
  "format": "uuid",
11954
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
11617
11955
  "description": "The newly created job's UUID."
11618
11956
  },
11619
11957
  "status": {
11620
11958
  "type": "string",
11959
+ "example": "completed",
11621
11960
  "enum": [
11622
11961
  "pending"
11623
11962
  ],
@@ -11653,7 +11992,8 @@
11653
11992
  "properties": {
11654
11993
  "job_id": {
11655
11994
  "type": "string",
11656
- "format": "uuid"
11995
+ "format": "uuid",
11996
+ "example": "c3d4e5f6-a7b8-9012-cdef-123456789012"
11657
11997
  },
11658
11998
  "job_status": {
11659
11999
  "type": "string",
@@ -11674,7 +12014,8 @@
11674
12014
  "properties": {
11675
12015
  "id": {
11676
12016
  "type": "string",
11677
- "format": "uuid"
12017
+ "format": "uuid",
12018
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11678
12019
  },
11679
12020
  "name": {
11680
12021
  "type": "string"
@@ -11695,17 +12036,21 @@
11695
12036
  "id": {
11696
12037
  "type": "string",
11697
12038
  "format": "uuid",
12039
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
11698
12040
  "description": "The result row's UUID."
11699
12041
  },
11700
12042
  "document_id": {
11701
12043
  "type": "string",
11702
- "format": "uuid"
12044
+ "format": "uuid",
12045
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
11703
12046
  },
11704
12047
  "filename": {
11705
- "type": "string"
12048
+ "type": "string",
12049
+ "example": "invoice-042.pdf"
11706
12050
  },
11707
12051
  "status": {
11708
12052
  "type": "string",
12053
+ "example": "completed",
11709
12054
  "description": "Per-row status (e.g. `complete`, `partial`, `failed`)."
11710
12055
  },
11711
12056
  "values": {
@@ -11754,7 +12099,8 @@
11754
12099
  "properties": {
11755
12100
  "id": {
11756
12101
  "type": "string",
11757
- "format": "uuid"
12102
+ "format": "uuid",
12103
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11758
12104
  },
11759
12105
  "name": {
11760
12106
  "type": "string",
@@ -11770,14 +12116,16 @@
11770
12116
  },
11771
12117
  "created_at": {
11772
12118
  "type": "string",
11773
- "format": "date-time"
12119
+ "format": "date-time",
12120
+ "example": "2026-04-25T14:30:00.000Z"
11774
12121
  },
11775
12122
  "updated_at": {
11776
12123
  "type": [
11777
12124
  "string",
11778
12125
  "null"
11779
12126
  ],
11780
- "format": "date-time"
12127
+ "format": "date-time",
12128
+ "example": "2026-04-25T14:30:00.000Z"
11781
12129
  },
11782
12130
  "links": {
11783
12131
  "type": "object",
@@ -11928,14 +12276,14 @@
11928
12276
  },
11929
12277
  "match_type": {
11930
12278
  "type": "string",
12279
+ "example": "exact",
11931
12280
  "enum": [
11932
12281
  "exact",
11933
12282
  "fuzzy",
11934
12283
  "date_range",
11935
12284
  "numeric_range"
11936
12285
  ],
11937
- "description": "Matching strategy applied to this pair.",
11938
- "example": "fuzzy"
12286
+ "description": "Matching strategy applied to this pair."
11939
12287
  },
11940
12288
  "weight": {
11941
12289
  "type": "number",
@@ -11958,7 +12306,8 @@
11958
12306
  "properties": {
11959
12307
  "id": {
11960
12308
  "type": "string",
11961
- "format": "uuid"
12309
+ "format": "uuid",
12310
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
11962
12311
  },
11963
12312
  "name": {
11964
12313
  "type": "string",
@@ -11966,7 +12315,8 @@
11966
12315
  },
11967
12316
  "reference_data_id": {
11968
12317
  "type": "string",
11969
- "format": "uuid"
12318
+ "format": "uuid",
12319
+ "example": "b8c9d0e1-f2a3-4567-bcde-678901234567"
11970
12320
  },
11971
12321
  "target_type": {
11972
12322
  "type": "string",
@@ -11998,14 +12348,16 @@
11998
12348
  },
11999
12349
  "created_at": {
12000
12350
  "type": "string",
12001
- "format": "date-time"
12351
+ "format": "date-time",
12352
+ "example": "2026-04-25T14:30:00.000Z"
12002
12353
  },
12003
12354
  "updated_at": {
12004
12355
  "type": [
12005
12356
  "string",
12006
12357
  "null"
12007
12358
  ],
12008
- "format": "date-time"
12359
+ "format": "date-time",
12360
+ "example": "2026-04-25T14:30:00.000Z"
12009
12361
  },
12010
12362
  "links": {
12011
12363
  "type": "object",
@@ -12035,6 +12387,7 @@
12035
12387
  "reference_data_id": {
12036
12388
  "type": "string",
12037
12389
  "format": "uuid",
12390
+ "example": "b8c9d0e1-f2a3-4567-bcde-678901234567",
12038
12391
  "description": "UUID of the reference dataset to match against."
12039
12392
  },
12040
12393
  "field_mappings": {
@@ -12112,14 +12465,17 @@
12112
12465
  "properties": {
12113
12466
  "id": {
12114
12467
  "type": "string",
12115
- "format": "uuid"
12468
+ "format": "uuid",
12469
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12116
12470
  },
12117
12471
  "matching_config_id": {
12118
12472
  "type": "string",
12119
- "format": "uuid"
12473
+ "format": "uuid",
12474
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12120
12475
  },
12121
12476
  "status": {
12122
12477
  "type": "string",
12478
+ "example": "completed",
12123
12479
  "enum": [
12124
12480
  "queued",
12125
12481
  "running",
@@ -12156,14 +12512,16 @@
12156
12512
  "string",
12157
12513
  "null"
12158
12514
  ],
12159
- "format": "date-time"
12515
+ "format": "date-time",
12516
+ "example": "2026-04-25T14:30:00.000Z"
12160
12517
  },
12161
12518
  "completed_at": {
12162
12519
  "type": [
12163
12520
  "string",
12164
12521
  "null"
12165
12522
  ],
12166
- "format": "date-time"
12523
+ "format": "date-time",
12524
+ "example": "2026-04-25T14:30:00.000Z"
12167
12525
  },
12168
12526
  "error": {
12169
12527
  "type": [
@@ -12173,7 +12531,8 @@
12173
12531
  },
12174
12532
  "created_at": {
12175
12533
  "type": "string",
12176
- "format": "date-time"
12534
+ "format": "date-time",
12535
+ "example": "2026-04-25T14:30:00.000Z"
12177
12536
  },
12178
12537
  "links": {
12179
12538
  "type": "object",
@@ -12212,11 +12571,13 @@
12212
12571
  "properties": {
12213
12572
  "id": {
12214
12573
  "type": "string",
12215
- "format": "uuid"
12574
+ "format": "uuid",
12575
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12216
12576
  },
12217
12577
  "document_id": {
12218
12578
  "type": "string",
12219
- "format": "uuid"
12579
+ "format": "uuid",
12580
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
12220
12581
  },
12221
12582
  "document_filename": {
12222
12583
  "type": [
@@ -12229,7 +12590,8 @@
12229
12590
  "string",
12230
12591
  "null"
12231
12592
  ],
12232
- "format": "uuid"
12593
+ "format": "uuid",
12594
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12233
12595
  },
12234
12596
  "confidence": {
12235
12597
  "type": "number",
@@ -12239,6 +12601,7 @@
12239
12601
  },
12240
12602
  "status": {
12241
12603
  "type": "string",
12604
+ "example": "completed",
12242
12605
  "description": "Per-result status (e.g. `auto_accepted`, `needs_review`, `no_match`)."
12243
12606
  },
12244
12607
  "evidence": {
@@ -12261,15 +12624,16 @@
12261
12624
  "properties": {
12262
12625
  "id": {
12263
12626
  "type": "string",
12264
- "format": "uuid"
12627
+ "format": "uuid",
12628
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12265
12629
  },
12266
12630
  "name": {
12267
12631
  "type": "string"
12268
12632
  },
12269
12633
  "trigger_type": {
12270
12634
  "type": "string",
12271
- "description": "Trigger kind. Always `document_classified` for rules created via this API.",
12272
- "example": "document_classified"
12635
+ "example": "document_classified",
12636
+ "description": "Trigger kind. Always `document_classified` for rules created via this API."
12273
12637
  },
12274
12638
  "conditions": {
12275
12639
  "type": "object",
@@ -12278,8 +12642,8 @@
12278
12642
  },
12279
12643
  "action_type": {
12280
12644
  "type": "string",
12281
- "description": "Resolved action kind. Defaults to `route_to_schema` when not specified on the request body.",
12282
- "example": "route_to_schema"
12645
+ "example": "route_to_schema",
12646
+ "description": "Resolved action kind. Defaults to `route_to_schema` when not specified on the request body."
12283
12647
  },
12284
12648
  "actions": {
12285
12649
  "type": "object",
@@ -12305,18 +12669,21 @@
12305
12669
  "string",
12306
12670
  "null"
12307
12671
  ],
12308
- "format": "uuid"
12672
+ "format": "uuid",
12673
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12309
12674
  },
12310
12675
  "created_at": {
12311
12676
  "type": "string",
12312
- "format": "date-time"
12677
+ "format": "date-time",
12678
+ "example": "2026-04-25T14:30:00.000Z"
12313
12679
  },
12314
12680
  "updated_at": {
12315
12681
  "type": [
12316
12682
  "string",
12317
12683
  "null"
12318
12684
  ],
12319
- "format": "date-time"
12685
+ "format": "date-time",
12686
+ "example": "2026-04-25T14:30:00.000Z"
12320
12687
  },
12321
12688
  "links": {
12322
12689
  "type": "object",
@@ -12403,11 +12770,13 @@
12403
12770
  "properties": {
12404
12771
  "id": {
12405
12772
  "type": "string",
12406
- "format": "uuid"
12773
+ "format": "uuid",
12774
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12407
12775
  },
12408
12776
  "customer_id": {
12409
12777
  "type": "string",
12410
- "format": "uuid"
12778
+ "format": "uuid",
12779
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12411
12780
  },
12412
12781
  "name": {
12413
12782
  "type": "string",
@@ -12446,7 +12815,8 @@
12446
12815
  "string",
12447
12816
  "null"
12448
12817
  ],
12449
- "format": "date-time"
12818
+ "format": "date-time",
12819
+ "example": "2026-04-25T14:30:00.000Z"
12450
12820
  },
12451
12821
  "last_delivery_status": {
12452
12822
  "type": [
@@ -12456,11 +12826,13 @@
12456
12826
  },
12457
12827
  "created_at": {
12458
12828
  "type": "string",
12459
- "format": "date-time"
12829
+ "format": "date-time",
12830
+ "example": "2026-04-25T14:30:00.000Z"
12460
12831
  },
12461
12832
  "updated_at": {
12462
12833
  "type": "string",
12463
- "format": "date-time"
12834
+ "format": "date-time",
12835
+ "example": "2026-04-25T14:30:00.000Z"
12464
12836
  }
12465
12837
  }
12466
12838
  },
@@ -12687,11 +13059,13 @@
12687
13059
  "properties": {
12688
13060
  "id": {
12689
13061
  "type": "string",
12690
- "format": "uuid"
13062
+ "format": "uuid",
13063
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12691
13064
  },
12692
13065
  "customer_id": {
12693
13066
  "type": "string",
12694
- "format": "uuid"
13067
+ "format": "uuid",
13068
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12695
13069
  },
12696
13070
  "name": {
12697
13071
  "type": "string"
@@ -12705,7 +13079,8 @@
12705
13079
  },
12706
13080
  "destination_id": {
12707
13081
  "type": "string",
12708
- "format": "uuid"
13082
+ "format": "uuid",
13083
+ "example": "e1f2a3b4-c5d6-7890-efab-901234567890"
12709
13084
  },
12710
13085
  "field_map": {
12711
13086
  "$ref": "#/components/schemas/FieldMap"
@@ -12732,11 +13107,13 @@
12732
13107
  },
12733
13108
  "created_at": {
12734
13109
  "type": "string",
12735
- "format": "date-time"
13110
+ "format": "date-time",
13111
+ "example": "2026-04-25T14:30:00.000Z"
12736
13112
  },
12737
13113
  "updated_at": {
12738
13114
  "type": "string",
12739
- "format": "date-time"
13115
+ "format": "date-time",
13116
+ "example": "2026-04-25T14:30:00.000Z"
12740
13117
  }
12741
13118
  }
12742
13119
  },
@@ -12761,7 +13138,8 @@
12761
13138
  },
12762
13139
  "destination_id": {
12763
13140
  "type": "string",
12764
- "format": "uuid"
13141
+ "format": "uuid",
13142
+ "example": "e1f2a3b4-c5d6-7890-efab-901234567890"
12765
13143
  },
12766
13144
  "field_map": {
12767
13145
  "$ref": "#/components/schemas/FieldMap"
@@ -12796,7 +13174,8 @@
12796
13174
  },
12797
13175
  "destination_id": {
12798
13176
  "type": "string",
12799
- "format": "uuid"
13177
+ "format": "uuid",
13178
+ "example": "e1f2a3b4-c5d6-7890-efab-901234567890"
12800
13179
  },
12801
13180
  "field_map": {
12802
13181
  "$ref": "#/components/schemas/FieldMap"
@@ -12832,15 +13211,18 @@
12832
13211
  "properties": {
12833
13212
  "id": {
12834
13213
  "type": "string",
12835
- "format": "uuid"
13214
+ "format": "uuid",
13215
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12836
13216
  },
12837
13217
  "customer_id": {
12838
13218
  "type": "string",
12839
- "format": "uuid"
13219
+ "format": "uuid",
13220
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12840
13221
  },
12841
13222
  "binding_id": {
12842
13223
  "type": "string",
12843
- "format": "uuid"
13224
+ "format": "uuid",
13225
+ "example": "d0e1f2a3-b4c5-6789-defa-890123456789"
12844
13226
  },
12845
13227
  "event_id": {
12846
13228
  "type": "string",
@@ -12852,6 +13234,7 @@
12852
13234
  },
12853
13235
  "status": {
12854
13236
  "type": "string",
13237
+ "example": "completed",
12855
13238
  "enum": [
12856
13239
  "in_flight",
12857
13240
  "succeeded",
@@ -12903,11 +13286,13 @@
12903
13286
  "string",
12904
13287
  "null"
12905
13288
  ],
12906
- "format": "date-time"
13289
+ "format": "date-time",
13290
+ "example": "2026-04-25T14:30:00.000Z"
12907
13291
  },
12908
13292
  "created_at": {
12909
13293
  "type": "string",
12910
- "format": "date-time"
13294
+ "format": "date-time",
13295
+ "example": "2026-04-25T14:30:00.000Z"
12911
13296
  }
12912
13297
  }
12913
13298
  },
@@ -12926,15 +13311,18 @@
12926
13311
  "properties": {
12927
13312
  "id": {
12928
13313
  "type": "string",
12929
- "format": "uuid"
13314
+ "format": "uuid",
13315
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12930
13316
  },
12931
13317
  "customer_id": {
12932
13318
  "type": "string",
12933
- "format": "uuid"
13319
+ "format": "uuid",
13320
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12934
13321
  },
12935
13322
  "binding_id": {
12936
13323
  "type": "string",
12937
- "format": "uuid"
13324
+ "format": "uuid",
13325
+ "example": "d0e1f2a3-b4c5-6789-defa-890123456789"
12938
13326
  },
12939
13327
  "event_id": {
12940
13328
  "type": "string",
@@ -12946,10 +13334,12 @@
12946
13334
  "null"
12947
13335
  ],
12948
13336
  "format": "uuid",
13337
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
12949
13338
  "description": "FK to the last DeliveryItem attempt (nullable — `ON DELETE SET NULL`)."
12950
13339
  },
12951
13340
  "error_code": {
12952
- "type": "string"
13341
+ "type": "string",
13342
+ "example": "delivery_timeout"
12953
13343
  },
12954
13344
  "error_message": {
12955
13345
  "type": [
@@ -12962,7 +13352,8 @@
12962
13352
  },
12963
13353
  "created_at": {
12964
13354
  "type": "string",
12965
- "format": "date-time"
13355
+ "format": "date-time",
13356
+ "example": "2026-04-25T14:30:00.000Z"
12966
13357
  }
12967
13358
  }
12968
13359
  },
@@ -12984,7 +13375,8 @@
12984
13375
  },
12985
13376
  "customer_id": {
12986
13377
  "type": "string",
12987
- "format": "uuid"
13378
+ "format": "uuid",
13379
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
12988
13380
  },
12989
13381
  "event_type": {
12990
13382
  "type": "string"
@@ -13002,14 +13394,16 @@
13002
13394
  },
13003
13395
  "created_at": {
13004
13396
  "type": "string",
13005
- "format": "date-time"
13397
+ "format": "date-time",
13398
+ "example": "2026-04-25T14:30:00.000Z"
13006
13399
  },
13007
13400
  "processed_at": {
13008
13401
  "type": [
13009
13402
  "string",
13010
13403
  "null"
13011
13404
  ],
13012
- "format": "date-time"
13405
+ "format": "date-time",
13406
+ "example": "2026-04-25T14:30:00.000Z"
13013
13407
  },
13014
13408
  "processing_attempts": {
13015
13409
  "type": "integer"
@@ -13046,6 +13440,7 @@
13046
13440
  },
13047
13441
  "label": {
13048
13442
  "type": "string",
13443
+ "example": "Customer Onboarding",
13049
13444
  "description": "Short human-readable label, e.g. \"Document markdown content\". Falls back to `type` if unknown."
13050
13445
  },
13051
13446
  "description": {
@@ -13852,6 +14247,7 @@
13852
14247
  "source_id": {
13853
14248
  "type": "string",
13854
14249
  "format": "uuid",
14250
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
13855
14251
  "description": "Optional source connection UUID to narrow the result set."
13856
14252
  },
13857
14253
  "conditions": {
@@ -13960,31 +14356,36 @@
13960
14356
  "properties": {
13961
14357
  "id": {
13962
14358
  "type": "string",
13963
- "format": "uuid"
14359
+ "format": "uuid",
14360
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
13964
14361
  },
13965
14362
  "run_id": {
13966
14363
  "type": [
13967
14364
  "string",
13968
14365
  "null"
13969
14366
  ],
13970
- "format": "uuid"
14367
+ "format": "uuid",
14368
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
13971
14369
  },
13972
14370
  "document_id": {
13973
14371
  "type": [
13974
14372
  "string",
13975
14373
  "null"
13976
14374
  ],
13977
- "format": "uuid"
14375
+ "format": "uuid",
14376
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
13978
14377
  },
13979
14378
  "schema_id": {
13980
14379
  "type": [
13981
14380
  "string",
13982
14381
  "null"
13983
14382
  ],
13984
- "format": "uuid"
14383
+ "format": "uuid",
14384
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
13985
14385
  },
13986
14386
  "status": {
13987
14387
  "type": "string",
14388
+ "example": "completed",
13988
14389
  "description": "Review status (e.g. `pending`, `approved`, `rejected`)."
13989
14390
  },
13990
14391
  "overall_confidence": {
@@ -14013,11 +14414,13 @@
14013
14414
  "string",
14014
14415
  "null"
14015
14416
  ],
14016
- "format": "date-time"
14417
+ "format": "date-time",
14418
+ "example": "2026-04-25T14:30:00.000Z"
14017
14419
  },
14018
14420
  "created_at": {
14019
14421
  "type": "string",
14020
- "format": "date-time"
14422
+ "format": "date-time",
14423
+ "example": "2026-04-25T14:30:00.000Z"
14021
14424
  },
14022
14425
  "links": {
14023
14426
  "type": "object",
@@ -14095,7 +14498,8 @@
14095
14498
  "description": "Non-empty list of validation-record UUIDs.",
14096
14499
  "items": {
14097
14500
  "type": "string",
14098
- "format": "uuid"
14501
+ "format": "uuid",
14502
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14099
14503
  }
14100
14504
  },
14101
14505
  "action": {
@@ -14135,10 +14539,12 @@
14135
14539
  "properties": {
14136
14540
  "id": {
14137
14541
  "type": "string",
14138
- "format": "uuid"
14542
+ "format": "uuid",
14543
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14139
14544
  },
14140
14545
  "status": {
14141
14546
  "type": "string",
14547
+ "example": "completed",
14142
14548
  "description": "Per-record outcome (`approved`, `rejected`, or `error`)."
14143
14549
  },
14144
14550
  "error": {
@@ -14159,7 +14565,8 @@
14159
14565
  "properties": {
14160
14566
  "id": {
14161
14567
  "type": "string",
14162
- "format": "uuid"
14568
+ "format": "uuid",
14569
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14163
14570
  },
14164
14571
  "name": {
14165
14572
  "type": "string"
@@ -14175,7 +14582,8 @@
14175
14582
  "string",
14176
14583
  "null"
14177
14584
  ],
14178
- "format": "uuid"
14585
+ "format": "uuid",
14586
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
14179
14587
  },
14180
14588
  "document_count": {
14181
14589
  "type": [
@@ -14185,7 +14593,8 @@
14185
14593
  },
14186
14594
  "created_at": {
14187
14595
  "type": "string",
14188
- "format": "date-time"
14596
+ "format": "date-time",
14597
+ "example": "2026-04-25T14:30:00.000Z"
14189
14598
  },
14190
14599
  "links": {
14191
14600
  "type": "object",
@@ -14236,14 +14645,16 @@
14236
14645
  "properties": {
14237
14646
  "id": {
14238
14647
  "type": "string",
14239
- "format": "uuid"
14648
+ "format": "uuid",
14649
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14240
14650
  },
14241
14651
  "document_id": {
14242
14652
  "type": [
14243
14653
  "string",
14244
14654
  "null"
14245
14655
  ],
14246
- "format": "uuid"
14656
+ "format": "uuid",
14657
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
14247
14658
  },
14248
14659
  "expected_data": {
14249
14660
  "type": "object",
@@ -14258,7 +14669,8 @@
14258
14669
  },
14259
14670
  "created_at": {
14260
14671
  "type": "string",
14261
- "format": "date-time"
14672
+ "format": "date-time",
14673
+ "example": "2026-04-25T14:30:00.000Z"
14262
14674
  }
14263
14675
  }
14264
14676
  },
@@ -14271,7 +14683,8 @@
14271
14683
  "properties": {
14272
14684
  "id": {
14273
14685
  "type": "string",
14274
- "format": "uuid"
14686
+ "format": "uuid",
14687
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14275
14688
  },
14276
14689
  "name": {
14277
14690
  "type": [
@@ -14284,17 +14697,20 @@
14284
14697
  "string",
14285
14698
  "null"
14286
14699
  ],
14287
- "format": "uuid"
14700
+ "format": "uuid",
14701
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14288
14702
  },
14289
14703
  "user_schema_id": {
14290
14704
  "type": [
14291
14705
  "string",
14292
14706
  "null"
14293
14707
  ],
14294
- "format": "uuid"
14708
+ "format": "uuid",
14709
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
14295
14710
  },
14296
14711
  "status": {
14297
14712
  "type": "string",
14713
+ "example": "completed",
14298
14714
  "description": "Benchmark run status."
14299
14715
  },
14300
14716
  "accuracy_overall": {
@@ -14347,18 +14763,21 @@
14347
14763
  "string",
14348
14764
  "null"
14349
14765
  ],
14350
- "format": "uuid"
14766
+ "format": "uuid",
14767
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14351
14768
  },
14352
14769
  "created_at": {
14353
14770
  "type": "string",
14354
- "format": "date-time"
14771
+ "format": "date-time",
14772
+ "example": "2026-04-25T14:30:00.000Z"
14355
14773
  },
14356
14774
  "completed_at": {
14357
14775
  "type": [
14358
14776
  "string",
14359
14777
  "null"
14360
14778
  ],
14361
- "format": "date-time"
14779
+ "format": "date-time",
14780
+ "example": "2026-04-25T14:30:00.000Z"
14362
14781
  },
14363
14782
  "links": {
14364
14783
  "type": "object",
@@ -14396,21 +14815,24 @@
14396
14815
  "properties": {
14397
14816
  "id": {
14398
14817
  "type": "string",
14399
- "format": "uuid"
14818
+ "format": "uuid",
14819
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14400
14820
  },
14401
14821
  "document_id": {
14402
14822
  "type": [
14403
14823
  "string",
14404
14824
  "null"
14405
14825
  ],
14406
- "format": "uuid"
14826
+ "format": "uuid",
14827
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
14407
14828
  },
14408
14829
  "ground_truth_entry_id": {
14409
14830
  "type": [
14410
14831
  "string",
14411
14832
  "null"
14412
14833
  ],
14413
- "format": "uuid"
14834
+ "format": "uuid",
14835
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14414
14836
  },
14415
14837
  "accuracy": {
14416
14838
  "type": [
@@ -14428,7 +14850,8 @@
14428
14850
  },
14429
14851
  "created_at": {
14430
14852
  "type": "string",
14431
- "format": "date-time"
14853
+ "format": "date-time",
14854
+ "example": "2026-04-25T14:30:00.000Z"
14432
14855
  }
14433
14856
  }
14434
14857
  },
@@ -14448,10 +14871,12 @@
14448
14871
  "properties": {
14449
14872
  "id": {
14450
14873
  "type": "string",
14451
- "format": "uuid"
14874
+ "format": "uuid",
14875
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14452
14876
  },
14453
14877
  "status": {
14454
14878
  "type": "string",
14879
+ "example": "completed",
14455
14880
  "enum": [
14456
14881
  "accumulating",
14457
14882
  "submitted",
@@ -14463,6 +14888,7 @@
14463
14888
  },
14464
14889
  "provider": {
14465
14890
  "type": "string",
14891
+ "example": "anthropic",
14466
14892
  "enum": [
14467
14893
  "anthropic",
14468
14894
  "bedrock"
@@ -14485,14 +14911,16 @@
14485
14911
  "string",
14486
14912
  "null"
14487
14913
  ],
14488
- "format": "date-time"
14914
+ "format": "date-time",
14915
+ "example": "2026-04-25T14:30:00.000Z"
14489
14916
  },
14490
14917
  "completed_at": {
14491
14918
  "type": [
14492
14919
  "string",
14493
14920
  "null"
14494
14921
  ],
14495
- "format": "date-time"
14922
+ "format": "date-time",
14923
+ "example": "2026-04-25T14:30:00.000Z"
14496
14924
  },
14497
14925
  "error_message": {
14498
14926
  "type": [
@@ -14502,11 +14930,13 @@
14502
14930
  },
14503
14931
  "created_at": {
14504
14932
  "type": "string",
14505
- "format": "date-time"
14933
+ "format": "date-time",
14934
+ "example": "2026-04-25T14:30:00.000Z"
14506
14935
  },
14507
14936
  "updated_at": {
14508
14937
  "type": "string",
14509
- "format": "date-time"
14938
+ "format": "date-time",
14939
+ "example": "2026-04-25T14:30:00.000Z"
14510
14940
  },
14511
14941
  "links": {
14512
14942
  "type": "object",
@@ -14539,11 +14969,13 @@
14539
14969
  "properties": {
14540
14970
  "id": {
14541
14971
  "type": "string",
14542
- "format": "uuid"
14972
+ "format": "uuid",
14973
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14543
14974
  },
14544
14975
  "document_id": {
14545
14976
  "type": "string",
14546
- "format": "uuid"
14977
+ "format": "uuid",
14978
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
14547
14979
  },
14548
14980
  "document_filename": {
14549
14981
  "type": [
@@ -14558,7 +14990,8 @@
14558
14990
  ]
14559
14991
  },
14560
14992
  "status": {
14561
- "type": "string"
14993
+ "type": "string",
14994
+ "example": "completed"
14562
14995
  },
14563
14996
  "error_message": {
14564
14997
  "type": [
@@ -14568,14 +15001,16 @@
14568
15001
  },
14569
15002
  "created_at": {
14570
15003
  "type": "string",
14571
- "format": "date-time"
15004
+ "format": "date-time",
15005
+ "example": "2026-04-25T14:30:00.000Z"
14572
15006
  },
14573
15007
  "processed_at": {
14574
15008
  "type": [
14575
15009
  "string",
14576
15010
  "null"
14577
15011
  ],
14578
- "format": "date-time"
15012
+ "format": "date-time",
15013
+ "example": "2026-04-25T14:30:00.000Z"
14579
15014
  }
14580
15015
  }
14581
15016
  }
@@ -14600,6 +15035,7 @@
14600
15035
  },
14601
15036
  "case_key": {
14602
15037
  "type": "string",
15038
+ "example": "7a3f2b1c",
14603
15039
  "pattern": "^[a-fA-F0-9]{8,64}$"
14604
15040
  },
14605
15041
  "label": {
@@ -14616,7 +15052,8 @@
14616
15052
  "string",
14617
15053
  "null"
14618
15054
  ],
14619
- "format": "date-time"
15055
+ "format": "date-time",
15056
+ "example": "2026-04-25T14:30:00.000Z"
14620
15057
  },
14621
15058
  "links": {
14622
15059
  "type": "object",
@@ -14642,7 +15079,8 @@
14642
15079
  "type": "string"
14643
15080
  },
14644
15081
  "case_key": {
14645
- "type": "string"
15082
+ "type": "string",
15083
+ "example": "7a3f2b1c"
14646
15084
  },
14647
15085
  "label": {
14648
15086
  "type": [
@@ -14663,10 +15101,12 @@
14663
15101
  "properties": {
14664
15102
  "id": {
14665
15103
  "type": "string",
14666
- "format": "uuid"
15104
+ "format": "uuid",
15105
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14667
15106
  },
14668
15107
  "filename": {
14669
- "type": "string"
15108
+ "type": "string",
15109
+ "example": "invoice-042.pdf"
14670
15110
  },
14671
15111
  "document_type": {
14672
15112
  "type": [
@@ -14679,7 +15119,8 @@
14679
15119
  "string",
14680
15120
  "null"
14681
15121
  ],
14682
- "format": "date-time"
15122
+ "format": "date-time",
15123
+ "example": "2026-04-25T14:30:00.000Z"
14683
15124
  }
14684
15125
  }
14685
15126
  }
@@ -14692,7 +15133,8 @@
14692
15133
  "string",
14693
15134
  "null"
14694
15135
  ],
14695
- "format": "date-time"
15136
+ "format": "date-time",
15137
+ "example": "2026-04-25T14:30:00.000Z"
14696
15138
  },
14697
15139
  "links": {
14698
15140
  "type": "object",
@@ -14718,7 +15160,8 @@
14718
15160
  "properties": {
14719
15161
  "id": {
14720
15162
  "type": "string",
14721
- "format": "uuid"
15163
+ "format": "uuid",
15164
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14722
15165
  },
14723
15166
  "name": {
14724
15167
  "type": "string"
@@ -14762,10 +15205,12 @@
14762
15205
  "properties": {
14763
15206
  "id": {
14764
15207
  "type": "string",
14765
- "format": "uuid"
15208
+ "format": "uuid",
15209
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14766
15210
  },
14767
15211
  "canonical_name": {
14768
- "type": "string"
15212
+ "type": "string",
15213
+ "example": "invoice_number"
14769
15214
  },
14770
15215
  "display_name": {
14771
15216
  "type": [
@@ -14774,7 +15219,8 @@
14774
15219
  ]
14775
15220
  },
14776
15221
  "data_type": {
14777
- "type": "string"
15222
+ "type": "string",
15223
+ "example": "string"
14778
15224
  },
14779
15225
  "tier": {
14780
15226
  "type": "integer"
@@ -14796,11 +15242,13 @@
14796
15242
  },
14797
15243
  "created_at": {
14798
15244
  "type": "string",
14799
- "format": "date-time"
15245
+ "format": "date-time",
15246
+ "example": "2026-04-25T14:30:00.000Z"
14800
15247
  },
14801
15248
  "updated_at": {
14802
15249
  "type": "string",
14803
- "format": "date-time"
15250
+ "format": "date-time",
15251
+ "example": "2026-04-25T14:30:00.000Z"
14804
15252
  },
14805
15253
  "links": {
14806
15254
  "type": "object",
@@ -14831,11 +15279,13 @@
14831
15279
  "properties": {
14832
15280
  "id": {
14833
15281
  "type": "string",
14834
- "format": "uuid"
15282
+ "format": "uuid",
15283
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14835
15284
  },
14836
15285
  "document_id": {
14837
15286
  "type": "string",
14838
- "format": "uuid"
15287
+ "format": "uuid",
15288
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
14839
15289
  },
14840
15290
  "document_filename": {
14841
15291
  "type": [
@@ -14854,7 +15304,8 @@
14854
15304
  },
14855
15305
  "created_at": {
14856
15306
  "type": "string",
14857
- "format": "date-time"
15307
+ "format": "date-time",
15308
+ "example": "2026-04-25T14:30:00.000Z"
14858
15309
  }
14859
15310
  }
14860
15311
  }
@@ -14878,10 +15329,12 @@
14878
15329
  "properties": {
14879
15330
  "id": {
14880
15331
  "type": "string",
14881
- "format": "uuid"
15332
+ "format": "uuid",
15333
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14882
15334
  },
14883
15335
  "canonical_name": {
14884
- "type": "string"
15336
+ "type": "string",
15337
+ "example": "invoice_number"
14885
15338
  },
14886
15339
  "display_name": {
14887
15340
  "type": [
@@ -14890,7 +15343,8 @@
14890
15343
  ]
14891
15344
  },
14892
15345
  "data_type": {
14893
- "type": "string"
15346
+ "type": "string",
15347
+ "example": "string"
14894
15348
  },
14895
15349
  "tier": {
14896
15350
  "type": "integer"
@@ -14937,7 +15391,8 @@
14937
15391
  "properties": {
14938
15392
  "id": {
14939
15393
  "type": "string",
14940
- "format": "uuid"
15394
+ "format": "uuid",
15395
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
14941
15396
  },
14942
15397
  "name": {
14943
15398
  "type": "string"
@@ -14954,7 +15409,8 @@
14954
15409
  },
14955
15410
  "created_at": {
14956
15411
  "type": "string",
14957
- "format": "date-time"
15412
+ "format": "date-time",
15413
+ "example": "2026-04-25T14:30:00.000Z"
14958
15414
  },
14959
15415
  "links": {
14960
15416
  "type": "object",
@@ -14987,11 +15443,13 @@
14987
15443
  "properties": {
14988
15444
  "from": {
14989
15445
  "type": "string",
14990
- "format": "date-time"
15446
+ "format": "date-time",
15447
+ "example": "2026-04-25T14:30:00.000Z"
14991
15448
  },
14992
15449
  "to": {
14993
15450
  "type": "string",
14994
- "format": "date-time"
15451
+ "format": "date-time",
15452
+ "example": "2026-04-25T14:30:00.000Z"
14995
15453
  }
14996
15454
  }
14997
15455
  },
@@ -15065,7 +15523,8 @@
15065
15523
  "properties": {
15066
15524
  "document_id": {
15067
15525
  "type": "string",
15068
- "format": "uuid"
15526
+ "format": "uuid",
15527
+ "example": "f0e1d2c3-b4a5-9687-8765-432109876543"
15069
15528
  },
15070
15529
  "totals": {
15071
15530
  "type": "object",
@@ -15131,7 +15590,8 @@
15131
15590
  },
15132
15591
  "created_at": {
15133
15592
  "type": "string",
15134
- "format": "date-time"
15593
+ "format": "date-time",
15594
+ "example": "2026-04-25T14:30:00.000Z"
15135
15595
  }
15136
15596
  }
15137
15597
  }
@@ -15160,14 +15620,17 @@
15160
15620
  "properties": {
15161
15621
  "id": {
15162
15622
  "type": "string",
15163
- "format": "uuid"
15623
+ "format": "uuid",
15624
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15164
15625
  },
15165
15626
  "source_run_id": {
15166
15627
  "type": "string",
15167
- "format": "uuid"
15628
+ "format": "uuid",
15629
+ "example": "f2a3b4c5-d6e7-8901-fabc-012345678901"
15168
15630
  },
15169
15631
  "status": {
15170
15632
  "type": "string",
15633
+ "example": "completed",
15171
15634
  "enum": [
15172
15635
  "pending",
15173
15636
  "running",
@@ -15183,14 +15646,16 @@
15183
15646
  },
15184
15647
  "created_at": {
15185
15648
  "type": "string",
15186
- "format": "date-time"
15649
+ "format": "date-time",
15650
+ "example": "2026-04-25T14:30:00.000Z"
15187
15651
  },
15188
15652
  "completed_at": {
15189
15653
  "type": [
15190
15654
  "string",
15191
15655
  "null"
15192
15656
  ],
15193
- "format": "date-time"
15657
+ "format": "date-time",
15658
+ "example": "2026-04-25T14:30:00.000Z"
15194
15659
  },
15195
15660
  "links": {
15196
15661
  "type": "object",
@@ -15213,10 +15678,12 @@
15213
15678
  ],
15214
15679
  "properties": {
15215
15680
  "field_name": {
15216
- "type": "string"
15681
+ "type": "string",
15682
+ "example": "invoice_number"
15217
15683
  },
15218
15684
  "category": {
15219
15685
  "type": "string",
15686
+ "example": "identity",
15220
15687
  "enum": [
15221
15688
  "identity",
15222
15689
  "transaction",
@@ -15248,7 +15715,8 @@
15248
15715
  "properties": {
15249
15716
  "id": {
15250
15717
  "type": "string",
15251
- "format": "uuid"
15718
+ "format": "uuid",
15719
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15252
15720
  },
15253
15721
  "name": {
15254
15722
  "type": "string"
@@ -15267,11 +15735,13 @@
15267
15735
  },
15268
15736
  "created_at": {
15269
15737
  "type": "string",
15270
- "format": "date-time"
15738
+ "format": "date-time",
15739
+ "example": "2026-04-25T14:30:00.000Z"
15271
15740
  },
15272
15741
  "updated_at": {
15273
15742
  "type": "string",
15274
- "format": "date-time"
15743
+ "format": "date-time",
15744
+ "example": "2026-04-25T14:30:00.000Z"
15275
15745
  },
15276
15746
  "links": {
15277
15747
  "type": "object",
@@ -15297,11 +15767,13 @@
15297
15767
  "properties": {
15298
15768
  "id": {
15299
15769
  "type": "string",
15300
- "format": "uuid"
15770
+ "format": "uuid",
15771
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15301
15772
  },
15302
15773
  "class_id": {
15303
15774
  "type": "string",
15304
- "format": "uuid"
15775
+ "format": "uuid",
15776
+ "example": "a7b8c9d0-e1f2-3456-abcd-567890123456"
15305
15777
  },
15306
15778
  "from_version": {
15307
15779
  "type": [
@@ -15317,6 +15789,7 @@
15317
15789
  },
15318
15790
  "status": {
15319
15791
  "type": "string",
15792
+ "example": "completed",
15320
15793
  "enum": [
15321
15794
  "pending",
15322
15795
  "approved",
@@ -15333,14 +15806,16 @@
15333
15806
  },
15334
15807
  "created_at": {
15335
15808
  "type": "string",
15336
- "format": "date-time"
15809
+ "format": "date-time",
15810
+ "example": "2026-04-25T14:30:00.000Z"
15337
15811
  },
15338
15812
  "decided_at": {
15339
15813
  "type": [
15340
15814
  "string",
15341
15815
  "null"
15342
15816
  ],
15343
- "format": "date-time"
15817
+ "format": "date-time",
15818
+ "example": "2026-04-25T14:30:00.000Z"
15344
15819
  }
15345
15820
  }
15346
15821
  },
@@ -15355,7 +15830,8 @@
15355
15830
  "properties": {
15356
15831
  "id": {
15357
15832
  "type": "string",
15358
- "format": "uuid"
15833
+ "format": "uuid",
15834
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15359
15835
  },
15360
15836
  "name": {
15361
15837
  "type": "string"
@@ -15379,11 +15855,13 @@
15379
15855
  },
15380
15856
  "created_at": {
15381
15857
  "type": "string",
15382
- "format": "date-time"
15858
+ "format": "date-time",
15859
+ "example": "2026-04-25T14:30:00.000Z"
15383
15860
  },
15384
15861
  "updated_at": {
15385
15862
  "type": "string",
15386
- "format": "date-time"
15863
+ "format": "date-time",
15864
+ "example": "2026-04-25T14:30:00.000Z"
15387
15865
  }
15388
15866
  }
15389
15867
  },
@@ -15425,7 +15903,8 @@
15425
15903
  "properties": {
15426
15904
  "id": {
15427
15905
  "type": "string",
15428
- "format": "uuid"
15906
+ "format": "uuid",
15907
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15429
15908
  },
15430
15909
  "name": {
15431
15910
  "type": "string"
@@ -15441,7 +15920,8 @@
15441
15920
  "string",
15442
15921
  "null"
15443
15922
  ],
15444
- "format": "uuid"
15923
+ "format": "uuid",
15924
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
15445
15925
  },
15446
15926
  "rules": {
15447
15927
  "type": "array",
@@ -15450,7 +15930,8 @@
15450
15930
  "properties": {
15451
15931
  "id": {
15452
15932
  "type": "string",
15453
- "format": "uuid"
15933
+ "format": "uuid",
15934
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15454
15935
  },
15455
15936
  "type": {
15456
15937
  "type": "string"
@@ -15464,11 +15945,13 @@
15464
15945
  },
15465
15946
  "created_at": {
15466
15947
  "type": "string",
15467
- "format": "date-time"
15948
+ "format": "date-time",
15949
+ "example": "2026-04-25T14:30:00.000Z"
15468
15950
  },
15469
15951
  "updated_at": {
15470
15952
  "type": "string",
15471
- "format": "date-time"
15953
+ "format": "date-time",
15954
+ "example": "2026-04-25T14:30:00.000Z"
15472
15955
  }
15473
15956
  }
15474
15957
  },
@@ -15486,7 +15969,8 @@
15486
15969
  },
15487
15970
  "schema_id": {
15488
15971
  "type": "string",
15489
- "format": "uuid"
15972
+ "format": "uuid",
15973
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
15490
15974
  }
15491
15975
  }
15492
15976
  },
@@ -15500,7 +15984,8 @@
15500
15984
  "properties": {
15501
15985
  "id": {
15502
15986
  "type": "string",
15503
- "format": "uuid"
15987
+ "format": "uuid",
15988
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15504
15989
  },
15505
15990
  "name": {
15506
15991
  "type": "string"
@@ -15519,7 +16004,8 @@
15519
16004
  },
15520
16005
  "created_at": {
15521
16006
  "type": "string",
15522
- "format": "date-time"
16007
+ "format": "date-time",
16008
+ "example": "2026-04-25T14:30:00.000Z"
15523
16009
  },
15524
16010
  "links": {
15525
16011
  "type": "object",
@@ -15541,21 +16027,25 @@
15541
16027
  "properties": {
15542
16028
  "id": {
15543
16029
  "type": "string",
15544
- "format": "uuid"
16030
+ "format": "uuid",
16031
+ "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
15545
16032
  },
15546
16033
  "golden_sample_id": {
15547
16034
  "type": "string",
15548
- "format": "uuid"
16035
+ "format": "uuid",
16036
+ "example": "e5f6a7b8-c9d0-1234-efab-345678901234"
15549
16037
  },
15550
16038
  "schema_id": {
15551
16039
  "type": [
15552
16040
  "string",
15553
16041
  "null"
15554
16042
  ],
15555
- "format": "uuid"
16043
+ "format": "uuid",
16044
+ "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
15556
16045
  },
15557
16046
  "status": {
15558
16047
  "type": "string",
16048
+ "example": "completed",
15559
16049
  "enum": [
15560
16050
  "pending",
15561
16051
  "running",
@@ -15578,14 +16068,16 @@
15578
16068
  },
15579
16069
  "created_at": {
15580
16070
  "type": "string",
15581
- "format": "date-time"
16071
+ "format": "date-time",
16072
+ "example": "2026-04-25T14:30:00.000Z"
15582
16073
  },
15583
16074
  "completed_at": {
15584
16075
  "type": [
15585
16076
  "string",
15586
16077
  "null"
15587
16078
  ],
15588
- "format": "date-time"
16079
+ "format": "date-time",
16080
+ "example": "2026-04-25T14:30:00.000Z"
15589
16081
  },
15590
16082
  "links": {
15591
16083
  "type": "object",