@talonic/docs 0.21.0 → 0.21.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/seo.js CHANGED
@@ -71,8 +71,8 @@ var openapi_default = {
71
71
  description: "Queue of validation records requiring human review; supports single- and batch-action approvals/rejections."
72
72
  },
73
73
  {
74
- name: "Quality",
75
- description: "Ground truth datasets and benchmark runs for measuring extraction accuracy."
74
+ name: "Benchmarks",
75
+ description: "Ground-truth datasets and benchmark runs measuring extraction accuracy."
76
76
  },
77
77
  {
78
78
  name: "Batches",
@@ -126,10 +126,6 @@ var openapi_default = {
126
126
  name: "Telemetry",
127
127
  description: "Aggregate structuring metrics \u2014 capture hit rate, synthesize rate, strategy distribution, and tier funnel breakdowns per schema or run."
128
128
  },
129
- {
130
- name: "Validation",
131
- description: "Ground-truth dataset management and validation runs for measuring extraction accuracy."
132
- },
133
129
  {
134
130
  name: "Credits",
135
131
  description: "Credit balance, usage history, daily breakdown, and per-request usage log."
@@ -173,6 +169,14 @@ var openapi_default = {
173
169
  {
174
170
  name: "Webhooks",
175
171
  description: "Outbound HMAC-signed event webhooks \u2014 configure endpoints and read the event catalog, delivery format, signature scheme, and retry policy."
172
+ },
173
+ {
174
+ name: "Events",
175
+ description: "The tenant event feed \u2014 the timeline of everything that happened (extractions, run completions, review verdicts, delivery outcomes). The same rows webhooks fan out from, so missed webhook deliveries can be reconciled against this feed."
176
+ },
177
+ {
178
+ name: "Provenance",
179
+ description: "Document-level provenance \u2014 deterministic (subject, predicate, object) claims synthesized from captured fields and spans, each carrying its evidence quote and grounded flag."
176
180
  }
177
181
  ],
178
182
  paths: {
@@ -369,6 +373,9 @@ var openapi_default = {
369
373
  "401": {
370
374
  $ref: "#/components/responses/Unauthorized"
371
375
  },
376
+ "402": {
377
+ $ref: "#/components/responses/InsufficientCredits"
378
+ },
372
379
  "403": {
373
380
  $ref: "#/components/responses/Forbidden"
374
381
  },
@@ -5123,7 +5130,7 @@ var openapi_default = {
5123
5130
  operationId: "listGroundTruthDatasets",
5124
5131
  summary: "List ground truth datasets",
5125
5132
  tags: [
5126
- "Quality"
5133
+ "Benchmarks"
5127
5134
  ],
5128
5135
  parameters: [
5129
5136
  {
@@ -5185,7 +5192,7 @@ var openapi_default = {
5185
5192
  operationId: "createGroundTruthDataset",
5186
5193
  summary: "Create a ground truth dataset",
5187
5194
  tags: [
5188
- "Quality"
5195
+ "Benchmarks"
5189
5196
  ],
5190
5197
  requestBody: {
5191
5198
  required: true,
@@ -5236,7 +5243,7 @@ var openapi_default = {
5236
5243
  summary: "Get a ground truth dataset",
5237
5244
  description: "Returns the dataset together with its sample entries (curated known-correct values).",
5238
5245
  tags: [
5239
- "Quality"
5246
+ "Benchmarks"
5240
5247
  ],
5241
5248
  parameters: [
5242
5249
  {
@@ -5271,7 +5278,7 @@ var openapi_default = {
5271
5278
  operationId: "listBenchmarkRuns",
5272
5279
  summary: "List benchmark runs",
5273
5280
  tags: [
5274
- "Quality"
5281
+ "Benchmarks"
5275
5282
  ],
5276
5283
  parameters: [
5277
5284
  {
@@ -5336,7 +5343,7 @@ var openapi_default = {
5336
5343
  summary: "Get a benchmark run",
5337
5344
  description: "Returns the benchmark run together with its per-document results.",
5338
5345
  tags: [
5339
- "Quality"
5346
+ "Benchmarks"
5340
5347
  ],
5341
5348
  parameters: [
5342
5349
  {
@@ -8718,7 +8725,7 @@ var openapi_default = {
8718
8725
  summary: "List ground-truth datasets",
8719
8726
  description: "Returns all ground-truth datasets for the customer.",
8720
8727
  tags: [
8721
- "Validation"
8728
+ "Benchmarks"
8722
8729
  ],
8723
8730
  parameters: [
8724
8731
  {
@@ -8771,7 +8778,7 @@ var openapi_default = {
8771
8778
  operationId: "getGroundTruth",
8772
8779
  summary: "Get a ground-truth dataset",
8773
8780
  tags: [
8774
- "Validation"
8781
+ "Benchmarks"
8775
8782
  ],
8776
8783
  parameters: [
8777
8784
  {
@@ -8804,7 +8811,7 @@ var openapi_default = {
8804
8811
  operationId: "deleteGroundTruth",
8805
8812
  summary: "Delete a ground-truth dataset",
8806
8813
  tags: [
8807
- "Validation"
8814
+ "Benchmarks"
8808
8815
  ],
8809
8816
  parameters: [
8810
8817
  {
@@ -8839,7 +8846,7 @@ var openapi_default = {
8839
8846
  operationId: "listValidationRuns",
8840
8847
  summary: "List validation runs",
8841
8848
  tags: [
8842
- "Validation"
8849
+ "Benchmarks"
8843
8850
  ],
8844
8851
  parameters: [
8845
8852
  {
@@ -8891,7 +8898,7 @@ var openapi_default = {
8891
8898
  summary: "Create a validation run",
8892
8899
  description: "Start a new validation run against a ground-truth dataset.",
8893
8900
  tags: [
8894
- "Validation"
8901
+ "Benchmarks"
8895
8902
  ],
8896
8903
  requestBody: {
8897
8904
  required: true,
@@ -8948,7 +8955,7 @@ var openapi_default = {
8948
8955
  operationId: "getValidationRun",
8949
8956
  summary: "Get a validation run",
8950
8957
  tags: [
8951
- "Validation"
8958
+ "Benchmarks"
8952
8959
  ],
8953
8960
  parameters: [
8954
8961
  {
@@ -8981,7 +8988,7 @@ var openapi_default = {
8981
8988
  operationId: "deleteValidationRun",
8982
8989
  summary: "Delete a validation run",
8983
8990
  tags: [
8984
- "Validation"
8991
+ "Benchmarks"
8985
8992
  ],
8986
8993
  parameters: [
8987
8994
  {
@@ -9017,7 +9024,7 @@ var openapi_default = {
9017
9024
  summary: "Get validation run results",
9018
9025
  description: "Returns per-document and per-field accuracy results for the validation run.",
9019
9026
  tags: [
9020
- "Validation"
9027
+ "Benchmarks"
9021
9028
  ],
9022
9029
  parameters: [
9023
9030
  {
@@ -9407,17 +9414,102 @@ var openapi_default = {
9407
9414
  }
9408
9415
  }
9409
9416
  },
9417
+ "/v1/billing/packs": {
9418
+ get: {
9419
+ operationId: "getBillingPacks",
9420
+ summary: "List purchasable credit packs",
9421
+ description: "The self-serve credit-purchase catalog: flat prepaid packs\n(1,000 credits = 1 EUR, no volume bonuses). Buy via the checkout URL\nfrom `GET /v1/billing/upgrade-link`.\n",
9422
+ tags: [
9423
+ "Billing"
9424
+ ],
9425
+ responses: {
9426
+ "200": {
9427
+ description: "Credit pack catalog.",
9428
+ content: {
9429
+ "application/json": {
9430
+ schema: {
9431
+ type: "object",
9432
+ required: [
9433
+ "currency",
9434
+ "packs"
9435
+ ],
9436
+ properties: {
9437
+ currency: {
9438
+ type: "string",
9439
+ example: "EUR"
9440
+ },
9441
+ packs: {
9442
+ type: "array",
9443
+ items: {
9444
+ type: "object",
9445
+ required: [
9446
+ "key",
9447
+ "eur",
9448
+ "credits"
9449
+ ],
9450
+ properties: {
9451
+ key: {
9452
+ type: "string",
9453
+ example: "50"
9454
+ },
9455
+ lookupKey: {
9456
+ type: "string",
9457
+ example: "credits_pack_50"
9458
+ },
9459
+ eur: {
9460
+ type: "number",
9461
+ example: 50
9462
+ },
9463
+ credits: {
9464
+ type: "integer",
9465
+ example: 5e4
9466
+ }
9467
+ }
9468
+ }
9469
+ }
9470
+ }
9471
+ }
9472
+ }
9473
+ }
9474
+ },
9475
+ "401": {
9476
+ $ref: "#/components/responses/Unauthorized"
9477
+ },
9478
+ "429": {
9479
+ $ref: "#/components/responses/RateLimitExceeded"
9480
+ }
9481
+ }
9482
+ }
9483
+ },
9410
9484
  "/v1/billing/upgrade-link": {
9411
9485
  get: {
9412
9486
  operationId: "getBillingUpgradeLink",
9413
- summary: "Get an upgrade link",
9414
- description: 'Returns a URL the agent can hand to a human to upgrade the plan or add\npayment. When a hosted billing portal exists this is a portal session\nURL; until then it is a deep link into the dashboard billing settings\n(`provider: "dashboard"`). A human must complete the upgrade.\n',
9487
+ summary: "Get a buy-credits link",
9488
+ description: 'Returns a URL the agent hands to a human to buy prepaid credits. With\nbilling configured this is a real Stripe hosted-Checkout session\n(`provider: "stripe"`) for the selected pack; credits are available\nseconds after the human completes payment. Falls back to a dashboard\nbilling deep link (`provider: "dashboard"`) on deployments without\nStripe. A human must complete the payment either way.\n',
9415
9489
  tags: [
9416
9490
  "Billing"
9417
9491
  ],
9492
+ parameters: [
9493
+ {
9494
+ name: "pack",
9495
+ in: "query",
9496
+ required: false,
9497
+ schema: {
9498
+ type: "string",
9499
+ enum: [
9500
+ "10",
9501
+ "50",
9502
+ "250",
9503
+ "1000"
9504
+ ],
9505
+ default: "50"
9506
+ },
9507
+ description: "Credit pack to check out (see `GET /v1/billing/packs`)."
9508
+ }
9509
+ ],
9418
9510
  responses: {
9419
9511
  "200": {
9420
- description: "Upgrade link.",
9512
+ description: "Buy-credits link.",
9421
9513
  content: {
9422
9514
  "application/json": {
9423
9515
  schema: {
@@ -9431,16 +9523,20 @@ var openapi_default = {
9431
9523
  url: {
9432
9524
  type: "string",
9433
9525
  format: "uri",
9434
- example: "https://app.talonic.com/settings/billing?upgrade=1"
9526
+ example: "https://checkout.stripe.com/c/pay/cs_test_..."
9435
9527
  },
9436
9528
  provider: {
9437
9529
  type: "string",
9438
- description: "'dashboard' (deep link) or 'stripe' (portal session) once a portal exists.",
9439
- example: "dashboard"
9530
+ description: "'stripe' (hosted Checkout session) or 'dashboard' (deep link fallback).",
9531
+ example: "stripe"
9440
9532
  },
9441
9533
  requires_human: {
9442
9534
  type: "boolean"
9443
9535
  },
9536
+ pack: {
9537
+ type: "object",
9538
+ description: "The selected pack (stripe provider only)."
9539
+ },
9444
9540
  message: {
9445
9541
  type: "string"
9446
9542
  }
@@ -11666,7 +11762,7 @@ var openapi_default = {
11666
11762
  operationId: "listGroundTruthEntries",
11667
11763
  summary: "List entries in a ground truth dataset",
11668
11764
  tags: [
11669
- "Quality"
11765
+ "Benchmarks"
11670
11766
  ],
11671
11767
  parameters: [
11672
11768
  {
@@ -11720,7 +11816,7 @@ var openapi_default = {
11720
11816
  operationId: "createGroundTruthEntry",
11721
11817
  summary: "Add an entry to a ground truth dataset",
11722
11818
  tags: [
11723
- "Quality"
11819
+ "Benchmarks"
11724
11820
  ],
11725
11821
  parameters: [
11726
11822
  {
@@ -11786,7 +11882,7 @@ var openapi_default = {
11786
11882
  operationId: "updateGroundTruthEntry",
11787
11883
  summary: "Update a ground truth entry",
11788
11884
  tags: [
11789
- "Quality"
11885
+ "Benchmarks"
11790
11886
  ],
11791
11887
  parameters: [
11792
11888
  {
@@ -11850,7 +11946,7 @@ var openapi_default = {
11850
11946
  operationId: "deleteGroundTruthEntry",
11851
11947
  summary: "Delete a ground truth entry",
11852
11948
  tags: [
11853
- "Quality"
11949
+ "Benchmarks"
11854
11950
  ],
11855
11951
  parameters: [
11856
11952
  {
@@ -11897,7 +11993,7 @@ var openapi_default = {
11897
11993
  summary: "Compare two benchmark runs",
11898
11994
  description: "Returns both benchmark runs side by side together with the overall accuracy delta (run_a minus run_b). The delta is null when either run has not yet produced an overall accuracy score.",
11899
11995
  tags: [
11900
- "Quality"
11996
+ "Benchmarks"
11901
11997
  ],
11902
11998
  parameters: [
11903
11999
  {
@@ -11971,7 +12067,7 @@ var openapi_default = {
11971
12067
  summary: "Get benchmark results",
11972
12068
  description: "Returns per-document accuracy results for a benchmark run.",
11973
12069
  tags: [
11974
- "Quality"
12070
+ "Benchmarks"
11975
12071
  ],
11976
12072
  parameters: [
11977
12073
  {
@@ -12013,7 +12109,8 @@ var openapi_default = {
12013
12109
  post: {
12014
12110
  operationId: "submitProcess",
12015
12111
  summary: "Submit a document for processing",
12016
- description: "Upload a document and trigger a configured processing pipeline.\nAlways returns 202. Results delivered via `process.completed` webhook.\n\nIdempotency is automatic: the same (config_id, batch_id, file) combination\nreturns the existing run without re-processing. If batch_id is absent,\ndedup applies within a 24-hour window.\n",
12112
+ deprecated: true,
12113
+ description: "Deprecated: prefer `/v1/pipelines` for new integrations; this endpoint remains supported.\n\nUpload a document and trigger a configured processing pipeline.\nAlways returns 202. Results delivered via `process.completed` webhook.\n\nIdempotency is automatic: the same (config_id, batch_id, file) combination\nreturns the existing run without re-processing. If batch_id is absent,\ndedup applies within a 24-hour window.\n",
12017
12114
  tags: [
12018
12115
  "Process"
12019
12116
  ],
@@ -12159,7 +12256,8 @@ var openapi_default = {
12159
12256
  get: {
12160
12257
  operationId: "listConfigs",
12161
12258
  summary: "List available processing configs",
12162
- description: "Returns all processing configurations available to your organization.",
12259
+ deprecated: true,
12260
+ description: "Deprecated: prefer `/v1/pipelines` for new integrations; this endpoint remains supported. Returns all processing configurations available to your organization.\n",
12163
12261
  tags: [
12164
12262
  "Process"
12165
12263
  ],
@@ -15956,7 +16054,8 @@ var openapi_default = {
15956
16054
  "Fields"
15957
16055
  ],
15958
16056
  summary: "Query the field registry by field values",
15959
- description: "Returns documents whose captured field values match the `where` map (values matched via ILIKE). A read operation that takes a POST body. Requires the `read` scope. An unknown `where` field returns a 200 body `{ error: 'unknown_field' }`.\n",
16057
+ deprecated: true,
16058
+ description: "Deprecated: moved under `/v1/fields/registry/*`; use `POST /v1/fields/registry/query`. This path remains supported and serves the same handler. Returns documents whose captured field values match the `where` map (values matched via ILIKE). A read operation that takes a POST body. Requires the `read` scope. An unknown `where` field returns a 200 body `{ error: 'unknown_field' }`.\n",
15960
16059
  operationId: "queryRegistry",
15961
16060
  security: [
15962
16061
  {
@@ -16002,6 +16101,58 @@ var openapi_default = {
16002
16101
  }
16003
16102
  }
16004
16103
  },
16104
+ "/v1/fields/registry/query": {
16105
+ post: {
16106
+ tags: [
16107
+ "Fields"
16108
+ ],
16109
+ summary: "Query the field registry by field values",
16110
+ description: "The canonical home of the registry query going forward (alias of the deprecated `POST /v1/registry/query`; both serve the same handler). Returns documents whose captured field values match the `where` map (values matched via ILIKE). A read operation that takes a POST body. Requires the `read` scope. An unknown `where` field returns a 200 body `{ error: 'unknown_field' }`.\n",
16111
+ operationId: "queryFieldsRegistry",
16112
+ security: [
16113
+ {
16114
+ BearerAuth: []
16115
+ }
16116
+ ],
16117
+ requestBody: {
16118
+ required: true,
16119
+ content: {
16120
+ "application/json": {
16121
+ schema: {
16122
+ type: "object",
16123
+ required: [
16124
+ "where"
16125
+ ],
16126
+ properties: {
16127
+ where: {
16128
+ type: "object",
16129
+ minProperties: 1,
16130
+ additionalProperties: true
16131
+ },
16132
+ select: {
16133
+ type: "array",
16134
+ items: {
16135
+ type: "string"
16136
+ }
16137
+ },
16138
+ limit: {
16139
+ type: "integer",
16140
+ minimum: 1,
16141
+ default: 100,
16142
+ maximum: 500
16143
+ }
16144
+ }
16145
+ }
16146
+ }
16147
+ }
16148
+ },
16149
+ responses: {
16150
+ "200": {
16151
+ description: "{ data: row[], total }"
16152
+ }
16153
+ }
16154
+ }
16155
+ },
16005
16156
  "/v1/matching/packages/configs": {
16006
16157
  get: {
16007
16158
  tags: [
@@ -16501,7 +16652,8 @@ var openapi_default = {
16501
16652
  "Fields"
16502
16653
  ],
16503
16654
  summary: "Field-registry health snapshot (read-only)",
16504
- description: "Tier + admission counts, singleton/weak-name rates, occurrence and resolution stats, transfer hit rate, and coherence/atomicity metrics for the tenant's field registry. The same view the in-app registry dashboard reads; no lifecycle or cleanup actions are exposed.\n",
16655
+ deprecated: true,
16656
+ description: "Deprecated: moved under `/v1/fields/registry/*`; use `GET /v1/fields/registry/health`. This path remains supported and serves the same handler. Tier + admission counts, singleton/weak-name rates, occurrence and resolution stats, transfer hit rate, and coherence/atomicity metrics for the tenant's field registry. The same view the in-app registry dashboard reads; no lifecycle or cleanup actions are exposed.\n",
16505
16657
  operationId: "getRegistryHealth",
16506
16658
  security: [
16507
16659
  {
@@ -16515,6 +16667,26 @@ var openapi_default = {
16515
16667
  }
16516
16668
  }
16517
16669
  },
16670
+ "/v1/fields/registry/health": {
16671
+ get: {
16672
+ tags: [
16673
+ "Fields"
16674
+ ],
16675
+ summary: "Field-registry health snapshot (read-only)",
16676
+ description: "The canonical home of the registry health snapshot going forward (alias of the deprecated `GET /v1/registry/health`; both serve the same handler). Tier + admission counts, singleton/weak-name rates, occurrence and resolution stats, transfer hit rate, and coherence/atomicity metrics for the tenant's field registry. The same view the in-app registry dashboard reads; no lifecycle or cleanup actions are exposed.\n",
16677
+ operationId: "getFieldsRegistryHealth",
16678
+ security: [
16679
+ {
16680
+ BearerAuth: []
16681
+ }
16682
+ ],
16683
+ responses: {
16684
+ "200": {
16685
+ description: "Registry health snapshot"
16686
+ }
16687
+ }
16688
+ }
16689
+ },
16518
16690
  "/v1/customer-ontologies": {
16519
16691
  get: {
16520
16692
  tags: [
@@ -17362,6 +17534,99 @@ var openapi_default = {
17362
17534
  }
17363
17535
  }
17364
17536
  },
17537
+ "/v1/events": {
17538
+ get: {
17539
+ tags: [
17540
+ "Events"
17541
+ ],
17542
+ summary: "List tenant events",
17543
+ description: "Newest-first feed of platform events (document.extracted, run.*.completed/failed, result.flagged/approved/rejected, delivery.item.*, case.resolved). Alias of /v1/delivery/events at the API root.\n",
17544
+ operationId: "listEvents",
17545
+ security: [
17546
+ {
17547
+ BearerAuth: []
17548
+ }
17549
+ ],
17550
+ parameters: [
17551
+ {
17552
+ name: "event_type",
17553
+ in: "query",
17554
+ required: false,
17555
+ schema: {
17556
+ type: "string"
17557
+ },
17558
+ description: "Filter by event type, e.g. document.extracted"
17559
+ },
17560
+ {
17561
+ name: "limit",
17562
+ in: "query",
17563
+ required: false,
17564
+ schema: {
17565
+ type: "integer",
17566
+ default: 50,
17567
+ maximum: 200
17568
+ }
17569
+ },
17570
+ {
17571
+ name: "offset",
17572
+ in: "query",
17573
+ required: false,
17574
+ schema: {
17575
+ type: "integer",
17576
+ default: 0
17577
+ }
17578
+ }
17579
+ ],
17580
+ responses: {
17581
+ "200": {
17582
+ description: "{ data: [{ id, event_type, payload, created_at }], total, limit, offset }"
17583
+ }
17584
+ }
17585
+ }
17586
+ },
17587
+ "/v1/documents/{id}/claims": {
17588
+ get: {
17589
+ tags: [
17590
+ "Provenance"
17591
+ ],
17592
+ summary: "List a document's provenance claims",
17593
+ description: "Deterministic atomic (subject, predicate, object) claims synthesized from the document's captured fields + provenance spans (no LLM). Each claim carries its evidence quote, grounded flag, and confidence. Field-level span detail lives on GET /v1/field-reviews/{docId}/{fieldKey}.\n",
17594
+ operationId: "listDocumentClaims",
17595
+ security: [
17596
+ {
17597
+ BearerAuth: []
17598
+ }
17599
+ ],
17600
+ parameters: [
17601
+ {
17602
+ name: "id",
17603
+ in: "path",
17604
+ required: true,
17605
+ schema: {
17606
+ type: "string",
17607
+ format: "uuid"
17608
+ }
17609
+ },
17610
+ {
17611
+ name: "grounded",
17612
+ in: "query",
17613
+ required: false,
17614
+ schema: {
17615
+ type: "boolean"
17616
+ },
17617
+ description: "true = only span-backed claims"
17618
+ }
17619
+ ],
17620
+ responses: {
17621
+ "200": {
17622
+ description: "{ data: [{ subject, predicate, object, qualifier, evidence, segment_id, grounded, confidence, origin }], total }"
17623
+ },
17624
+ "404": {
17625
+ description: "Document not found or not owned by the caller."
17626
+ }
17627
+ }
17628
+ }
17629
+ },
17365
17630
  "/v1/webhooks/events": {
17366
17631
  get: {
17367
17632
  tags: [
@@ -18528,7 +18793,7 @@ var openapi_default = {
18528
18793
  statusCode: 429,
18529
18794
  code: "QUOTA_EXCEEDED",
18530
18795
  error: "Too Many Requests",
18531
- message: "Daily extract request limit (50) reached. Resets at midnight UTC.",
18796
+ message: "Daily extract request ceiling reached. Resets at midnight UTC. Spend is governed by credits, not this abuse ceiling.",
18532
18797
  retryable: true,
18533
18798
  timestamp: "2026-04-25T23:45:00.000Z",
18534
18799
  path: "/v1/extract"
@@ -18536,6 +18801,48 @@ var openapi_default = {
18536
18801
  }
18537
18802
  }
18538
18803
  },
18804
+ InsufficientCredits: {
18805
+ description: "Insufficient credits (402). The body is the agent-actionable contract:\n`buy_credits_url` is where a human completes a purchase (see also\n`GET /v1/billing/upgrade-link` for a direct Stripe Checkout link), and\n`pricing_url` is the machine-readable rate catalog. Free workspaces\nreceive 5,000 credits monthly; purchased credits top up the same\nbalance.\n",
18806
+ content: {
18807
+ "application/json": {
18808
+ schema: {
18809
+ type: "object",
18810
+ required: [
18811
+ "error",
18812
+ "message",
18813
+ "required_credits",
18814
+ "balance_credits"
18815
+ ],
18816
+ properties: {
18817
+ error: {
18818
+ type: "string",
18819
+ example: "insufficient_credits"
18820
+ },
18821
+ message: {
18822
+ type: "string"
18823
+ },
18824
+ required_credits: {
18825
+ type: "integer",
18826
+ example: 100
18827
+ },
18828
+ balance_credits: {
18829
+ type: "integer",
18830
+ example: 0
18831
+ },
18832
+ buy_credits_url: {
18833
+ type: "string",
18834
+ format: "uri",
18835
+ example: "https://app.talonic.com/settings/billing?buy=1"
18836
+ },
18837
+ pricing_url: {
18838
+ type: "string",
18839
+ example: "/v1/pricing"
18840
+ }
18841
+ }
18842
+ }
18843
+ }
18844
+ }
18845
+ },
18539
18846
  InternalServerError: {
18540
18847
  description: "An unexpected error occurred.",
18541
18848
  content: {
@@ -24640,8 +24947,8 @@ var API_NAV_SECTIONS = [
24640
24947
  { id: "get-job", label: "Get Job" }
24641
24948
  ] },
24642
24949
  { id: "sources", label: "Sources", children: [
24643
- { id: "list-sources", label: "List Inputs" },
24644
- { id: "create-source", label: "Create Input" },
24950
+ { id: "list-sources", label: "List Sources" },
24951
+ { id: "create-source", label: "Create Source" },
24645
24952
  { id: "get-source", label: "Get / Update / Delete" },
24646
24953
  { id: "update-source", label: "Source Documents" },
24647
24954
  { id: "ingest-source-document", label: "Ingest a Document" }
@@ -24713,7 +25020,7 @@ var API_NAV_SECTIONS = [
24713
25020
  { id: "get-structuring-gate", label: "Get / Update / Delete Gate" },
24714
25021
  { id: "gate-rules", label: "Gate Rules" },
24715
25022
  { id: "result-checks", label: "Result Checks" },
24716
- { id: "pending-approvals", label: "Pending Approvals" },
25023
+ { id: "pending-approvals", label: "Pending Reviews" },
24717
25024
  { id: "approve-reject-result", label: "Approve / Reject Result" },
24718
25025
  { id: "trigger-delivery", label: "Trigger Delivery" }
24719
25026
  ] },
@@ -24791,7 +25098,7 @@ var API_NAV_SECTIONS = [
24791
25098
  { id: "review-batch", label: "Batch Action" },
24792
25099
  { id: "review-assign", label: "Assign" }
24793
25100
  ] },
24794
- { id: "quality", label: "Quality", children: [
25101
+ { id: "quality", label: "Benchmarks", children: [
24795
25102
  { id: "list-quality-datasets", label: "List Datasets" },
24796
25103
  { id: "create-quality-dataset", label: "Create Dataset" },
24797
25104
  { id: "get-quality-dataset", label: "Get / Delete Dataset" },
@@ -24941,6 +25248,7 @@ var PLATFORM_NAV_SECTIONS = [
24941
25248
  { id: "overview", label: "Overview", children: [
24942
25249
  { id: "introduction", label: "Introduction" },
24943
25250
  { id: "core-concepts", label: "Core Concepts" },
25251
+ { id: "glossary", label: "Glossary" },
24944
25252
  { id: "platform-flow", label: "Platform Flow" },
24945
25253
  { id: "getting-started", label: "Getting Started" }
24946
25254
  ] },
@@ -24949,7 +25257,7 @@ var PLATFORM_NAV_SECTIONS = [
24949
25257
  { id: "agent-impact", label: "Impact Levels" },
24950
25258
  { id: "agent-dashboard", label: "Dashboard" }
24951
25259
  ] },
24952
- { id: "sources-docs", label: "Inputs & Documents", children: [
25260
+ { id: "sources-docs", label: "Sources & Documents", children: [
24953
25261
  { id: "uploading", label: "Uploading Documents" },
24954
25262
  { id: "supported-formats", label: "Supported Formats" },
24955
25263
  { id: "document-processing", label: "Document Processing" },
@@ -24960,7 +25268,7 @@ var PLATFORM_NAV_SECTIONS = [
24960
25268
  ] },
24961
25269
  { id: "field-intelligence", label: "Field Intelligence", children: [
24962
25270
  { id: "field-registry", label: "Field Registry" },
24963
- { id: "tier-system", label: "Tier System" },
25271
+ { id: "tier-system", label: "Maturity Levels" },
24964
25272
  { id: "semantic-clusters", label: "Semantic Clusters" },
24965
25273
  { id: "field-resolution", label: "Field Resolution" },
24966
25274
  { id: "master-instructions", label: "Master Instructions" }
@@ -24988,8 +25296,8 @@ var PLATFORM_NAV_SECTIONS = [
24988
25296
  { id: "confidence-provenance", label: "Confidence & Provenance" },
24989
25297
  { id: "corrections", label: "Corrections" }
24990
25298
  ] },
24991
- { id: "pipelines", label: "Structure Pipeline", children: [
24992
- { id: "spec-pipeline", label: "The Spec & One Engine" },
25299
+ { id: "pipelines", label: "Pipelines", children: [
25300
+ { id: "spec-pipeline", label: "The Spec & the Engine" },
24993
25301
  { id: "pipeline-rail", label: "Composing the Rail" },
24994
25302
  { id: "running-a-pipeline", label: "Running a Pipeline" },
24995
25303
  { id: "validation-checkpoints", label: "Validation Checkpoints" },
@@ -25021,11 +25329,11 @@ var PLATFORM_NAV_SECTIONS = [
25021
25329
  { id: "id-dispensers", label: "ID Dispensers" },
25022
25330
  { id: "data-product-sharing", label: "Sharing & Export" }
25023
25331
  ] },
25024
- { id: "validation-quality", label: "Validation & Quality", children: [
25332
+ { id: "validation-quality", label: "Validation & Benchmarks", children: [
25025
25333
  { id: "validation-checks", label: "Validation Checks" },
25026
- { id: "ground-truth", label: "Golden Samples" },
25027
- { id: "approval-gates", label: "Approval Gates" },
25028
- { id: "approval-queue", label: "Approval Queue" }
25334
+ { id: "ground-truth", label: "Ground Truth" },
25335
+ { id: "approval-gates", label: "Review Gates" },
25336
+ { id: "approval-queue", label: "Field Review" }
25029
25337
  ] },
25030
25338
  { id: "delivery", label: "Outputs", children: [
25031
25339
  { id: "delivery-pipeline", label: "How Delivery Works" },
@@ -25050,7 +25358,7 @@ var PLATFORM_NAV_SECTIONS = [
25050
25358
  ] },
25051
25359
  { id: "team-admin", label: "Team & Admin", children: [
25052
25360
  { id: "team-management", label: "Team Management" },
25053
- { id: "usage-registry", label: "Usage & Registry" },
25361
+ { id: "usage-registry", label: "Usage" },
25054
25362
  { id: "admin-panel", label: "Admin Panel" },
25055
25363
  { id: "shortcuts", label: "Keyboard Shortcuts" }
25056
25364
  ] }
@@ -25066,15 +25374,15 @@ var API_SECTION_META = [
25066
25374
  { id: "telemetry", title: "Telemetry API", description: "Aggregate structuring metrics \u2014 capture hit rate, synthesize rate, strategy distribution, and tier funnel breakdowns per schema or run." },
25067
25375
  { id: "provenance", title: "Provenance API", description: "Per-cell audit trails showing tier, strategy, sub-move, confidence score, and reasoning trace for every value in a record." },
25068
25376
  { id: "jobs", title: "Jobs API", description: "Track asynchronous extraction jobs with progress, phase status, and grid fill rate statistics." },
25069
- { id: "sources", title: "Inputs API", description: "Manage document sources for programmatic ingestion. Each source has its own API key and supports batch processing." },
25377
+ { id: "sources", title: "Sources API", description: "Manage document sources for programmatic ingestion. Each source has its own API key and supports batch processing." },
25070
25378
  { id: "filter-search", title: "Filter & Search API", description: "Field autocomplete, document filtering with composable conditions, global omnisearch, and saved filter management." },
25071
25379
  { id: "webhooks", title: "Webhooks", description: "Real-time event notifications with HMAC-SHA256 signed payloads, delivery tracking, and exponential backoff retries." },
25072
25380
  { id: "resolutions", title: "Resolutions API", description: "Resolution runs \u2014 apply field normalization, transforms, and lookup cascades to extracted data. List, create, execute, and delete resolution runs." },
25073
25381
  { id: "linking", title: "Linking API", description: "Document linking graph \u2014 link keys, document links, entity graph, classification, backfill operations, and document-case mapping." },
25074
25382
  { id: "nshot", title: "N-Shot API", description: "N-Shot comparison endpoints for job runs \u2014 summary, field comparisons, overrides, and AI/human judge decisions." },
25075
25383
  { id: "schema-graph", title: "Schema Graph API", description: "Schema class ontology \u2014 versioned classes, diffs with approval/rejection workflow, inter-class edges, aliases, and D3-compatible visualization." },
25076
- { id: "structuring", title: "Structuring API", description: "Validation checks CRUD, approval gates with configurable rules, result check outcomes, pending approvals queue, and delivery triggers." },
25077
- { id: "validation", title: "Validation API", description: "Golden sample management and validation runs for measuring extraction accuracy against ground truth datasets." },
25384
+ { id: "structuring", title: "Structuring API", description: "Validation checks CRUD, review gates with configurable rules, result check outcomes, pending review queue, and delivery triggers." },
25385
+ { id: "validation", title: "Benchmarks API (validation namespace)", description: "Ground Truth management and benchmark runs for measuring extraction accuracy against ground truth datasets." },
25078
25386
  { id: "credits", title: "Credits API", description: "Credit balance, transaction history, aggregate usage summaries, daily usage breakdown, and per-request usage log." },
25079
25387
  { id: "agent", title: "Agent API", description: "Workspace context snapshot and agent tool discovery endpoints for programmatic access to embedded AI assistant capabilities." },
25080
25388
  { id: "matching", title: "Matching API", description: "Reference data matching \u2014 create configs with weighted field strategies, run matches, get top-5 candidates per document, and AI-generate strategies." },
@@ -25082,7 +25390,7 @@ var API_SECTION_META = [
25082
25390
  { id: "batches", title: "Batches API", description: "Batch extraction processing at 50% cost \u2014 list, get, sync with provider, and cancel batches." },
25083
25391
  { id: "cases", title: "Cases API", description: "Case management \u2014 list, get, anomalies, status lifecycle, edge confirmation, document pinning, merge and split operations." },
25084
25392
  { id: "review", title: "Review API", description: "Review queue for validation records \u2014 list items, stats, take action (approve/reject/flag), batch operations, and assignment." },
25085
- { id: "quality", title: "Quality API", description: "Ground truth datasets, entries management with CSV import, benchmark runs, per-field accuracy results, and benchmark comparison." },
25393
+ { id: "quality", title: "Benchmarks API", description: "Ground truth datasets, entries management with CSV import, benchmark runs, per-field accuracy results, and benchmark comparison." },
25086
25394
  { id: "routing-rules", title: "Routing Rules API", description: "Document routing rules \u2014 create, manage, and reorder priority-based rules for automatic document workflow assignment." },
25087
25395
  { id: "reference-data", title: "Reference Data API", description: "Upload, list, and manage reference data tables used as lookup targets for matching configurations. Supports JSON upload, paginated row access, and CSV export." },
25088
25396
  { id: "fields", title: "Fields API", description: "Read-only access to the field registry \u2014 list fields with filters, cross-schema harmonization analysis, field detail with occurrences, and embedding-based similarity search." },
@@ -25096,17 +25404,17 @@ var API_SECTION_META = [
25096
25404
  var PLATFORM_SECTION_META = [
25097
25405
  { id: "overview", title: "Platform Overview", description: "Core concepts, platform flow, and getting started guide for the Talonic document structuring platform." },
25098
25406
  { id: "agent", title: "AI Agent", description: "Embedded AI assistant accessible via Cmd+I from any page. Inspects schemas, searches documents, analyzes extraction quality, explores cases, and builds schemas through natural language." },
25099
- { id: "sources-docs", title: "Inputs & Documents", description: "Upload documents via drag-and-drop, API, or connectors. 25+ formats supported with automatic OCR and classification." },
25407
+ { id: "sources-docs", title: "Sources & Documents", description: "Upload documents via drag-and-drop, API, or connectors. 25+ formats supported with automatic OCR and classification." },
25100
25408
  { id: "field-intelligence", title: "Field Intelligence", description: "Unified field registry with tier system, semantic clustering, and AI-synthesized master extraction instructions." },
25101
25409
  { id: "schemas-templates", title: "Schemas & Templates", description: "AI-generated schemas per document type and user-defined templates with field matching, reference tables, and versioning." },
25102
25410
  { id: "structuring", title: "Structuring", description: "Vocabulary-driven structuring system with seven field strategies, four processing tiers, capture sub-moves, modifiers, constraints, and synthesize fallback." },
25103
25411
  { id: "extraction-jobs", title: "Extraction Jobs", description: "The 4-phase pipeline: Resolve, Agent, Validation, Re-read. Progressive grid filling with per-cell provenance and confidence." },
25104
- { id: "pipelines", title: "Structure Pipeline", description: "The Spec and One Engine: compose a rail over one schema, run it as a per-document pipeline through transfer, extraction, resolution, and validation checkpoints, with a review queue and assembly." },
25412
+ { id: "pipelines", title: "Pipelines", description: "The Spec and the engine: compose a rail over one schema, run it as a per-document pipeline through transfer, extraction, resolution, and validation checkpoints, with a review queue and assembly." },
25105
25413
  { id: "linking-cases", title: "Linking & Cases", description: "Document linking discovers relationships through shared entities. Related documents grouped into cases with evidence chains." },
25106
25414
  { id: "batch-inference", title: "Batch Inference", description: "Batch processing mode defers Claude extraction to the provider batch API at 50% cost with 48-hour delivery. Monitor batch progress and results." },
25107
25415
  { id: "matching", title: "Smart Matching", description: "Upload reference datasets and configure weighted field-to-field matching strategies. Run matches asynchronously and review top-5 candidates per document." },
25108
25416
  { id: "data-products", title: "Data Products", description: "Dataset templates for reusable output specifications and assemblies for combining multi-source documents into structured datasets." },
25109
- { id: "validation-quality", title: "Validation & Quality", description: "Automated validation checks, golden sample benchmarking, configurable approval gates, and a manual review queue for flagged results." },
25417
+ { id: "validation-quality", title: "Validation & Benchmarks", description: "Automated validation checks, Ground Truth benchmarking, configurable review gates, and Record Review for flagged results." },
25110
25418
  { id: "delivery", title: "Outputs & Delivery", description: "Push structured data to webhooks, REST APIs, SFTP, email, or cloud storage with field mappings, triggers, delivery configuration, and telemetry." },
25111
25419
  { id: "workspace-settings", title: "Workspace Settings", description: "Shared dialects for output formatting, reference primitives for lookup tables, and change review governance for production workspaces." },
25112
25420
  { id: "search-filtering", title: "Search & Filtering", description: "Global omnisearch (Cmd+K) and advanced document filtering by extracted field values with saved presets." },