@talonic/docs 0.9.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/dist/index.js CHANGED
@@ -3314,6 +3314,611 @@ function verifyWebhook(payload, signature, secret) {
3314
3314
  ] })
3315
3315
  ] }) }),
3316
3316
  /* @__PURE__ */ jsx5("p", { className: "text-[14px] text-void-text-muted leading-relaxed", children: "After 4 failed attempts, the delivery is marked as failed. You can check delivery status and replay events from the dashboard." }),
3317
+ /* @__PURE__ */ jsx5(SectionHeading, { id: "resolutions", children: "Resolutions" }),
3318
+ /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "Resolution runs apply field normalization, lookup cascades, and value transforms to extracted data. Create a resolution from a completed job run to standardise field values against reference data." }),
3319
+ /* @__PURE__ */ jsx5("div", { id: "list-resolutions", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3320
+ EndpointBlock,
3321
+ {
3322
+ method: "GET",
3323
+ path: "/v1/resolutions",
3324
+ summary: "List resolution runs, optionally filtered by status or source run.",
3325
+ description: "Requires read scope.",
3326
+ children: /* @__PURE__ */ jsx5(ParamTable, { params: [
3327
+ { name: "status", type: "string", required: false, description: "Filter by run status." },
3328
+ { name: "source_run_id", type: "uuid", required: false, description: "Filter by originating job run." }
3329
+ ] })
3330
+ }
3331
+ ) }),
3332
+ /* @__PURE__ */ jsx5("div", { id: "create-resolution", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3333
+ EndpointBlock,
3334
+ {
3335
+ method: "POST",
3336
+ path: "/v1/resolutions",
3337
+ summary: "Create a resolution run from a completed job.",
3338
+ description: "Requires write scope. Provide the source_run_id to resolve.",
3339
+ children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Request body", children: `{
3340
+ "source_run_id": "run_abc123"
3341
+ }` })
3342
+ }
3343
+ ) }),
3344
+ /* @__PURE__ */ jsx5("div", { id: "get-resolution", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3345
+ EndpointBlock,
3346
+ {
3347
+ method: "GET",
3348
+ path: "/v1/resolutions/{id}",
3349
+ summary: "Get a resolution run with status and summary.",
3350
+ description: "Requires read scope."
3351
+ }
3352
+ ) }),
3353
+ /* @__PURE__ */ jsx5("div", { id: "get-resolution-results", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3354
+ EndpointBlock,
3355
+ {
3356
+ method: "GET",
3357
+ path: "/v1/resolutions/{id}/results",
3358
+ summary: "Get per-field resolution results showing original and resolved values.",
3359
+ description: "Requires read scope.",
3360
+ children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
3361
+ "data": [
3362
+ {
3363
+ "document_id": "doc_abc123",
3364
+ "field_name": "country",
3365
+ "original_value": "Deutschland",
3366
+ "resolved_value": "DE",
3367
+ "resolution_step": "lookup",
3368
+ "confidence": 0.98
3369
+ }
3370
+ ]
3371
+ }` })
3372
+ }
3373
+ ) }),
3374
+ /* @__PURE__ */ jsx5("div", { id: "execute-resolution", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3375
+ EndpointBlock,
3376
+ {
3377
+ method: "POST",
3378
+ path: "/v1/resolutions/{id}/execute",
3379
+ summary: "Execute the resolution pipeline on all pending fields.",
3380
+ description: "Requires write scope. Returns immediately \u2014 poll the run for progress."
3381
+ }
3382
+ ) }),
3383
+ /* @__PURE__ */ jsx5("div", { id: "delete-resolution", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3384
+ EndpointBlock,
3385
+ {
3386
+ method: "DELETE",
3387
+ path: "/v1/resolutions/{id}",
3388
+ summary: "Delete a resolution run and its results.",
3389
+ description: "Requires write scope."
3390
+ }
3391
+ ) }),
3392
+ /* @__PURE__ */ jsx5(SectionHeading, { id: "linking", children: "Linking" }),
3393
+ /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "The linking graph connects documents through shared entity values \u2014 an invoice and a contract sharing the same customer ID are linked. Links are discovered automatically during extraction and can be classified into categories (identity, transaction, reference) via AI." }),
3394
+ /* @__PURE__ */ jsx5("div", { id: "list-link-keys", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3395
+ EndpointBlock,
3396
+ {
3397
+ method: "GET",
3398
+ path: "/v1/linking/link-keys",
3399
+ summary: "List all discovered link keys with their classification category and frequency.",
3400
+ description: "Requires read scope.",
3401
+ children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
3402
+ "data": [
3403
+ {
3404
+ "field_name": "customer_id",
3405
+ "category": "identity",
3406
+ "auto_classified": true,
3407
+ "frequency": 0.85
3408
+ }
3409
+ ]
3410
+ }` })
3411
+ }
3412
+ ) }),
3413
+ /* @__PURE__ */ jsx5("div", { id: "get-document-links", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3414
+ EndpointBlock,
3415
+ {
3416
+ method: "GET",
3417
+ path: "/v1/linking/documents/{id}/links",
3418
+ summary: "Get all links for a specific document.",
3419
+ description: "Requires read scope."
3420
+ }
3421
+ ) }),
3422
+ /* @__PURE__ */ jsx5("div", { id: "get-linking-graph", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3423
+ EndpointBlock,
3424
+ {
3425
+ method: "GET",
3426
+ path: "/v1/linking/graph",
3427
+ summary: "Get the full document linking graph as nodes and edges.",
3428
+ description: "Requires read scope. Can be large for workspaces with many documents."
3429
+ }
3430
+ ) }),
3431
+ /* @__PURE__ */ jsx5("div", { id: "get-document-graph", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3432
+ EndpointBlock,
3433
+ {
3434
+ method: "GET",
3435
+ path: "/v1/linking/graph/documents/{id}",
3436
+ summary: "Get the graph neighbourhood for a single document.",
3437
+ description: "Requires read scope.",
3438
+ children: /* @__PURE__ */ jsx5(ParamTable, { params: [
3439
+ { name: "depth", type: "integer", required: false, description: "Graph traversal depth (default 2)." }
3440
+ ] })
3441
+ }
3442
+ ) }),
3443
+ /* @__PURE__ */ jsx5("div", { id: "classify-link-keys", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3444
+ EndpointBlock,
3445
+ {
3446
+ method: "POST",
3447
+ path: "/v1/linking/classify",
3448
+ summary: "Classify link keys into categories using AI.",
3449
+ description: "Requires write scope. Runs asynchronously."
3450
+ }
3451
+ ) }),
3452
+ /* @__PURE__ */ jsx5("div", { id: "backfill-linking", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3453
+ EndpointBlock,
3454
+ {
3455
+ method: "POST",
3456
+ path: "/v1/linking/backfill",
3457
+ summary: "Backfill link values across all documents.",
3458
+ description: "Requires write scope. Returns 202 \u2014 poll progress via the backfill progress endpoint."
3459
+ }
3460
+ ) }),
3461
+ /* @__PURE__ */ jsx5("div", { id: "backfill-progress", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3462
+ EndpointBlock,
3463
+ {
3464
+ method: "GET",
3465
+ path: "/v1/linking/backfill/progress",
3466
+ summary: "Get backfill progress.",
3467
+ description: "Requires read scope."
3468
+ }
3469
+ ) }),
3470
+ /* @__PURE__ */ jsx5("div", { id: "document-case-map", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3471
+ EndpointBlock,
3472
+ {
3473
+ method: "GET",
3474
+ path: "/v1/linking/document-case-map",
3475
+ summary: "Get the mapping of documents to their resolved cases.",
3476
+ description: "Requires read scope."
3477
+ }
3478
+ ) }),
3479
+ /* @__PURE__ */ jsx5(SectionHeading, { id: "nshot", children: "N-Shot" }),
3480
+ /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "N-Shot endpoints provide field-level comparisons between job runs \u2014 useful for evaluating extraction quality across schema versions. Submit judge decisions (human or AI) to record which run produced the better result." }),
3481
+ /* @__PURE__ */ jsx5("div", { id: "nshot-summary", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3482
+ EndpointBlock,
3483
+ {
3484
+ method: "GET",
3485
+ path: "/v1/jobs/runs/{runId}/nshot/summary",
3486
+ summary: "Get an aggregate N-Shot summary for a run.",
3487
+ description: "Requires read scope."
3488
+ }
3489
+ ) }),
3490
+ /* @__PURE__ */ jsx5("div", { id: "nshot-comparisons", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3491
+ EndpointBlock,
3492
+ {
3493
+ method: "GET",
3494
+ path: "/v1/jobs/runs/{runId}/nshot/comparisons",
3495
+ summary: "List per-document field comparisons.",
3496
+ description: "Requires read scope."
3497
+ }
3498
+ ) }),
3499
+ /* @__PURE__ */ jsx5("div", { id: "nshot-comparison", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3500
+ EndpointBlock,
3501
+ {
3502
+ method: "GET",
3503
+ path: "/v1/jobs/runs/{runId}/nshot/comparison",
3504
+ summary: "Get a specific field comparison.",
3505
+ description: "Requires read scope."
3506
+ }
3507
+ ) }),
3508
+ /* @__PURE__ */ jsx5("div", { id: "nshot-override", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3509
+ EndpointBlock,
3510
+ {
3511
+ method: "POST",
3512
+ path: "/v1/jobs/runs/{runId}/nshot/override",
3513
+ summary: "Override an N-Shot value for a specific field.",
3514
+ description: "Requires write scope."
3515
+ }
3516
+ ) }),
3517
+ /* @__PURE__ */ jsx5("div", { id: "nshot-judge-decision", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3518
+ EndpointBlock,
3519
+ {
3520
+ method: "POST",
3521
+ path: "/v1/jobs/runs/{runId}/nshot/judge-decision",
3522
+ summary: "Submit a judge decision (human or AI) for an N-Shot comparison.",
3523
+ description: "Requires write scope."
3524
+ }
3525
+ ) }),
3526
+ /* @__PURE__ */ jsx5(SectionHeading, { id: "schema-graph", children: "Schema Graph" }),
3527
+ /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "The schema graph is a versioned ontology of document classes discovered across your workspace. Each class captures a document type's canonical fields. Diffs are generated when the system proposes changes and require approval before they take effect." }),
3528
+ /* @__PURE__ */ jsx5("div", { id: "list-schema-graph-classes", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3529
+ EndpointBlock,
3530
+ {
3531
+ method: "GET",
3532
+ path: "/v1/schema-graph/classes",
3533
+ summary: "List all schema graph classes.",
3534
+ description: "Requires read scope."
3535
+ }
3536
+ ) }),
3537
+ /* @__PURE__ */ jsx5("div", { id: "get-schema-graph-class", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3538
+ EndpointBlock,
3539
+ {
3540
+ method: "GET",
3541
+ path: "/v1/schema-graph/classes/{id}",
3542
+ summary: "Get a schema graph class with its current field definitions.",
3543
+ description: "Requires read scope."
3544
+ }
3545
+ ) }),
3546
+ /* @__PURE__ */ jsx5("div", { id: "list-class-versions", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3547
+ EndpointBlock,
3548
+ {
3549
+ method: "GET",
3550
+ path: "/v1/schema-graph/classes/{id}/versions",
3551
+ summary: "List all versions of a schema graph class.",
3552
+ description: "Requires read scope."
3553
+ }
3554
+ ) }),
3555
+ /* @__PURE__ */ jsx5("div", { id: "get-class-version", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3556
+ EndpointBlock,
3557
+ {
3558
+ method: "GET",
3559
+ path: "/v1/schema-graph/classes/{id}/versions/{version}",
3560
+ summary: "Get a specific version of a schema graph class.",
3561
+ description: "Requires read scope."
3562
+ }
3563
+ ) }),
3564
+ /* @__PURE__ */ jsx5("div", { id: "list-schema-graph-diffs", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3565
+ EndpointBlock,
3566
+ {
3567
+ method: "GET",
3568
+ path: "/v1/schema-graph/diffs",
3569
+ summary: "List pending, approved, and rejected diffs.",
3570
+ description: "Requires read scope."
3571
+ }
3572
+ ) }),
3573
+ /* @__PURE__ */ jsx5("div", { id: "approve-schema-graph-diff", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3574
+ EndpointBlock,
3575
+ {
3576
+ method: "POST",
3577
+ path: "/v1/schema-graph/diffs/{id}/approve",
3578
+ summary: "Approve a pending diff, promoting it to the next class version.",
3579
+ description: "Requires write scope."
3580
+ }
3581
+ ) }),
3582
+ /* @__PURE__ */ jsx5("div", { id: "reject-schema-graph-diff", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3583
+ EndpointBlock,
3584
+ {
3585
+ method: "POST",
3586
+ path: "/v1/schema-graph/diffs/{id}/reject",
3587
+ summary: "Reject a pending diff.",
3588
+ description: "Requires write scope."
3589
+ }
3590
+ ) }),
3591
+ /* @__PURE__ */ jsx5("div", { id: "list-schema-graph-edges", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3592
+ EndpointBlock,
3593
+ {
3594
+ method: "GET",
3595
+ path: "/v1/schema-graph/edges",
3596
+ summary: "List inter-class edges in the schema graph.",
3597
+ description: "Requires read scope."
3598
+ }
3599
+ ) }),
3600
+ /* @__PURE__ */ jsx5("div", { id: "list-schema-graph-aliases", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3601
+ EndpointBlock,
3602
+ {
3603
+ method: "GET",
3604
+ path: "/v1/schema-graph/aliases",
3605
+ summary: "List schema graph class aliases.",
3606
+ description: "Requires read scope."
3607
+ }
3608
+ ) }),
3609
+ /* @__PURE__ */ jsx5("div", { id: "visualize-schema-graph", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3610
+ EndpointBlock,
3611
+ {
3612
+ method: "GET",
3613
+ path: "/v1/schema-graph/visualize",
3614
+ summary: "Get D3-compatible visualization data for the schema graph.",
3615
+ description: "Requires read scope."
3616
+ }
3617
+ ) }),
3618
+ /* @__PURE__ */ jsx5(SectionHeading, { id: "structuring", children: "Structuring" }),
3619
+ /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "The structuring pipeline validates extracted data through configurable checks and approval gates. Checks define validation rules; gates aggregate checks and determine whether records require manual approval before delivery." }),
3620
+ /* @__PURE__ */ jsx5(SubHeading, { id: "structuring-checks", children: "Checks" }),
3621
+ /* @__PURE__ */ jsx5("div", { id: "list-structuring-checks", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3622
+ EndpointBlock,
3623
+ {
3624
+ method: "GET",
3625
+ path: "/v1/structuring/checks",
3626
+ summary: "List validation checks.",
3627
+ description: "Requires read scope."
3628
+ }
3629
+ ) }),
3630
+ /* @__PURE__ */ jsx5("div", { id: "create-structuring-check", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3631
+ EndpointBlock,
3632
+ {
3633
+ method: "POST",
3634
+ path: "/v1/structuring/checks",
3635
+ summary: "Create a validation check.",
3636
+ description: "Requires write scope.",
3637
+ children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Request body", children: `{
3638
+ "name": "Amount range check",
3639
+ "type": "value_range",
3640
+ "config": {
3641
+ "field": "total_amount",
3642
+ "min": 0,
3643
+ "max": 1000000
3644
+ }
3645
+ }` })
3646
+ }
3647
+ ) }),
3648
+ /* @__PURE__ */ jsx5("div", { id: "get-structuring-check", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3649
+ EndpointBlock,
3650
+ {
3651
+ method: "GET",
3652
+ path: "/v1/structuring/checks/{id}",
3653
+ summary: "Get a validation check.",
3654
+ description: "Requires read scope."
3655
+ }
3656
+ ) }),
3657
+ /* @__PURE__ */ jsx5("div", { id: "update-structuring-check", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3658
+ EndpointBlock,
3659
+ {
3660
+ method: "PUT",
3661
+ path: "/v1/structuring/checks/{id}",
3662
+ summary: "Update a validation check.",
3663
+ description: "Requires write scope."
3664
+ }
3665
+ ) }),
3666
+ /* @__PURE__ */ jsx5("div", { id: "delete-structuring-check", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3667
+ EndpointBlock,
3668
+ {
3669
+ method: "DELETE",
3670
+ path: "/v1/structuring/checks/{id}",
3671
+ summary: "Delete a validation check.",
3672
+ description: "Requires write scope."
3673
+ }
3674
+ ) }),
3675
+ /* @__PURE__ */ jsx5(SubHeading, { id: "structuring-gates", children: "Approval Gates" }),
3676
+ /* @__PURE__ */ jsx5("div", { id: "list-structuring-gates", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3677
+ EndpointBlock,
3678
+ {
3679
+ method: "GET",
3680
+ path: "/v1/structuring/gates",
3681
+ summary: "List approval gates.",
3682
+ description: "Requires read scope."
3683
+ }
3684
+ ) }),
3685
+ /* @__PURE__ */ jsx5("div", { id: "create-structuring-gate", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3686
+ EndpointBlock,
3687
+ {
3688
+ method: "POST",
3689
+ path: "/v1/structuring/gates",
3690
+ summary: "Create an approval gate.",
3691
+ description: "Requires write scope."
3692
+ }
3693
+ ) }),
3694
+ /* @__PURE__ */ jsx5("div", { id: "get-structuring-gate", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3695
+ EndpointBlock,
3696
+ {
3697
+ method: "GET",
3698
+ path: "/v1/structuring/gates/{id}",
3699
+ summary: "Get an approval gate with its rules.",
3700
+ description: "Requires read scope."
3701
+ }
3702
+ ) }),
3703
+ /* @__PURE__ */ jsx5("div", { id: "update-structuring-gate", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3704
+ EndpointBlock,
3705
+ {
3706
+ method: "PUT",
3707
+ path: "/v1/structuring/gates/{id}",
3708
+ summary: "Update an approval gate.",
3709
+ description: "Requires write scope."
3710
+ }
3711
+ ) }),
3712
+ /* @__PURE__ */ jsx5("div", { id: "delete-structuring-gate", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3713
+ EndpointBlock,
3714
+ {
3715
+ method: "DELETE",
3716
+ path: "/v1/structuring/gates/{id}",
3717
+ summary: "Delete an approval gate.",
3718
+ description: "Requires write scope."
3719
+ }
3720
+ ) }),
3721
+ /* @__PURE__ */ jsx5(SectionHeading, { id: "telemetry", children: "Telemetry" }),
3722
+ /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "Aggregate structuring metrics \u2014 capture hit rate, synthesize rate, strategy distribution, and tier funnel breakdowns per schema or run." }),
3723
+ /* @__PURE__ */ jsx5("div", { id: "telemetry-schema-summary", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3724
+ EndpointBlock,
3725
+ {
3726
+ method: "GET",
3727
+ path: "/v1/telemetry/schemas/{id}/summary",
3728
+ summary: "Get aggregate metrics for a schema across all runs.",
3729
+ description: "Requires read scope."
3730
+ }
3731
+ ) }),
3732
+ /* @__PURE__ */ jsx5("div", { id: "telemetry-schema-trend", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3733
+ EndpointBlock,
3734
+ {
3735
+ method: "GET",
3736
+ path: "/v1/telemetry/schemas/{id}/trend",
3737
+ summary: "Get metric trends over time for a schema.",
3738
+ description: "Requires read scope."
3739
+ }
3740
+ ) }),
3741
+ /* @__PURE__ */ jsx5("div", { id: "telemetry-schema-fields", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3742
+ EndpointBlock,
3743
+ {
3744
+ method: "GET",
3745
+ path: "/v1/telemetry/schemas/{id}/fields",
3746
+ summary: "Get per-field structuring metrics for a schema.",
3747
+ description: "Requires read scope."
3748
+ }
3749
+ ) }),
3750
+ /* @__PURE__ */ jsx5("div", { id: "telemetry-run-summary", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3751
+ EndpointBlock,
3752
+ {
3753
+ method: "GET",
3754
+ path: "/v1/telemetry/runs/{id}/summary",
3755
+ summary: "Get structuring metrics for a single run.",
3756
+ description: "Requires read scope."
3757
+ }
3758
+ ) }),
3759
+ /* @__PURE__ */ jsx5(SectionHeading, { id: "validation", children: "Validation" }),
3760
+ /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "Golden sample management and validation runs for measuring extraction accuracy against ground truth datasets. Create a golden sample set, then run validations to compare extracted values against expected values." }),
3761
+ /* @__PURE__ */ jsx5(SubHeading, { id: "golden-samples", children: "Golden Samples" }),
3762
+ /* @__PURE__ */ jsx5("div", { id: "list-golden-samples", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3763
+ EndpointBlock,
3764
+ {
3765
+ method: "GET",
3766
+ path: "/v1/validation/ground-truth",
3767
+ summary: "List golden sample sets.",
3768
+ description: "Requires read scope."
3769
+ }
3770
+ ) }),
3771
+ /* @__PURE__ */ jsx5("div", { id: "get-golden-sample", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3772
+ EndpointBlock,
3773
+ {
3774
+ method: "GET",
3775
+ path: "/v1/validation/ground-truth/{id}",
3776
+ summary: "Get a golden sample set with its expected values.",
3777
+ description: "Requires read scope."
3778
+ }
3779
+ ) }),
3780
+ /* @__PURE__ */ jsx5("div", { id: "delete-golden-sample", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3781
+ EndpointBlock,
3782
+ {
3783
+ method: "DELETE",
3784
+ path: "/v1/validation/ground-truth/{id}",
3785
+ summary: "Delete a golden sample set.",
3786
+ description: "Requires write scope."
3787
+ }
3788
+ ) }),
3789
+ /* @__PURE__ */ jsx5(SubHeading, { id: "validation-runs", children: "Validation Runs" }),
3790
+ /* @__PURE__ */ jsx5("div", { id: "list-validation-runs", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3791
+ EndpointBlock,
3792
+ {
3793
+ method: "GET",
3794
+ path: "/v1/validation/runs",
3795
+ summary: "List validation runs.",
3796
+ description: "Requires read scope."
3797
+ }
3798
+ ) }),
3799
+ /* @__PURE__ */ jsx5("div", { id: "create-validation-run", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3800
+ EndpointBlock,
3801
+ {
3802
+ method: "POST",
3803
+ path: "/v1/validation/runs",
3804
+ summary: "Create a validation run comparing a job against a golden sample.",
3805
+ description: "Requires write scope.",
3806
+ children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Request body", children: `{
3807
+ "dataspace_run_id": "run_abc123",
3808
+ "golden_sample_id": "gs_xyz789",
3809
+ "name": "Q1 Invoice accuracy check"
3810
+ }` })
3811
+ }
3812
+ ) }),
3813
+ /* @__PURE__ */ jsx5("div", { id: "get-validation-run", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3814
+ EndpointBlock,
3815
+ {
3816
+ method: "GET",
3817
+ path: "/v1/validation/runs/{id}",
3818
+ summary: "Get a validation run with accuracy summary.",
3819
+ description: "Requires read scope."
3820
+ }
3821
+ ) }),
3822
+ /* @__PURE__ */ jsx5("div", { id: "get-validation-results", className: "scroll-mt-6", children: /* @__PURE__ */ jsxs5(
3823
+ EndpointBlock,
3824
+ {
3825
+ method: "GET",
3826
+ path: "/v1/validation/runs/{id}/results",
3827
+ summary: "Get per-field validation results.",
3828
+ description: "Requires read scope.",
3829
+ children: [
3830
+ /* @__PURE__ */ jsx5(ParamTable, { params: [
3831
+ { name: "judged_only", type: "string", required: false, description: 'Set to "true" to return only judged results.' }
3832
+ ] }),
3833
+ /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
3834
+ "data": [
3835
+ {
3836
+ "document_id": "doc_abc123",
3837
+ "field_name": "invoice_number",
3838
+ "expected_value": "INV-2024-0042",
3839
+ "actual_value": "INV-2024-0042",
3840
+ "match_type": "exact",
3841
+ "similarity_score": 1.0,
3842
+ "judge_verdict": "correct"
3843
+ }
3844
+ ]
3845
+ }` })
3846
+ ]
3847
+ }
3848
+ ) }),
3849
+ /* @__PURE__ */ jsx5("div", { id: "delete-validation-run", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3850
+ EndpointBlock,
3851
+ {
3852
+ method: "DELETE",
3853
+ path: "/v1/validation/runs/{id}",
3854
+ summary: "Delete a validation run.",
3855
+ description: "Requires write scope."
3856
+ }
3857
+ ) }),
3858
+ /* @__PURE__ */ jsx5(SectionHeading, { id: "credits", children: "Credits" }),
3859
+ /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "Track credit balance, transaction history, and usage breakdowns by operation type and time period." }),
3860
+ /* @__PURE__ */ jsx5("div", { id: "credits-balance", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3861
+ EndpointBlock,
3862
+ {
3863
+ method: "GET",
3864
+ path: "/v1/credits/balance",
3865
+ summary: "Get current credit balance.",
3866
+ description: "Requires read scope.",
3867
+ children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
3868
+ "balance": 4250.00,
3869
+ "currency": "USD",
3870
+ "as_of": "2026-04-27T12:00:00Z"
3871
+ }` })
3872
+ }
3873
+ ) }),
3874
+ /* @__PURE__ */ jsx5("div", { id: "credits-history", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3875
+ EndpointBlock,
3876
+ {
3877
+ method: "GET",
3878
+ path: "/v1/credits/history",
3879
+ summary: "Get credit transaction history.",
3880
+ description: "Requires read scope.",
3881
+ children: /* @__PURE__ */ jsx5(ParamTable, { params: [
3882
+ { name: "limit", type: "integer", required: false, description: "Max items to return (default 20)." },
3883
+ { name: "cursor", type: "string", required: false, description: "Pagination cursor." }
3884
+ ] })
3885
+ }
3886
+ ) }),
3887
+ /* @__PURE__ */ jsx5("div", { id: "credits-usage-summary", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3888
+ EndpointBlock,
3889
+ {
3890
+ method: "GET",
3891
+ path: "/v1/credits/usage-summary",
3892
+ summary: "Get aggregate usage summary by operation type.",
3893
+ description: "Requires read scope.",
3894
+ children: /* @__PURE__ */ jsx5(ParamTable, { params: [
3895
+ { name: "from", type: "date-time", required: false, description: "Start of period (default 30 days ago)." },
3896
+ { name: "to", type: "date-time", required: false, description: "End of period (default now)." }
3897
+ ] })
3898
+ }
3899
+ ) }),
3900
+ /* @__PURE__ */ jsx5("div", { id: "credits-daily-usage", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3901
+ EndpointBlock,
3902
+ {
3903
+ method: "GET",
3904
+ path: "/v1/credits/daily-usage",
3905
+ summary: "Get daily usage breakdown.",
3906
+ description: "Requires read scope."
3907
+ }
3908
+ ) }),
3909
+ /* @__PURE__ */ jsx5("div", { id: "credits-usage-log", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
3910
+ EndpointBlock,
3911
+ {
3912
+ method: "GET",
3913
+ path: "/v1/credits/usage-log",
3914
+ summary: "Get per-request usage log with token counts and cost estimates.",
3915
+ description: "Requires read scope.",
3916
+ children: /* @__PURE__ */ jsx5(ParamTable, { params: [
3917
+ { name: "limit", type: "integer", required: false, description: "Max items to return (default 50)." },
3918
+ { name: "cursor", type: "string", required: false, description: "Pagination cursor." }
3919
+ ] })
3920
+ }
3921
+ ) }),
3317
3922
  /* @__PURE__ */ jsx5(SectionHeading, { id: "agent", children: "Agent" }),
3318
3923
  /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-6", children: "The Agent API provides programmatic access to the same AI assistant capabilities available in the Talonic platform UI. Use the context endpoint to retrieve a comprehensive workspace snapshot, and the tools endpoint to discover all available agent capabilities." }),
3319
3924
  /* @__PURE__ */ jsx5("div", { id: "agent-context", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
@@ -4880,44 +5485,49 @@ var API_NAV_SECTIONS = [
4880
5485
  { id: "list-class-versions", label: "List Versions" },
4881
5486
  { id: "get-class-version", label: "Get Version" },
4882
5487
  { id: "list-schema-graph-diffs", label: "List Diffs" },
4883
- { id: "approve-diff", label: "Approve Diff" },
4884
- { id: "reject-diff", label: "Reject Diff" },
5488
+ { id: "approve-schema-graph-diff", label: "Approve Diff" },
5489
+ { id: "reject-schema-graph-diff", label: "Reject Diff" },
4885
5490
  { id: "list-schema-graph-edges", label: "Edges" },
4886
5491
  { id: "list-schema-graph-aliases", label: "Aliases" },
4887
5492
  { id: "visualize-schema-graph", label: "Visualize" }
4888
5493
  ] },
4889
5494
  { id: "structuring", label: "Structuring", children: [
5495
+ { id: "structuring-checks", label: "Checks" },
4890
5496
  { id: "list-structuring-checks", label: "List Checks" },
4891
5497
  { id: "create-structuring-check", label: "Create Check" },
4892
- { id: "get-structuring-check", label: "Get / Update / Delete Check" },
5498
+ { id: "get-structuring-check", label: "Get Check" },
5499
+ { id: "update-structuring-check", label: "Update Check" },
5500
+ { id: "delete-structuring-check", label: "Delete Check" },
5501
+ { id: "structuring-gates", label: "Approval Gates" },
4893
5502
  { id: "list-structuring-gates", label: "List Gates" },
4894
5503
  { id: "create-structuring-gate", label: "Create Gate" },
4895
- { id: "get-structuring-gate", label: "Get / Update / Delete Gate" },
4896
- { id: "gate-rules", label: "Gate Rules" },
4897
- { id: "result-checks", label: "Result Checks" },
4898
- { id: "pending-approvals", label: "Pending Approvals" },
4899
- { id: "approve-reject-result", label: "Approve / Reject Result" },
4900
- { id: "trigger-delivery", label: "Trigger Delivery" }
5504
+ { id: "get-structuring-gate", label: "Get Gate" },
5505
+ { id: "update-structuring-gate", label: "Update Gate" },
5506
+ { id: "delete-structuring-gate", label: "Delete Gate" }
4901
5507
  ] },
4902
5508
  { id: "telemetry", label: "Telemetry", children: [
4903
- { id: "schema-telemetry-summary", label: "Schema Summary" },
4904
- { id: "schema-telemetry-trend", label: "Schema Trend" },
4905
- { id: "schema-telemetry-fields", label: "Schema Fields" },
4906
- { id: "run-telemetry-summary", label: "Run Summary" }
5509
+ { id: "telemetry-schema-summary", label: "Schema Summary" },
5510
+ { id: "telemetry-schema-trend", label: "Schema Trend" },
5511
+ { id: "telemetry-schema-fields", label: "Schema Fields" },
5512
+ { id: "telemetry-run-summary", label: "Run Summary" }
4907
5513
  ] },
4908
5514
  { id: "validation", label: "Validation", children: [
4909
- { id: "list-ground-truth", label: "List Golden Samples" },
4910
- { id: "get-ground-truth", label: "Get / Delete Golden Sample" },
4911
- { id: "list-validation-runs", label: "List Validation Runs" },
4912
- { id: "create-validation-run", label: "Create Validation Run" },
4913
- { id: "get-validation-run", label: "Get / Delete Validation Run" },
4914
- { id: "get-validation-results", label: "Validation Results" }
5515
+ { id: "golden-samples", label: "Golden Samples" },
5516
+ { id: "list-golden-samples", label: "List Golden Samples" },
5517
+ { id: "get-golden-sample", label: "Get Golden Sample" },
5518
+ { id: "delete-golden-sample", label: "Delete Golden Sample" },
5519
+ { id: "validation-runs", label: "Validation Runs" },
5520
+ { id: "list-validation-runs", label: "List Runs" },
5521
+ { id: "create-validation-run", label: "Create Run" },
5522
+ { id: "get-validation-run", label: "Get Run" },
5523
+ { id: "get-validation-results", label: "Results" },
5524
+ { id: "delete-validation-run", label: "Delete Run" }
4915
5525
  ] },
4916
5526
  { id: "credits", label: "Credits", children: [
4917
5527
  { id: "credits-balance", label: "Balance" },
4918
5528
  { id: "credits-history", label: "History" },
4919
- { id: "credits-usage", label: "Usage Summary" },
4920
- { id: "credits-usage-daily", label: "Daily Usage" },
5529
+ { id: "credits-usage-summary", label: "Usage Summary" },
5530
+ { id: "credits-daily-usage", label: "Daily Usage" },
4921
5531
  { id: "credits-usage-log", label: "Usage Log" }
4922
5532
  ] },
4923
5533
  { id: "agent", label: "Agent", children: [
@@ -5054,374 +5664,6 @@ var PLATFORM_SECTION_META = [
5054
5664
  { id: "api-webhooks", title: "API & Webhooks", description: "API key management, public REST API overview, and webhook configuration for event-driven integrations." },
5055
5665
  { id: "team-admin", title: "Team & Admin", description: "Role-based access control, credit usage tracking, admin panel, and keyboard shortcuts." }
5056
5666
  ];
5057
- var OPENAPI_SPEC = {
5058
- openapi: "3.1.0",
5059
- info: {
5060
- title: "Talonic API",
5061
- version: "1.0.0",
5062
- description: "Extract any document into schema-validated data with a single API call.",
5063
- contact: { url: "https://talonic.com" }
5064
- },
5065
- servers: [{ url: "https://api.talonic.com", description: "Production" }],
5066
- security: [{ bearerAuth: [] }],
5067
- components: {
5068
- securitySchemes: {
5069
- bearerAuth: { type: "http", scheme: "bearer", description: "API key with tlnc_ prefix" }
5070
- }
5071
- },
5072
- paths: {
5073
- "/v1/extract": {
5074
- post: {
5075
- operationId: "extract",
5076
- summary: "Extract structured data from a document",
5077
- description: "Accepts the document as a file upload or URL, along with a schema definition. Returns structured data matching your schema with per-field confidence scores.",
5078
- tags: ["Extract"],
5079
- requestBody: { content: { "multipart/form-data": { schema: { type: "object", properties: {
5080
- file: { type: "string", format: "binary", description: "The document file (PDF, DOCX, PNG, JPG, XLSX, CSV, TXT, MD)" },
5081
- file_url: { type: "string", description: "URL to fetch the document from" },
5082
- document_id: { type: "string", description: "Re-extract an existing document by ID" },
5083
- schema: { type: "object", description: "Target schema definition (JSON Schema, simplified fields, or flat key-type map)" },
5084
- schema_id: { type: "string", description: "Use a previously saved schema by ID" },
5085
- instructions: { type: "string", description: "Natural language extraction instructions" },
5086
- include_markdown: { type: "string", description: 'Set to "true" to include OCR markdown in response' }
5087
- } } } } },
5088
- responses: { "200": { description: "Extraction result with data, confidence, and metadata" }, "202": { description: "Async job accepted (when async=true)" } }
5089
- }
5090
- },
5091
- "/v1/documents": {
5092
- get: {
5093
- operationId: "listDocuments",
5094
- summary: "List all documents",
5095
- tags: ["Documents"],
5096
- parameters: [
5097
- { name: "source_id", in: "query", schema: { type: "string" } },
5098
- { name: "status", in: "query", schema: { type: "string", enum: ["pending", "processing", "completed", "error"] } },
5099
- { name: "page", in: "query", schema: { type: "integer", default: 1 } },
5100
- { name: "per_page", in: "query", schema: { type: "integer", default: 50 } }
5101
- ],
5102
- responses: { "200": { description: "Paginated list of documents" } }
5103
- }
5104
- },
5105
- "/v1/documents/{id}": {
5106
- get: { operationId: "getDocument", summary: "Get a document", tags: ["Documents"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Document with full metadata" } } },
5107
- delete: { operationId: "deleteDocument", summary: "Delete a document and all extractions", tags: ["Documents"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Deletion confirmation" } } }
5108
- },
5109
- "/v1/documents/{id}/markdown": {
5110
- get: { operationId: "getDocumentMarkdown", summary: "Get OCR markdown of a document", tags: ["Documents"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Document markdown content" } } }
5111
- },
5112
- "/v1/extractions": {
5113
- get: { operationId: "listExtractions", summary: "List extractions", tags: ["Extractions"], parameters: [
5114
- { name: "document_id", in: "query", schema: { type: "string" } },
5115
- { name: "schema_id", in: "query", schema: { type: "string" } },
5116
- { name: "page", in: "query", schema: { type: "integer", default: 1 } }
5117
- ], responses: { "200": { description: "Paginated list of extractions" } } }
5118
- },
5119
- "/v1/extractions/{id}": {
5120
- get: { operationId: "getExtraction", summary: "Get extraction result", tags: ["Extractions"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Full extraction with data, confidence, metadata" } } }
5121
- },
5122
- "/v1/extractions/{id}/data": {
5123
- get: { operationId: "getExtractionData", summary: "Get extracted data (JSON or CSV)", tags: ["Extractions"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }, { name: "format", in: "query", schema: { type: "string", default: "json" } }], responses: { "200": { description: "Extracted data" } } },
5124
- patch: { operationId: "correctFields", summary: "Correct extraction fields", tags: ["Extractions"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Updated extraction" } } }
5125
- },
5126
- "/v1/schemas": {
5127
- get: { operationId: "listSchemas", summary: "List all schemas", tags: ["Schemas"], responses: { "200": { description: "List of schemas" } } },
5128
- post: { operationId: "createSchema", summary: "Create a new schema", tags: ["Schemas"], responses: { "201": { description: "Created schema" } } }
5129
- },
5130
- "/v1/schemas/{id}": {
5131
- get: { operationId: "getSchema", summary: "Get a schema", tags: ["Schemas"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Schema with definition" } } },
5132
- put: { operationId: "updateSchema", summary: "Update a schema", tags: ["Schemas"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Updated schema" } } },
5133
- delete: { operationId: "deleteSchema", summary: "Delete a schema", tags: ["Schemas"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Deletion confirmation" } } }
5134
- },
5135
- "/v1/jobs": {
5136
- get: { operationId: "listJobs", summary: "List all jobs", tags: ["Jobs"], responses: { "200": { description: "Paginated list of jobs" } } }
5137
- },
5138
- "/v1/jobs/{id}": {
5139
- get: { operationId: "getJob", summary: "Get job status and progress", tags: ["Jobs"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Job with progress and grid stats" } } }
5140
- },
5141
- "/v1/jobs/{id}/cancel": {
5142
- post: { operationId: "cancelJob", summary: "Cancel a running job", tags: ["Jobs"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Cancelled job" } } }
5143
- },
5144
- "/v1/sources": {
5145
- get: { operationId: "listSources", summary: "List all sources", tags: ["Sources"], responses: { "200": { description: "List of sources" } } },
5146
- post: { operationId: "createSource", summary: "Create a new source (returns API key)", tags: ["Sources"], responses: { "201": { description: "Created source with API key" } } }
5147
- },
5148
- "/v1/sources/{id}": {
5149
- get: { operationId: "getSource", summary: "Get source details", tags: ["Sources"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Source details" } } },
5150
- patch: { operationId: "updateSource", summary: "Update a source", tags: ["Sources"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Updated source" } } },
5151
- delete: { operationId: "deleteSource", summary: "Delete a source", tags: ["Sources"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Deletion confirmation" } } }
5152
- },
5153
- "/v1/sources/{id}/documents": {
5154
- get: { operationId: "listSourceDocuments", summary: "List documents in a source", tags: ["Sources"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Paginated documents" } } },
5155
- post: { operationId: "ingestDocument", summary: "Ingest a document into a source", tags: ["Sources"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Ingested document" } } }
5156
- },
5157
- // Resolutions
5158
- "/v1/resolutions": {
5159
- get: { operationId: "listResolutions", summary: "List resolution runs", tags: ["Resolutions"], responses: { "200": { description: "Paginated list of resolution runs" } } },
5160
- post: { operationId: "createResolution", summary: "Create a resolution run", tags: ["Resolutions"], responses: { "201": { description: "Resolution run created" } } }
5161
- },
5162
- "/v1/resolutions/{id}": {
5163
- get: { operationId: "getResolution", summary: "Get a resolution run", tags: ["Resolutions"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Resolution run detail" } } },
5164
- delete: { operationId: "deleteResolution", summary: "Delete a resolution run", tags: ["Resolutions"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Resolution run deleted" } } }
5165
- },
5166
- "/v1/resolutions/{id}/results": {
5167
- get: { operationId: "getResolutionResults", summary: "Get resolution run results", tags: ["Resolutions"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Resolution results" } } }
5168
- },
5169
- "/v1/resolutions/{id}/execute": {
5170
- post: { operationId: "executeResolution", summary: "Execute a resolution run", tags: ["Resolutions"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Resolution execution started" } } }
5171
- },
5172
- // Linking
5173
- "/v1/linking/link-keys": {
5174
- get: { operationId: "listLinkKeys", summary: "List link keys", tags: ["Linking"], responses: { "200": { description: "List of link keys" } } }
5175
- },
5176
- "/v1/linking/documents/{id}/links": {
5177
- get: { operationId: "getDocumentLinks", summary: "Get links for a document", tags: ["Linking"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Document links" } } }
5178
- },
5179
- "/v1/linking/graph": {
5180
- get: { operationId: "getLinkingGraph", summary: "Get the full linking graph", tags: ["Linking"], responses: { "200": { description: "Full linking graph" } } }
5181
- },
5182
- "/v1/linking/graph/documents/{id}": {
5183
- get: { operationId: "getDocumentGraph", summary: "Get graph neighbourhood for a document", tags: ["Linking"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Document-centric subgraph" } } }
5184
- },
5185
- "/v1/linking/classify": {
5186
- post: { operationId: "classifyLinkKeys", summary: "Classify link keys", tags: ["Linking"], responses: { "200": { description: "Classification results" } } }
5187
- },
5188
- "/v1/linking/backfill": {
5189
- post: { operationId: "backfillLinking", summary: "Backfill linking data", tags: ["Linking"], responses: { "202": { description: "Backfill started" } } }
5190
- },
5191
- "/v1/linking/backfill/progress": {
5192
- get: { operationId: "getBackfillProgress", summary: "Get backfill progress", tags: ["Linking"], responses: { "200": { description: "Backfill progress" } } }
5193
- },
5194
- "/v1/linking/document-case-map": {
5195
- get: { operationId: "getDocumentCaseMap", summary: "Get document-to-case mapping", tags: ["Linking"], responses: { "200": { description: "Document-case mapping" } } }
5196
- },
5197
- // N-Shot
5198
- "/v1/jobs/runs/{runId}/nshot/summary": {
5199
- get: { operationId: "getNshotSummary", summary: "Get N-Shot summary for a run", tags: ["N-Shot"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "N-Shot summary" } } }
5200
- },
5201
- "/v1/jobs/runs/{runId}/nshot/comparisons": {
5202
- get: { operationId: "listNshotComparisons", summary: "List N-Shot comparisons", tags: ["N-Shot"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "List of comparisons" } } }
5203
- },
5204
- "/v1/jobs/runs/{runId}/nshot/comparison": {
5205
- get: { operationId: "getNshotComparison", summary: "Get a specific N-Shot comparison", tags: ["N-Shot"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Single comparison result" } } }
5206
- },
5207
- "/v1/jobs/runs/{runId}/nshot/override": {
5208
- post: { operationId: "nshotOverride", summary: "Override an N-Shot value", tags: ["N-Shot"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Override applied" } } }
5209
- },
5210
- "/v1/jobs/runs/{runId}/nshot/judge-decision": {
5211
- post: { operationId: "nshotJudgeDecision", summary: "Submit a judge decision for N-Shot", tags: ["N-Shot"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Judge decision recorded" } } }
5212
- },
5213
- // Schema Graph
5214
- "/v1/schema-graph/classes": {
5215
- get: { operationId: "listSchemaGraphClasses", summary: "List schema graph classes", tags: ["Schema Graph"], responses: { "200": { description: "List of schema graph classes" } } }
5216
- },
5217
- "/v1/schema-graph/classes/{id}": {
5218
- get: { operationId: "getSchemaGraphClass", summary: "Get a schema graph class", tags: ["Schema Graph"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Schema graph class detail" } } }
5219
- },
5220
- "/v1/schema-graph/classes/{id}/versions": {
5221
- get: { operationId: "listSchemaGraphClassVersions", summary: "List versions of a schema graph class", tags: ["Schema Graph"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "List of class versions" } } }
5222
- },
5223
- "/v1/schema-graph/classes/{id}/versions/{version}": {
5224
- get: { operationId: "getSchemaGraphClassVersion", summary: "Get a specific class version", tags: ["Schema Graph"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }, { name: "version", in: "path", required: true, schema: { type: "integer" } }], responses: { "200": { description: "Class version detail" } } }
5225
- },
5226
- "/v1/schema-graph/diffs": {
5227
- get: { operationId: "listSchemaGraphDiffs", summary: "List schema graph diffs", tags: ["Schema Graph"], responses: { "200": { description: "List of diffs" } } }
5228
- },
5229
- "/v1/schema-graph/diffs/{id}/approve": {
5230
- post: { operationId: "approveSchemaGraphDiff", summary: "Approve a schema graph diff", tags: ["Schema Graph"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Diff approved" } } }
5231
- },
5232
- "/v1/schema-graph/diffs/{id}/reject": {
5233
- post: { operationId: "rejectSchemaGraphDiff", summary: "Reject a schema graph diff", tags: ["Schema Graph"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Diff rejected" } } }
5234
- },
5235
- "/v1/schema-graph/edges": {
5236
- get: { operationId: "listSchemaGraphEdges", summary: "List schema graph edges", tags: ["Schema Graph"], responses: { "200": { description: "List of edges" } } }
5237
- },
5238
- "/v1/schema-graph/aliases": {
5239
- get: { operationId: "listSchemaGraphAliases", summary: "List schema graph aliases", tags: ["Schema Graph"], responses: { "200": { description: "List of aliases" } } }
5240
- },
5241
- "/v1/schema-graph/visualize": {
5242
- get: { operationId: "visualizeSchemaGraph", summary: "Get schema graph visualization data", tags: ["Schema Graph"], responses: { "200": { description: "Visualization data" } } }
5243
- },
5244
- // Structuring
5245
- "/v1/structuring/checks": {
5246
- get: { operationId: "listStructuringChecks", summary: "List structuring checks", tags: ["Structuring"], responses: { "200": { description: "Paginated list of structuring checks" } } },
5247
- post: { operationId: "createStructuringCheck", summary: "Create a structuring check", tags: ["Structuring"], responses: { "201": { description: "Structuring check created" } } }
5248
- },
5249
- "/v1/structuring/checks/{id}": {
5250
- get: { operationId: "getStructuringCheck", summary: "Get a structuring check", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Structuring check detail" } } },
5251
- put: { operationId: "updateStructuringCheck", summary: "Update a structuring check", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Structuring check updated" } } },
5252
- delete: { operationId: "deleteStructuringCheck", summary: "Delete a structuring check", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Structuring check deleted" } } }
5253
- },
5254
- "/v1/structuring/gates": {
5255
- get: { operationId: "listStructuringGates", summary: "List approval gates", tags: ["Structuring"], responses: { "200": { description: "Paginated list of approval gates" } } },
5256
- post: { operationId: "createStructuringGate", summary: "Create an approval gate", tags: ["Structuring"], responses: { "201": { description: "Approval gate created" } } }
5257
- },
5258
- "/v1/structuring/gates/{id}": {
5259
- get: { operationId: "getStructuringGate", summary: "Get an approval gate", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Approval gate detail" } } },
5260
- put: { operationId: "updateStructuringGate", summary: "Update an approval gate", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Approval gate updated" } } },
5261
- delete: { operationId: "deleteStructuringGate", summary: "Delete an approval gate", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Approval gate deleted" } } }
5262
- },
5263
- "/v1/structuring/gates/{id}/rules": {
5264
- post: { operationId: "addStructuringGateRule", summary: "Add a rule to an approval gate", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "201": { description: "Rule added" } } },
5265
- delete: { operationId: "deleteStructuringGateRule", summary: "Remove a rule from an approval gate", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Rule removed" } } }
5266
- },
5267
- "/v1/structuring/results/{id}/checks": {
5268
- get: { operationId: "getStructuringResultChecks", summary: "Get check results for a structuring result", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Check results" } } }
5269
- },
5270
- "/v1/structuring/approvals/pending": {
5271
- get: { operationId: "listPendingApprovals", summary: "List pending approvals", tags: ["Structuring"], responses: { "200": { description: "Paginated list of pending approvals" } } }
5272
- },
5273
- "/v1/structuring/approvals/{id}/approve": {
5274
- post: { operationId: "approveStructuringResult", summary: "Approve a structuring result", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Result approved" } } }
5275
- },
5276
- "/v1/structuring/approvals/{id}/reject": {
5277
- post: { operationId: "rejectStructuringResult", summary: "Reject a structuring result", tags: ["Structuring"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Result rejected" } } }
5278
- },
5279
- "/v1/structuring/delivery/{runId}": {
5280
- post: { operationId: "triggerStructuringDelivery", summary: "Trigger delivery for a structuring run", tags: ["Structuring"], parameters: [{ name: "runId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Delivery triggered" } } }
5281
- },
5282
- // Telemetry
5283
- "/v1/telemetry/schemas/{id}/summary": {
5284
- get: { operationId: "getTelemetrySchemaSummary", summary: "Get telemetry summary for a schema", tags: ["Telemetry"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Schema telemetry summary" } } }
5285
- },
5286
- "/v1/telemetry/schemas/{id}/trend": {
5287
- get: { operationId: "getTelemetrySchemaTrend", summary: "Get telemetry trend for a schema", tags: ["Telemetry"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Schema telemetry trend" } } }
5288
- },
5289
- "/v1/telemetry/schemas/{id}/fields": {
5290
- get: { operationId: "getTelemetrySchemaFields", summary: "Get per-field telemetry for a schema", tags: ["Telemetry"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Per-field telemetry" } } }
5291
- },
5292
- "/v1/telemetry/runs/{id}/summary": {
5293
- get: { operationId: "getTelemetryRunSummary", summary: "Get telemetry summary for a run", tags: ["Telemetry"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Run telemetry summary" } } }
5294
- },
5295
- // Validation
5296
- "/v1/validation/ground-truth": {
5297
- get: { operationId: "listGroundTruths", summary: "List golden samples", tags: ["Validation"], responses: { "200": { description: "Paginated list of golden samples" } } }
5298
- },
5299
- "/v1/validation/ground-truth/{id}": {
5300
- get: { operationId: "getGroundTruth", summary: "Get a golden sample", tags: ["Validation"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Golden sample detail" } } },
5301
- delete: { operationId: "deleteGroundTruth", summary: "Delete a golden sample", tags: ["Validation"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Golden sample deleted" } } }
5302
- },
5303
- "/v1/validation/runs": {
5304
- get: { operationId: "listValidationRuns", summary: "List validation runs", tags: ["Validation"], responses: { "200": { description: "Paginated list of validation runs" } } },
5305
- post: { operationId: "createValidationRun", summary: "Create a validation run", tags: ["Validation"], responses: { "201": { description: "Validation run created" } } }
5306
- },
5307
- "/v1/validation/runs/{id}": {
5308
- get: { operationId: "getValidationRun", summary: "Get a validation run", tags: ["Validation"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Validation run detail" } } },
5309
- delete: { operationId: "deleteValidationRun", summary: "Delete a validation run", tags: ["Validation"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Validation run deleted" } } }
5310
- },
5311
- "/v1/validation/runs/{id}/results": {
5312
- get: { operationId: "getValidationRunResults", summary: "Get validation run results", tags: ["Validation"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Validation run results" } } }
5313
- },
5314
- // Credits
5315
- "/v1/credits/balance": {
5316
- get: { operationId: "getCreditsBalance", summary: "Get credit balance", tags: ["Credits"], responses: { "200": { description: "Credit balance" } } }
5317
- },
5318
- "/v1/credits/history": {
5319
- get: { operationId: "getCreditsHistory", summary: "Get credit history", tags: ["Credits"], responses: { "200": { description: "Paginated credit history" } } }
5320
- },
5321
- "/v1/credits/usage": {
5322
- get: { operationId: "getCreditsUsage", summary: "Get credit usage summary", tags: ["Credits"], responses: { "200": { description: "Credit usage summary" } } }
5323
- },
5324
- "/v1/credits/usage/daily": {
5325
- get: { operationId: "getCreditsUsageDaily", summary: "Get daily credit usage", tags: ["Credits"], responses: { "200": { description: "Daily credit usage" } } }
5326
- },
5327
- "/v1/credits/usage/log": {
5328
- get: { operationId: "getCreditsUsageLog", summary: "Get credit usage log", tags: ["Credits"], responses: { "200": { description: "Paginated usage log" } } }
5329
- },
5330
- // Expanded: Cases
5331
- "/v1/cases/{key}/status": {
5332
- patch: { operationId: "updateCaseStatus", summary: "Update case status", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Case status updated" } } }
5333
- },
5334
- "/v1/cases/{key}/edges": {
5335
- get: { operationId: "getCaseEdges", summary: "Get case edges", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Case edges" } } }
5336
- },
5337
- "/v1/cases/edges/confirm": {
5338
- post: { operationId: "confirmCaseEdge", summary: "Confirm a case edge", tags: ["Cases"], responses: { "200": { description: "Edge confirmed" } } }
5339
- },
5340
- "/v1/cases/edges/reject": {
5341
- post: { operationId: "rejectCaseEdge", summary: "Reject a case edge", tags: ["Cases"], responses: { "200": { description: "Edge rejected" } } }
5342
- },
5343
- "/v1/cases/{key}/split": {
5344
- post: { operationId: "splitCase", summary: "Split a case", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Case split" } } }
5345
- },
5346
- "/v1/cases/{key}/merge": {
5347
- post: { operationId: "mergeCases", summary: "Merge cases", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Cases merged" } } }
5348
- },
5349
- "/v1/cases/{key}/completeness": {
5350
- get: { operationId: "getCaseCompleteness", summary: "Get case completeness", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Completeness assessment" } } }
5351
- },
5352
- "/v1/cases/{key}/pin": {
5353
- post: { operationId: "pinCaseDocuments", summary: "Pin documents to a case", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Documents pinned" } } }
5354
- },
5355
- "/v1/cases/{key}/documents": {
5356
- delete: { operationId: "removeCaseDocuments", summary: "Remove documents from a case", tags: ["Cases"], parameters: [{ name: "key", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Documents removed" } } }
5357
- },
5358
- // Expanded: Batches
5359
- "/v1/batches/{id}/sync": {
5360
- post: { operationId: "syncBatch", summary: "Sync batch status with provider", tags: ["Batches"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Batch synced" } } }
5361
- },
5362
- "/v1/batches/{id}/cancel": {
5363
- post: { operationId: "cancelBatch", summary: "Cancel a batch inference run", tags: ["Batches"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Batch cancelled" } } }
5364
- },
5365
- // Expanded: Matching
5366
- "/v1/matching/smart-run": {
5367
- post: { operationId: "triggerSmartMatchingRun", summary: "Trigger a smart matching run", tags: ["Matching"], responses: { "201": { description: "Smart matching run queued" } } }
5368
- },
5369
- "/v1/matching/ai-resolve": {
5370
- post: { operationId: "aiResolveMatching", summary: "AI-resolve ambiguous matches", tags: ["Matching"], responses: { "200": { description: "AI resolution results" } } }
5371
- },
5372
- "/v1/matching/strategies": {
5373
- get: { operationId: "listMatchingStrategies", summary: "List matching strategies", tags: ["Matching"], responses: { "200": { description: "List of matching strategies" } } },
5374
- post: { operationId: "createMatchingStrategy", summary: "Create a matching strategy", tags: ["Matching"], responses: { "201": { description: "Matching strategy created" } } }
5375
- },
5376
- "/v1/matching/strategies/{id}": {
5377
- get: { operationId: "getMatchingStrategy", summary: "Get a matching strategy", tags: ["Matching"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Matching strategy detail" } } },
5378
- put: { operationId: "updateMatchingStrategy", summary: "Update a matching strategy", tags: ["Matching"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Matching strategy updated" } } },
5379
- delete: { operationId: "deleteMatchingStrategy", summary: "Delete a matching strategy", tags: ["Matching"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Matching strategy deleted" } } }
5380
- },
5381
- "/v1/matching/runs/{id}/results": {
5382
- get: { operationId: "getMatchingRunResults", summary: "Get matching run results", tags: ["Matching"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Matching run results" } } }
5383
- },
5384
- "/v1/matching/runs/{id}/progress": {
5385
- get: { operationId: "getMatchingRunProgress", summary: "Get matching run progress", tags: ["Matching"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Matching run progress" } } }
5386
- },
5387
- "/v1/matching/review": {
5388
- post: { operationId: "submitMatchingReview", summary: "Submit matching review decisions", tags: ["Matching"], responses: { "200": { description: "Review decisions applied" } } }
5389
- },
5390
- // Expanded: Review
5391
- "/v1/review/assign": {
5392
- post: { operationId: "assignReview", summary: "Assign review records", tags: ["Review"], responses: { "200": { description: "Records assigned" } } }
5393
- },
5394
- "/v1/review/stats": {
5395
- get: { operationId: "getReviewStats", summary: "Get review queue statistics", tags: ["Review"], responses: { "200": { description: "Review statistics" } } }
5396
- },
5397
- // Expanded: Quality
5398
- "/v1/quality/ground-truth/{id}/entries": {
5399
- get: { operationId: "listGroundTruthEntries", summary: "List ground truth entries", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Paginated list of entries" } } },
5400
- post: { operationId: "createGroundTruthEntry", summary: "Add a ground truth entry", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "201": { description: "Entry created" } } }
5401
- },
5402
- "/v1/quality/ground-truth/{id}/entries/{entryId}": {
5403
- put: { operationId: "updateGroundTruthEntry", summary: "Update a ground truth entry", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }, { name: "entryId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Entry updated" } } },
5404
- delete: { operationId: "deleteGroundTruthEntry", summary: "Delete a ground truth entry", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }, { name: "entryId", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Entry deleted" } } }
5405
- },
5406
- "/v1/quality/benchmarks/{id}/results": {
5407
- get: { operationId: "getBenchmarkResults", summary: "Get benchmark results", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Benchmark results" } } }
5408
- },
5409
- "/v1/quality/benchmarks/{id}/compare": {
5410
- get: { operationId: "compareBenchmarks", summary: "Compare two benchmark runs", tags: ["Quality"], parameters: [{ name: "id", in: "path", required: true, schema: { type: "string" } }], responses: { "200": { description: "Benchmark comparison" } } }
5411
- },
5412
- // Expanded: Reference Data
5413
- "/v1/reference-data/create": {
5414
- post: { operationId: "createReferenceDataJson", summary: "Create reference data from JSON", tags: ["Reference Data"], responses: { "201": { description: "Reference dataset created" } } }
5415
- },
5416
- // Agent
5417
- "/v1/agent/context": {
5418
- get: { operationId: "getAgentContext", summary: "Get comprehensive workspace context", tags: ["Agent"], responses: { "200": { description: "Workspace overview with documents, schemas, runs, field registry, and recent activity" } } }
5419
- },
5420
- "/v1/agent/tools": {
5421
- get: { operationId: "listAgentTools", summary: "List all agent tools", tags: ["Agent"], responses: { "200": { description: "List of available agent tools with impact level and description" } } }
5422
- }
5423
- }
5424
- };
5425
5667
  var API_FAQ = [
5426
5668
  { question: "What file formats does the Talonic API support?", answer: "PDF, DOCX, DOC, PPTX, PPT, XLSX, XLS, XLSM, PNG, JPG, JPEG, GIF, WEBP, TXT, MD, HTML, XML, JSON, EML, CSV, MSG, BMP, and ZIP archives." },
5427
5669
  { question: "How does authentication work?", answer: "All API requests require a Bearer token in the Authorization header. API keys carry the tlnc_ prefix and are scoped to a source. Create and manage keys from Settings \u2192 API Keys." },
@@ -5602,7 +5844,6 @@ export {
5602
5844
  LLMS_TXT,
5603
5845
  MethodBadge,
5604
5846
  MockNavItem,
5605
- OPENAPI_SPEC,
5606
5847
  P,
5607
5848
  PLATFORM_FAQ,
5608
5849
  PLATFORM_NAV_SECTIONS,