@talonic/docs 0.20.7 → 0.20.9

package/dist/index.js

@@ -703,6 +703,7 @@ var NAV_SECTIONS = [
     id: "webhooks",
     label: "Webhooks",
     children: [
+      { id: "webhook-management", label: "Management" },
       { id: "webhook-events", label: "Events" },
       { id: "webhook-delivery", label: "Delivery Format" },
       { id: "webhook-verification", label: "Signature Verification" },
@@ -812,6 +813,13 @@ var NAV_SECTIONS = [
       { id: "credits-usage-log", label: "Usage Log" }
     ]
   },
+  {
+    id: "billing",
+    label: "Billing",
+    children: [
+      { id: "billing-settings", label: "Settings" }
+    ]
+  },
   {
     id: "agent",
     label: "Agent",
@@ -1008,7 +1016,8 @@ function ApiReference({ LinkComponent }) {
                   { name: "schema_id", type: "string", description: "Use a previously saved schema by ID. Mutually exclusive with schema." },
                   { name: "instructions", type: "string", description: 'Natural language instructions to guide extraction. E.g. "Focus on the billing section. Amounts are in EUR."' },
                   { name: "options", type: "object", description: "Additional extraction options. See Options below." },
-                  { name: "include_markdown", type: "string", description: 'Set to "true" to include the OCR-converted markdown of the document in the response. Useful for PDF-to-markdown conversion.' }
+                  { name: "include_markdown", type: "string", description: 'Set to "true" to include the OCR-converted markdown of the document in the response. Useful for PDF-to-markdown conversion.' },
+                  { name: "include_provenance", type: "string", description: 'Set to "true" to include per-field provenance in the response. Each field gets source_text (the text the value was extracted from), section (document section), and page (page number).' }
                 ]
               }
             ),
@@ -1366,6 +1375,10 @@ function ApiReference({ LinkComponent }) {
       "line_items": 0.87
     }
   },
+  "provenance": {
+    "vendor_name": { "source_text": "Acme Corp Ltd.", "section": "Header", "page": 1 },
+    "invoice_total": { "source_text": "$14,250.00", "section": "Summary", "page": 2 }
+  },
   "metadata": {
     "pages": 2,
     "language": "en",
@@ -3768,6 +3781,83 @@ function ApiReference({ LinkComponent }) {
         /* @__PURE__ */ jsx5(InlineCode, { children: "webhook_url" }),
         " option."
       ] }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "webhook-management", children: "Management" }),
+      /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-4", children: "Programmatically create, update, and delete webhook configurations. Each webhook can be scoped to specific event types and optionally to a single source connection." }),
+      /* @__PURE__ */ jsx5(
+        EndpointBlock,
+        {
+          method: "GET",
+          path: "/v1/webhooks",
+          summary: "List webhook configurations.",
+          description: "Returns all webhook configurations for your organization.",
+          children: /* @__PURE__ */ jsx5(CodeBlock, { title: "200 \u2014 Response", children: `{
+  "data": [
+    {
+      "id": "whk_a1b2c3d4",
+      "url": "https://example.com/webhook",
+      "events": ["extraction.complete", "extraction.failed"],
+      "is_active": true,
+      "source_connection_id": null,
+      "created_at": "2026-05-01T10:00:00.000Z",
+      "updated_at": "2026-05-01T10:00:00.000Z"
+    }
+  ]
+}` })
+        }
+      ),
+      /* @__PURE__ */ jsx5(
+        EndpointBlock,
+        {
+          method: "POST",
+          path: "/v1/webhooks",
+          summary: "Create a webhook configuration.",
+          description: "Creates a new webhook endpoint for your organization.",
+          children: /* @__PURE__ */ jsx5(
+            ParamTable,
+            {
+              title: "Body parameters",
+              params: [
+                { name: "url", type: "string", required: true, description: "The HTTPS URL to deliver events to." },
+                { name: "secret", type: "string", description: "Shared secret for HMAC-SHA256 signature verification. Auto-generated if omitted." },
+                { name: "events", type: "string[]", description: 'Event types to subscribe to. Defaults to ["extraction.complete", "extraction.failed"].' },
+                { name: "source_connection_id", type: "string", description: "Scope deliveries to a specific source connection." },
+                { name: "is_active", type: "boolean", description: "Whether the webhook is active. Defaults to true." }
+              ]
+            }
+          )
+        }
+      ),
+      /* @__PURE__ */ jsx5(
+        EndpointBlock,
+        {
+          method: "PATCH",
+          path: "/v1/webhooks/:id",
+          summary: "Update a webhook configuration.",
+          description: "Partially update an existing webhook configuration.",
+          children: /* @__PURE__ */ jsx5(
+            ParamTable,
+            {
+              title: "Body parameters",
+              params: [
+                { name: "url", type: "string", description: "Updated delivery URL." },
+                { name: "secret", type: "string", description: "Updated signing secret." },
+                { name: "events", type: "string[]", description: "Updated event filter." },
+                { name: "is_active", type: "boolean", description: "Enable or disable the webhook." }
+              ]
+            }
+          )
+        }
+      ),
+      /* @__PURE__ */ jsx5(
+        EndpointBlock,
+        {
+          method: "DELETE",
+          path: "/v1/webhooks/:id",
+          summary: "Delete a webhook configuration.",
+          description: "Permanently removes a webhook configuration. Pending deliveries are cancelled.",
+          children: /* @__PURE__ */ jsx5(CodeBlock, { title: "200 \u2014 Response", children: `{ "deleted": true, "id": "whk_a1b2c3d4" }` })
+        }
+      ),
       /* @__PURE__ */ jsx5(SubHeading, { id: "webhook-events", children: "Events" }),
       /* @__PURE__ */ jsx5("div", { className: "border border-void-border rounded-lg overflow-hidden my-4", children: /* @__PURE__ */ jsxs5("table", { className: "w-full text-sm", children: [
         /* @__PURE__ */ jsx5("thead", { children: /* @__PURE__ */ jsxs5("tr", { className: "bg-void-surface-2/50", children: [
@@ -4843,6 +4933,43 @@ function verifyWebhook(payload, signature, secret) {
           ]
         }
       ) }),
+      /* @__PURE__ */ jsx5(SectionHeading, { id: "billing", children: "Billing" }),
+      /* @__PURE__ */ jsx5(SubHeading, { id: "billing-settings", children: "Settings" }),
+      /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-4", children: "Manage auto top-up configuration. When enabled, your credit balance is automatically replenished when it falls below the threshold." }),
+      /* @__PURE__ */ jsx5(
+        EndpointBlock,
+        {
+          method: "GET",
+          path: "/v1/billing/settings",
+          summary: "Get billing settings.",
+          description: "Returns the current auto top-up configuration for your organization.",
+          children: /* @__PURE__ */ jsx5(CodeBlock, { title: "200 \u2014 Response", children: `{
+  "auto_topup_enabled": true,
+  "auto_topup_threshold": 1000,
+  "auto_topup_amount": 5000
+}` })
+        }
+      ),
+      /* @__PURE__ */ jsx5(
+        EndpointBlock,
+        {
+          method: "PATCH",
+          path: "/v1/billing/settings",
+          summary: "Update billing settings.",
+          description: "Update auto top-up configuration. All fields are optional.",
+          children: /* @__PURE__ */ jsx5(
+            ParamTable,
+            {
+              title: "Body parameters",
+              params: [
+                { name: "auto_topup_enabled", type: "boolean", description: "Enable or disable automatic top-up." },
+                { name: "auto_topup_threshold", type: "number", description: "Credit balance threshold that triggers a top-up. Minimum: 1000." },
+                { name: "auto_topup_amount", type: "number", description: "Number of credits to add on each top-up. Minimum: 1000." }
+              ]
+            }
+          )
+        }
+      ),
       /* @__PURE__ */ jsx5(SectionHeading, { id: "agent", children: "Agent" }),
       /* @__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." }),
       /* @__PURE__ */ jsx5("div", { id: "agent-context", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
@@ -4932,7 +5059,7 @@ function verifyWebhook(payload, signature, secret) {
           { status: "403", code: "forbidden", desc: "The API key does not have permission for this operation." },
           { status: "404", code: "not_found", desc: "The requested resource does not exist." },
           { status: "409", code: "conflict", desc: "The resource has been modified. Retry with the latest version." },
-          { status: "413", code: "file_too_large", desc: "The uploaded file exceeds the 50MB size limit." },
+          { status: "413", code: "file_too_large", desc: "The uploaded file exceeds the 50 MB per-request limit (up to 5 GB via source connectors)." },
           { status: "422", code: "unprocessable", desc: "The document could not be parsed. Try a different file format." },
           { status: "429", code: "rate_limited", desc: "Rate limit exceeded. Check response headers for reset time." },
           { status: "500", code: "internal_error", desc: "An unexpected error occurred. This is retryable." },