@talonic/docs 0.8.2 → 0.9.0

package/dist/index.d.ts

@@ -2192,6 +2192,30 @@ declare const OPENAPI_SPEC: {
                 };
             };
         };
+        '/v1/agent/context': {
+            get: {
+                operationId: string;
+                summary: string;
+                tags: string[];
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
+        '/v1/agent/tools': {
+            get: {
+                operationId: string;
+                summary: string;
+                tags: string[];
+                responses: {
+                    '200': {
+                        description: string;
+                    };
+                };
+            };
+        };
     };
 };
 declare const API_FAQ: {

package/dist/index.js

@@ -685,6 +685,14 @@ var NAV_SECTIONS = [
       { id: "webhook-retries", label: "Retry Policy" }
     ]
   },
+  {
+    id: "agent",
+    label: "Agent",
+    children: [
+      { id: "agent-context", label: "Get Workspace Context" },
+      { id: "agent-tools", label: "List Agent Tools" }
+    ]
+  },
   {
     id: "errors-rate-limits",
     label: "Errors & Rate Limits",
@@ -3306,6 +3314,68 @@ function verifyWebhook(payload, signature, secret) {
         ] })
       ] }) }),
       /* @__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." }),
+      /* @__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(
+        EndpointBlock,
+        {
+          method: "GET",
+          path: "/v1/agent/context",
+          summary: "Returns a comprehensive workspace overview including document stats, schemas, active runs, field registry summary, and recent activity.",
+          description: "Requires read scope. Use this endpoint to build dashboards or provide context to external AI integrations.",
+          children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
+  "organizationName": "Phoenix",
+  "documents": {
+    "total": 810,
+    "completedThisWeek": 155,
+    "completedLast24h": 42,
+    "processing": 3
+  },
+  "documentTypes": [
+    { "id": "uuid", "name": "Invoice", "documentCount": 320 }
+  ],
+  "schemas": [
+    { "id": "uuid", "name": "Invoice Header", "fieldCount": 12, "version": 3 }
+  ],
+  "activeRuns": [
+    { "id": "uuid", "name": "Schema_V13", "status": "extraction", "documentCount": 142 }
+  ],
+  "fieldRegistry": {
+    "totalFields": 245,
+    "tier1": 80,
+    "tier2": 120,
+    "tier3": 45
+  },
+  "recentActivity": [
+    {
+      "type": "user_uploaded",
+      "message": "42 documents uploaded",
+      "timestamp": "2026-04-25T09:30:00Z",
+      "actor": "Avi"
+    }
+  ]
+}` })
+        }
+      ) }),
+      /* @__PURE__ */ jsx5("div", { id: "agent-tools", className: "scroll-mt-6", children: /* @__PURE__ */ jsx5(
+        EndpointBlock,
+        {
+          method: "GET",
+          path: "/v1/agent/tools",
+          summary: "Lists all tools available to the embedded agent, including their impact level and description.",
+          description: "Requires read scope. Each tool declares whether it performs a read or write operation.",
+          children: /* @__PURE__ */ jsx5(CodeBlock, { title: "Response", children: `{
+  "tools": [
+    {
+      "name": "list_schemas",
+      "impact": "read",
+      "description": "Lists all user-defined schemas."
+    }
+  ],
+  "totalCount": 35
+}` })
+        }
+      ) }),
       /* @__PURE__ */ jsx5(SectionHeading, { id: "errors-rate-limits", children: "Errors & Rate Limits" }),
       /* @__PURE__ */ jsx5(SubHeading, { id: "error-format", children: "Error Format" }),
       /* @__PURE__ */ jsx5("p", { className: "text-[15px] text-void-text-secondary leading-relaxed mb-4", children: "All errors return a consistent JSON structure with a machine-readable code and a human-readable message." }),
@@ -3425,6 +3495,15 @@ var NAV_SECTIONS2 = [
       { id: "getting-started", label: "Getting Started" }
     ]
   },
+  {
+    id: "agent",
+    label: "AI Agent",
+    children: [
+      { id: "agent-capabilities", label: "Capabilities" },
+      { id: "agent-impact", label: "Impact Levels" },
+      { id: "agent-dashboard", label: "Dashboard" }
+    ]
+  },
   {
     id: "sources-docs",
     label: "Inputs & Documents",
@@ -3695,6 +3774,51 @@ function PlatformGuide({ LinkComponent }) {
         /* @__PURE__ */ jsx6("strong", { children: "Structuring \u2192 Runs \u2192 New" }),
         " to create your first extraction job."
       ] }),
+      /* @__PURE__ */ jsx6(SectionHeading, { id: "agent", children: "AI Agent" }),
+      /* @__PURE__ */ jsxs6(P, { children: [
+        "Talonic includes an embedded AI agent accessible from every page via",
+        " ",
+        /* @__PURE__ */ jsx6("kbd", { className: "px-1.5 py-0.5 text-[11px] font-mono bg-void-surface-2 border border-void-border rounded", children: "\u2318I" }),
+        " ",
+        "(",
+        /* @__PURE__ */ jsx6("kbd", { className: "px-1.5 py-0.5 text-[11px] font-mono bg-void-surface-2 border border-void-border rounded", children: "Ctrl+I" }),
+        " on Windows). The agent understands your workspace context and can inspect schemas, search documents, analyze extraction quality, explore cases, and build schemas \u2014 all through natural language."
+      ] }),
+      /* @__PURE__ */ jsx6(SubHeading, { id: "agent-capabilities", children: "What the Agent Can Do" }),
+      /* @__PURE__ */ jsx6(P, { children: "The agent has deep access to your workspace and can help with:" }),
+      /* @__PURE__ */ jsx6(
+        ParamTable,
+        {
+          title: "Agent capabilities",
+          params: [
+            { name: "Workspace overview", type: "read", description: "Document stats, recent activity, and schema health at a glance." },
+            { name: "Schema management", type: "read / draft", description: "List, inspect, create drafts, add fields, and publish schemas." },
+            { name: "Document exploration", type: "read", description: "Search documents, view extracted fields, and read OCR markdown." },
+            { name: "Extraction analysis", type: "read", description: "Run status, telemetry (capture/resolve/synthesize rates), and grid stats." },
+            { name: "Field registry", type: "read", description: "Browse discovered fields, check promotion candidates, and view semantic clusters." },
+            { name: "Cases & linking", type: "read", description: "List cases, explore document connections, and view anomalies." },
+            { name: "Quality", type: "read", description: "Benchmark results and regression detection between runs." },
+            { name: "Delivery", type: "read", description: "Check delivery status and preview binding output." }
+          ]
+        }
+      ),
+      /* @__PURE__ */ jsx6(SubHeading, { id: "agent-impact", children: "Impact Levels" }),
+      /* @__PURE__ */ jsx6(P, { children: "Every agent action is classified into an impact level that determines how it executes. Higher-impact operations require progressively more explicit confirmation." }),
+      /* @__PURE__ */ jsx6(
+        ParamTable,
+        {
+          title: "Impact levels",
+          params: [
+            { name: "read", type: "impact", description: "Executed immediately with no side effects. Queries, searches, and inspections." },
+            { name: "draft_mutation", type: "impact", description: "Creates or modifies drafts. Workshop-first \u2014 nothing is published without confirmation." },
+            { name: "live_mutation", type: "impact", description: "Requires explicit user confirmation before executing. Affects live data." },
+            { name: "irreversible", type: "impact", description: 'Requires keyword confirmation (e.g., typing "DELETE"). Cannot be undone.' }
+          ]
+        }
+      ),
+      /* @__PURE__ */ jsx6(Callout, { children: "The agent always operates workshop-first: schema changes create drafts, not live versions. You review and publish when ready." }),
+      /* @__PURE__ */ jsx6(SubHeading, { id: "agent-dashboard", children: "Dashboard Integration" }),
+      /* @__PURE__ */ jsx6(P, { children: "The home page (click the Talonic logo) shows smart suggested prompts based on your workspace state. Prompts adapt to what is happening: active runs, schema creation opportunities, document types waiting for extraction. The agent input field lets you type any question directly from the dashboard." }),
       /* @__PURE__ */ jsx6(SectionHeading, { id: "sources-docs", children: "Inputs & Documents" }),
       /* @__PURE__ */ jsx6(P, { children: "Sources are the entry point for all data. Every document belongs to a source \u2014 whether uploaded manually, synced from Google Drive, or ingested via API." }),
       /* @__PURE__ */ jsx6(SubHeading, { id: "uploading", children: "Uploading Documents" }),
@@ -4796,6 +4920,10 @@ var API_NAV_SECTIONS = [
     { id: "credits-usage-daily", label: "Daily Usage" },
     { id: "credits-usage-log", label: "Usage Log" }
   ] },
+  { id: "agent", label: "Agent", children: [
+    { id: "agent-context", label: "Get Workspace Context" },
+    { id: "agent-tools", label: "List Agent Tools" }
+  ] },
   { id: "errors-rate-limits", label: "Errors & Rate Limits", children: [
     { id: "error-format", label: "Error Format" },
     { id: "error-codes", label: "Error Codes" },
@@ -4809,6 +4937,11 @@ var PLATFORM_NAV_SECTIONS = [
     { id: "platform-flow", label: "Platform Flow" },
     { id: "getting-started", label: "Getting Started" }
   ] },
+  { id: "agent", label: "AI Agent", children: [
+    { id: "agent-capabilities", label: "Capabilities" },
+    { id: "agent-impact", label: "Impact Levels" },
+    { id: "agent-dashboard", label: "Dashboard" }
+  ] },
   { id: "sources-docs", label: "Inputs & Documents", children: [
     { id: "uploading", label: "Uploading Documents" },
     { id: "supported-formats", label: "Supported Formats" },
@@ -4902,10 +5035,12 @@ var API_SECTION_META = [
   { id: "structuring", title: "Structuring API", description: "Validation checks CRUD, approval gates with configurable rules, result check outcomes, pending approvals queue, and delivery triggers." },
   { id: "validation", title: "Validation API", description: "Golden sample management and validation runs for measuring extraction accuracy against ground truth datasets." },
   { id: "credits", title: "Credits API", description: "Credit balance, transaction history, aggregate usage summaries, daily usage breakdown, and per-request usage log." },
+  { id: "agent", title: "Agent API", description: "Workspace context snapshot and agent tool discovery endpoints for programmatic access to embedded AI assistant capabilities." },
   { id: "errors-rate-limits", title: "Errors & Rate Limits", description: "Error response format, error codes, rate limit tiers by plan, and rate limit headers." }
 ];
 var PLATFORM_SECTION_META = [
   { id: "overview", title: "Platform Overview", description: "Core concepts, platform flow, and getting started guide for the Talonic document structuring platform." },
+  { 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." },
   { id: "sources-docs", title: "Inputs & Documents", description: "Upload documents via drag-and-drop, API, or connectors. 25+ formats supported with automatic OCR and classification." },
   { id: "field-intelligence", title: "Field Intelligence", description: "Unified field registry with tier system, semantic clustering, and AI-synthesized master extraction instructions." },
   { id: "schemas-templates", title: "Schemas & Templates", description: "AI-generated schemas per document type and user-defined templates with field matching, reference tables, and versioning." },
@@ -5277,6 +5412,13 @@ var OPENAPI_SPEC = {
     // Expanded: Reference Data
     "/v1/reference-data/create": {
       post: { operationId: "createReferenceDataJson", summary: "Create reference data from JSON", tags: ["Reference Data"], responses: { "201": { description: "Reference dataset created" } } }
+    },
+    // Agent
+    "/v1/agent/context": {
+      get: { operationId: "getAgentContext", summary: "Get comprehensive workspace context", tags: ["Agent"], responses: { "200": { description: "Workspace overview with documents, schemas, runs, field registry, and recent activity" } } }
+    },
+    "/v1/agent/tools": {
+      get: { operationId: "listAgentTools", summary: "List all agent tools", tags: ["Agent"], responses: { "200": { description: "List of available agent tools with impact level and description" } } }
     }
   }
 };