@arbidocs/sdk 0.3.5 → 0.3.7

package/dist/index.d.cts

@@ -226,6 +226,26 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    '/api/user/sso-send-verification-email': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Sso Send Verification Email
+         * @description Prompt Auth0 to send a verification email to the user's email address.
+         */
+        post: operations['sso_send_verification_email_api_user_sso_send_verification_email_post'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/api/user/workspaces': {
         parameters: {
             query?: never;
@@ -603,6 +623,15 @@ interface paths {
          * @description Upload multiple documents to a workspace with encryption.
          *     Documents are queued for processing, parsed, and indexed for vector search.
          *
+         *     Supports both file uploads and programmatic document creation:
+         *     - For file uploads: standard multipart form with files
+         *     - For artifacts/content: create a file from text content on the client side
+         *
+         *     Optional parameters for version tracking and document typing:
+         *     - parent_ext_id: Links new document as child of parent (version chain)
+         *     - wp_type: Document type (source, skill, memory, artifact). Defaults to 'source'.
+         *     - tag_ext_id: Links document to a tag
+         *
          *     Requires active subscription (paid/trial/dev) if Stripe is configured.
          */
         post: operations['upload_documents'];
@@ -724,29 +753,6 @@ interface paths {
         patch?: never;
         trace?: never;
     };
-    '/api/document/upload-email': {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        /**
-         * Upload Email
-         * @description Upload files via email gateway to a new timestamped workspace.
-         *
-         *     Authentication is via SUPPORT_API_KEY (X-API-Key header), not user JWT.
-         *     Creates a new workspace named with the current timestamp and uploads files to it.
-         */
-        post: operations['upload_email'];
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     '/api/conversation/message/{message_ext_id}': {
         parameters: {
             query?: never;
@@ -943,10 +949,10 @@ interface paths {
         put?: never;
         /**
          * Submit human input to an active agent workflow
-         * @description Submit the user's response to an agent's ask_user request.
+         * @description Send a user message to an active agent workflow.
          *
-         *     The agent pauses when it calls ask_user, emitting a user_input_request SSE event.
-         *     The frontend collects the user's choice and POSTs it here to resume the workflow.
+         *     Works for both ask_user responses (agent is paused) and interjections
+         *     (agent is actively working). Both use the same unified message queue.
          */
         post: operations['respond_to_agent'];
         delete?: never;
@@ -1325,6 +1331,12 @@ interface components {
          *          "detail": [
          *             {"tool": "get_document_passages", "doc_ext_id": "doc-abc12345", "from_ref": "5", "to_ref": "8"}
          *         ]}
+         *         {"type": "agent_step", "index": 3, "detail": [
+         *             {"tool": "web_search", "query": "latest arbitration developments 2026"}
+         *         ]}
+         *         {"type": "agent_step", "index": 3, "detail": [
+         *             {"tool": "delegate_to_agent", "task": "Execute Python code to compute the SHA256 hash..."}
+         *         ]}
          *         {"type": "agent_step", "index": 4, "step": "evaluation", "detail": [
          *             {"statement": "Newton prosecuted 28 coiners", "chunk_ids": ["chunk-abc"]},
          *             {"statement": "Counterfeiting was high treason", "chunk_ids": ["chunk-def"]}
@@ -1336,6 +1348,11 @@ interface components {
          *         {"type": "agent_step", "index": 7, "step": "reviewing"}
          */
         AgentStepEvent: {
+            /**
+             * T
+             * @description Seconds elapsed since stream start.
+             */
+            t?: number | null;
             /**
              * Type
              * @default agent_step
@@ -1387,12 +1404,8 @@ interface components {
              * @default true
              */
             HUMAN_IN_THE_LOOP: boolean;
-            /**
-             * Web Search
-             * @description Enable web tools: web_search (find URLs) and read_url (fetch and process webpages).
-             * @default false
-             */
-            WEB_SEARCH: boolean;
+            /** @description Web search tool configuration. */
+            WEB_SEARCH?: components['schemas']['WebSearchConfig'];
             /**
              * Mcp Tools
              * @description MCP tool names to enable from LiteLLM (e.g. ['read_wiki_contents', 'ask_question']).
@@ -1401,22 +1414,34 @@ interface components {
             MCP_TOOLS: string[];
             /**
              * Planning Enabled
-             * @description Run a planning step before the first agent decision. The agent generates a text plan that guides subsequent tool calls.
+             * @description Include the create_plan tool so the agent can generate a research plan when it deems a task complex enough. Plan approval is configured on PlanningLLM.
              * @default false
              */
             PLANNING_ENABLED: boolean;
-            /**
-             * Planning Approval
-             * @description When planning is enabled, pause after generating the plan to allow the user to approve, skip, or comment before proceeding. Requires PLANNING_ENABLED=True to have any effect.
-             * @default false
-             */
-            PLANNING_APPROVAL: boolean;
             /**
              * Suggested Queries
              * @description Generate a single suggested follow-up query after each response.
              * @default false
              */
             SUGGESTED_QUERIES: boolean;
+            /**
+             * Artifacts Enabled
+             * @description Enable the create_artifact tool for generating standalone documents (summaries, reports, drafts) displayed in a side panel.
+             * @default false
+             */
+            ARTIFACTS_ENABLED: boolean;
+            /**
+             * Vision Enabled
+             * @description Enable the view_document_pages tool for visual inspection of document pages (figures, charts, scanned pages) using a vision-capable model.
+             * @default false
+             */
+            VISION_ENABLED: boolean;
+            /**
+             * Review Enabled
+             * @description Enable ReviewLLM to review agent draft answers against source material before sending to the user. Uses the reasoning model for higher quality.
+             * @default false
+             */
+            REVIEW_ENABLED: boolean;
             /**
              * Persona
              * @description Agent persona prepended to the system prompt. Customise to change the agent's identity and tone.
@@ -1456,6 +1481,12 @@ interface components {
              * @default 10
              */
             AGENT_MAX_ITERATIONS: number;
+            /**
+             * Max Passage Pages
+             * @description Maximum number of pages allowed per get_document_passages call. Calls requesting a wider range are rejected, forcing the agent to use get_table_of_contents and target specific sections.
+             * @default 10
+             */
+            MAX_PASSAGE_PAGES: number;
             /**
              * Agent History Char Threshold
              * @description Char threshold for conversation history injected into the agent context. Below: verbatim user/assistant pairs. Above: summarized by SummariseLLM.
@@ -1465,40 +1496,37 @@ interface components {
             /**
              * Agent System Prompt
              * @description System prompt for the agent. Dynamic context is appended automatically.
-             * @default YOUR TASK:
-             *     Determine which, if any, of the available documents contain information relevant to the user's query. Use your tools to retrieve and examine document content.
+             * @default YOU ARE:
+             *     ARBI — an AI assistant made by Arbitration City Ltd (https://arbicity.com), capable of helping with a wide variety of tasks using workspace documents, web search, and general knowledge.
+             *     Always respond in first person. Be helpful and natural, not overly formal.
+             *
+             *     YOUR TASK:
+             *     Answer the user's query. Use workspace documents when relevant. If appropriate, you may use available tools to perform external research.
              *
-             *     TOOLS AVAILABLE:
-             *     - search_documents: Search for relevant passages across documents
-             *     - get_document_passages: Read specific pages from a document
-             *     - get_table_of_contents: Get headings and page references for documents
-             *     - web_search: Search the web for current/external information
-             *     - read_urls: Fetch and index webpages. Always call immediately after web_search
-             *       with the 2-3 most relevant URLs. Then use search_documents to query them.
-             *     - ask_user: Ask the user a clarifying question with structured options.
-             *       You MUST call this tool to ask the user anything — do NOT write questions
-             *       or options as plain text. Only the tool delivers the question to the user.
-             *       IMPORTANT: Once the user responds, do NOT ask the same question again.
-             *       Use their answer and proceed with research. If the user's answer is
-             *       unexpected (e.g. refers to something not in the documents), explain what
-             *       you found and answer based on available information.
+             *     ANSWERING GUIDELINES:
+             *     - If the answer comes from workspace documents, cite them normally.
+             *     - If the answer comes from external research, say so.
+             *     - If the answer is based on general knowledge (no tool results), state that
+             *       it is based on general knowledge and may not be fully accurate.
+             *     - You are allowed to answer questions that are not about the documents.
              *
              *     EFFICIENCY GUIDELINES:
-             *     1. PARALLEL CALLS: When a query has multiple aspects, call multiple tools in    parallel (e.g., search different keywords simultaneously)
-             *     2. AVOID DUPLICATION: Before searching, review learnings from previous results.    Do not repeat searches for information you already have
+             *     1. PARALLEL CALLS: When a query has multiple aspects, call multiple tools in parallel (e.g., search different keywords simultaneously)
+             *     2. AVOID DUPLICATION: Before searching, review learnings from previous results. Do not repeat searches for information you already have
              *     3. TARGETED SEARCHES: Use specific, focused queries rather than broad ones
-             *     4. BROAD PASSAGE RANGES: When using get_document_passages, request broad ranges    (5-10+ pages per call). A few large fetches are far better than many small ones
-             *     5. STOP WHEN READY: Provide your answer when you have sufficient evidence.    Signs you have enough:
+             *     4. NARROW RETRIEVALS: When retrieving document passages, use sub-page references (e.g. 5.3-8.1) where available from search results or table of contents. Request narrow ranges per call and fetch additional ranges in subsequent iterations if needed — avoid fetching entire documents at once
+             *     5. STOP WHEN READY: Provide your answer when you have sufficient evidence. Signs you have enough:
              *        - Multiple sources confirm the same facts
              *        - Key questions from the query are addressed
              *        - Additional searches return redundant information
              *
              *     WORKFLOW:
-             *     1. Analyze the query to identify distinct information needs
-             *     2. Execute parallel searches for different aspects when appropriate
-             *     3. Evaluate results - extract learnings, note gaps
-             *     4. Only search again if specific gaps remain unfilled
-             *     5. Answer when confident (no tool call) - do not over-research
+             *     1. For complex multi-document queries, consider calling create_plan first to structure your approach
+             *     2. Choose the right tool for each need — documents for uploaded content, web for external/current info
+             *     3. Execute parallel searches for different aspects when appropriate
+             *     4. Evaluate results - extract learnings, note gaps
+             *     5. Only search again if specific gaps remain unfilled
+             *     6. Answer when confident (no tool call) - do not over-research
              *
              *     IMPORTANT:
              *     - The document index contains metadata only - you must retrieve actual content
@@ -1512,19 +1540,25 @@ interface components {
              * @default {
              *       "ENABLED": true,
              *       "HUMAN_IN_THE_LOOP": true,
-             *       "WEB_SEARCH": false,
+             *       "WEB_SEARCH": {
+             *         "ENABLED": true,
+             *         "SAVE_SOURCES": true
+             *       },
              *       "MCP_TOOLS": [],
              *       "PLANNING_ENABLED": false,
-             *       "PLANNING_APPROVAL": false,
              *       "SUGGESTED_QUERIES": false,
+             *       "ARTIFACTS_ENABLED": false,
+             *       "VISION_ENABLED": false,
+             *       "REVIEW_ENABLED": false,
              *       "PERSONA": "You are ARBI, an AI assistant created by ARBI CITY.\n\nYou maintain formal, objective tone appropriate for professional/legal contexts. If any part of the answer is based on general knowledge instead of the supplied sources, you must state so clearly and recognise that it may not be accurate.",
              *       "AGENT_MODEL_NAME": "Q3VL@ARBICITY",
              *       "AGENT_API_TYPE": "remote",
              *       "LLM_AGENT_TEMPERATURE": 0.7,
              *       "AGENT_MAX_TOKENS": 20000,
              *       "AGENT_MAX_ITERATIONS": 10,
+             *       "MAX_PASSAGE_PAGES": 10,
              *       "AGENT_HISTORY_CHAR_THRESHOLD": 8000,
-             *       "AGENT_SYSTEM_PROMPT": "YOUR TASK:\nDetermine which, if any, of the available documents contain information relevant to the user's query. Use your tools to retrieve and examine document content.\n\nTOOLS AVAILABLE:\n- search_documents: Search for relevant passages across documents\n- get_document_passages: Read specific pages from a document\n- get_table_of_contents: Get headings and page references for documents\n- web_search: Search the web for current/external information\n- read_urls: Fetch and index webpages. Always call immediately after web_search\n  with the 2-3 most relevant URLs. Then use search_documents to query them.\n- ask_user: Ask the user a clarifying question with structured options.\n  You MUST call this tool to ask the user anything — do NOT write questions\n  or options as plain text. Only the tool delivers the question to the user.\n  IMPORTANT: Once the user responds, do NOT ask the same question again.\n  Use their answer and proceed with research. If the user's answer is\n  unexpected (e.g. refers to something not in the documents), explain what\n  you found and answer based on available information.\n\nEFFICIENCY GUIDELINES:\n1. PARALLEL CALLS: When a query has multiple aspects, call multiple tools in    parallel (e.g., search different keywords simultaneously)\n2. AVOID DUPLICATION: Before searching, review learnings from previous results.    Do not repeat searches for information you already have\n3. TARGETED SEARCHES: Use specific, focused queries rather than broad ones\n4. BROAD PASSAGE RANGES: When using get_document_passages, request broad ranges    (5-10+ pages per call). A few large fetches are far better than many small ones\n5. STOP WHEN READY: Provide your answer when you have sufficient evidence.    Signs you have enough:\n   - Multiple sources confirm the same facts\n   - Key questions from the query are addressed\n   - Additional searches return redundant information\n\nWORKFLOW:\n1. Analyze the query to identify distinct information needs\n2. Execute parallel searches for different aspects when appropriate\n3. Evaluate results - extract learnings, note gaps\n4. Only search again if specific gaps remain unfilled\n5. Answer when confident (no tool call) - do not over-research\n\nIMPORTANT:\n- The document index contains metadata only - you must retrieve actual content\n- Do not add inline citation markers - the system handles citations automatically"
+             *       "AGENT_SYSTEM_PROMPT": "YOU ARE:\nARBI — an AI assistant made by Arbitration City Ltd (https://arbicity.com), capable of helping with a wide variety of tasks using workspace documents, web search, and general knowledge.\nAlways respond in first person. Be helpful and natural, not overly formal.\n\nYOUR TASK:\nAnswer the user's query. Use workspace documents when relevant. If appropriate, you may use available tools to perform external research.\n\nANSWERING GUIDELINES:\n- If the answer comes from workspace documents, cite them normally.\n- If the answer comes from external research, say so.\n- If the answer is based on general knowledge (no tool results), state that\n  it is based on general knowledge and may not be fully accurate.\n- You are allowed to answer questions that are not about the documents.\n\nEFFICIENCY GUIDELINES:\n1. PARALLEL CALLS: When a query has multiple aspects, call multiple tools in parallel (e.g., search different keywords simultaneously)\n2. AVOID DUPLICATION: Before searching, review learnings from previous results. Do not repeat searches for information you already have\n3. TARGETED SEARCHES: Use specific, focused queries rather than broad ones\n4. NARROW RETRIEVALS: When retrieving document passages, use sub-page references (e.g. 5.3-8.1) where available from search results or table of contents. Request narrow ranges per call and fetch additional ranges in subsequent iterations if needed — avoid fetching entire documents at once\n5. STOP WHEN READY: Provide your answer when you have sufficient evidence. Signs you have enough:\n   - Multiple sources confirm the same facts\n   - Key questions from the query are addressed\n   - Additional searches return redundant information\n\nWORKFLOW:\n1. For complex multi-document queries, consider calling create_plan first to structure your approach\n2. Choose the right tool for each need — documents for uploaded content, web for external/current info\n3. Execute parallel searches for different aspects when appropriate\n4. Evaluate results - extract learnings, note gaps\n5. Only search again if specific gaps remain unfilled\n6. Answer when confident (no tool call) - do not over-research\n\nIMPORTANT:\n- The document index contains metadata only - you must retrieve actual content\n- Do not add inline citation markers - the system handles citations automatically"
              *     }
              */
             Agents: components['schemas']['AgentsConfig'];
@@ -1532,15 +1566,24 @@ interface components {
              * @default {
              *       "API_TYPE": "remote",
              *       "MODEL_NAME": "Q3VL@ARBICITY",
-             *       "SYSTEM_INSTRUCTION": "You are ARBI, an AI assistant created by ARBI CITY.\n\nYou maintain formal, objective tone appropriate for professional/legal contexts. If any part of the answer is based on general knowledge instead of the supplied sources, you must state so clearly and recognise that it may not be accurate.You can ask a follow-up question instead of answering immediately if you are confused by the question and unable to intuit the user's intent. \n\nStructure responses with clear headings and logical organization:\n- Use hierarchical organization: main conclusion first, followed by supporting points\n- Bullet points for lists of discrete items\n- Numbering for sequential steps or prioritized items\n- Bold text for critical conclusions or decision points\n\nYou should recognise that not all assertions in the sources are factual. Some are mere assertions/arguments by the author, particularly in a legal context where different parties may express different opinions or even contradict each other's factual narrative.  The best way to handle this is usually to attribute where the information comes from. I.e. according to xx document, or xx party.\n\nYou should avoid generalisations and provide exact quotations where possible.   Never make up citations, facts or other information.   Acknowledge uncertainty where source materials are insufficient or ambiguous.",
-             *       "AGENT_REVIEW_INSTRUCTION": "You are reviewing a draft answer prepared by a research agent. The draft was written based on summaries, but you now have access to the full source material.\n\nYour task:\n1. Review the draft answer against the source material provided\n2. Verify claims are supported by the sources\n3. Correct any inaccuracies or unsupported statements\n4. Add any important details from the sources that were missed\n5. Maintain formal, objective tone appropriate for professional contexts\n\nIf information is not found in the sources, clearly state this. Do not add inline citation markers - the system handles citations automatically.",
-             *       "DISABLED": true,
+             *       "SYSTEM_INSTRUCTION": "You are ARBI, an AI assistant created by ARBI CITY.\n\nYou maintain formal, objective tone appropriate for professional/legal contexts. If any part of the answer is based on general knowledge instead of the supplied sources, you must state so clearly and recognise that it may not be accurate.You can ask a follow-up question instead of answering immediately if you are confused by the question and unable to intuit the user's intent.\n\nStructure responses with clear headings and logical organization:\n- Use hierarchical organization: main conclusion first, followed by supporting points\n- Bullet points for lists of discrete items\n- Numbering for sequential steps or prioritized items\n- Bold text for critical conclusions or decision points\n\nYou should recognise that not all assertions in the sources are factual. Some are mere assertions/arguments by the author, particularly in a legal context where different parties may express different opinions or even contradict each other's factual narrative.  The best way to handle this is usually to attribute where the information comes from. I.e. according to xx document, or xx party.\n\nYou should avoid generalisations and provide exact quotations where possible.   Never make up citations, facts or other information.   Acknowledge uncertainty where source materials are insufficient or ambiguous.",
              *       "MAX_CHAR_SIZE_TO_ANSWER": 200000,
              *       "TEMPERATURE": 0.1,
              *       "MAX_TOKENS": 5000
              *     }
              */
             QueryLLM: components['schemas']['QueryLLMConfig'];
+            /**
+             * @default {
+             *       "API_TYPE": "remote",
+             *       "MODEL_NAME": "GPTOSS120@ARBICITY",
+             *       "SYSTEM_INSTRUCTION": "You are reviewing a draft answer prepared by a research agent. The draft was written based on summaries, but you now have access to the full source material.\n\nYour task:\n1. Review the draft answer against the source material provided\n2. Verify claims are supported by the sources\n3. Correct any inaccuracies or unsupported statements\n4. Add any important details from the sources that were missed\n5. Maintain formal, objective tone appropriate for professional contexts\n\nIf information is not found in the sources but the draft answer is based on web search results or general knowledge, preserve it and ensure it is clearly labelled as such. Only flag missing source support for claims that purport to come from the documents.\nDo not add inline citation markers - the system handles citations automatically.",
+             *       "TEMPERATURE": 0.1,
+             *       "MAX_TOKENS": 5000,
+             *       "MAX_CHAR_SIZE_TO_ANSWER": 200000
+             *     }
+             */
+            ReviewLLM: components['schemas']['ReviewLLMConfig'];
             /**
              * @default {
              *       "API_TYPE": "remote",
@@ -1566,7 +1609,7 @@ interface components {
             /**
              * @default {
              *       "API_TYPE": "remote",
-             *       "MODEL_NAME": "Q3VL@ARBICITY",
+             *       "MODEL_NAME": "GPTOSS120@ARBICITY",
              *       "SYSTEM_INSTRUCTION": "You are a conversation summariser. Condense the conversation history into a concise summary that preserves:\n- Key decisions and conclusions reached\n- Specific names, dates, numbers, and document references\n- Open questions and unresolved items\n- The user's goals and constraints\n\nWrite in past tense, third person. Be specific, not vague. Do not omit important details in favour of brevity.",
              *       "TEMPERATURE": 0.1,
              *       "MAX_TOKENS": 2000,
@@ -1637,16 +1680,39 @@ interface components {
             /**
              * @default {
              *       "API_TYPE": "remote",
-             *       "MODEL_NAME": "Q3VL@ARBICITY",
+             *       "MODEL_NAME": "GPTOSS120@ARBICITY",
              *       "ENABLED": true,
-             *       "SYSTEM_INSTRUCTION": "You are a knowledge synthesizer. You receive the full agent scratchpad from a completed conversation and decide what, if anything, is worth saving.\n\n## Artifact Types\n- **\"memory\"**: Facts, findings, reference data — for *looking up* information.\n- **\"skill\"**: Procedures, workflows, step-by-step instructions — for *doing* something.\n\nWhen ambiguous, default to memory.\n\n## Rules\n- Return an empty artifacts array if the conversation is trivial or produced nothing substantive.\n- Each artifact must cover ONE coherent topic. Never combine disparate subjects into a single artifact — create separate artifacts for each distinct topic.\n- Ground everything in the provided context. Do not invent information.\n- Be concise. These are reference documents, not essays.\n\n## Output Format\nJSON with an `artifacts` array. Each item has `wp_type`, `title`, and `content` (markdown).\n\nMemory content: `# Title`, date, source, key findings as bullets, source documents.\nSkill content: `# Title`, prerequisites, numbered steps, when to apply.",
+             *       "SYSTEM_INSTRUCTION": "You are a knowledge synthesizer. You receive the full agent scratchpad from a completed conversation and decide what, if anything, is worth saving.\n\n## Work Product Types\n- **\"memory\"**: Facts, findings, reference data — for *looking up* information.\n- **\"skill\"**: Procedures, workflows, step-by-step instructions — for *doing* something.\n\nWhen ambiguous, default to memory.\n\n## Rules\n- Return an empty work_products array if the conversation is trivial or produced nothing substantive.\n- Each work product must cover ONE coherent topic. Never combine disparate subjects into a single document — create separate documents for each distinct topic.\n- Ground everything in the provided context. Do not invent information.\n- Be concise. These are reference documents, not essays.\n\n## Output Format\nJSON with a `work_products` array. Each item has `wp_type`, `title`, and `content` (markdown).\n\nMemory content: `# Title`, date, source, key findings as bullets, source documents.\nSkill content: `# Title`, prerequisites, numbered steps, when to apply.",
              *       "TEMPERATURE": 0.3,
              *       "MAX_TOKENS": 8000,
              *       "MAX_CHAR_CONTEXT": 100000,
              *       "MAX_CONCURRENT": 5
              *     }
              */
-            ArtifactLLM: components['schemas']['ArtifactLLMConfig'];
+            MemoryLLM: components['schemas']['MemoryLLMConfig'];
+            /**
+             * @default {
+             *       "API_TYPE": "remote",
+             *       "MODEL_NAME": "GPTOSS120@ARBICITY",
+             *       "SYSTEM_INSTRUCTION": "You are a research planning assistant. Your job is to analyze a user query and produce a concise, numbered research plan.\n\nYou have access to a workspace of documents. The available tools for executing the plan are:\n- search_documents: Search workspace documents for relevant passages (semantic, keyword, or hybrid)\n- get_document_passages: Read a specific page range from a document\n- get_table_of_contents: Get document headings with page references\n\nConsider:\n- What information is needed to answer the query\n- Which documents are likely relevant based on the document index\n- What search queries and document passages to examine\n- What order of operations will be most efficient\n- Whether parallel searches can be used for different aspects\n\nRespond with ONLY the plan (numbered steps). Do not execute any steps.",
+             *       "TEMPERATURE": 0.3,
+             *       "MAX_TOKENS": 4000,
+             *       "MAX_CHAR_SIZE_TO_ANSWER": 200000,
+             *       "APPROVAL_TIMEOUT": 0
+             *     }
+             */
+            PlanningLLM: components['schemas']['PlanningLLMConfig'];
+            /**
+             * @default {
+             *       "API_TYPE": "remote",
+             *       "MODEL_NAME": "Q3VL@ARBICITY",
+             *       "TEMPERATURE": 0.1,
+             *       "MAX_TOKENS": 4000,
+             *       "MAX_PAGES_PER_CALL": 5,
+             *       "IMAGE_MAX_DIMENSION": 1280
+             *     }
+             */
+            VisionLLM: components['schemas']['VisionLLMConfig'];
             /**
              * @default {
              *       "SIM_THREASHOLD": 0.1,
@@ -1709,84 +1775,75 @@ interface components {
             KeywordEmbedder: components['schemas']['KeywordEmbedderConfig'];
         };
         /**
-         * ArtifactLLMConfig
-         * @description Configuration for ArtifactLLM - synthesizes document artifacts (skills, memories, reports).
+         * ArtifactEvent
+         * @description A generated artifact (document/draft) for the artifact panel.
          *
-         *     Produces markdown documents from gathered context (learnings, retrieval results,
-         *     conversation history). Output is saved as a .txt document through the standard
-         *     upload pipeline and linked to an assistant tag via DocTags.
+         *     Artifacts ARE documents (wp_type='artifact') - the doc_ext_id is the single
+         *     identifier used throughout. They support versioning for redline/track-changes
+         *     functionality (useful for legal document review).
          *
-         *     Note: The assistant tag relationship is stored on Configurations.tag_id (FK),
-         *     not in this config. This config just controls synthesis behavior.
+         *     The frontend should:
+         *     - Open the artifact panel when receiving an artifact event
+         *     - Stream content updates while is_complete=False
+         *     - Enable redline view when multiple versions exist
+         *
+         *     Examples:
+         *         {"type": "artifact", "doc_ext_id": "doc-abc12345", "title": "Contract Summary",
+         *          "mode": "markdown", "content": "# Summary\n...", "is_complete": false}
+         *         {"type": "artifact", "doc_ext_id": "doc-abc12345", "title": "Contract Summary",
+         *          "mode": "markdown", "content": "# Summary\n...", "is_complete": true, "version": 1}
          */
-        ArtifactLLMConfig: {
+        ArtifactEvent: {
             /**
-             * Api Type
-             * @description The inference type (local or remote).
-             * @default remote
-             * @enum {string}
+             * T
+             * @description Seconds elapsed since stream start.
              */
-            API_TYPE: 'local' | 'remote';
+            t?: number | null;
             /**
-             * Model Name
-             * @description The name of the non-reasoning model to be used.
-             * @default Q3VL@ARBICITY
+             * Type
+             * @default artifact
+             * @constant
              */
-            MODEL_NAME: string;
+            type: 'artifact';
             /**
-             * Enabled
-             * @description Whether to run artifact synthesis (skills, memories) after agent queries.
-             * @default true
+             * Doc Ext Id
+             * @description Document external ID (artifacts are documents)
              */
-            ENABLED: boolean;
+            doc_ext_id: string;
             /**
-             * System Instruction
-             * @description System instruction for artifact classification and synthesis.
-             * @default You are a knowledge synthesizer. You receive the full agent scratchpad from a completed conversation and decide what, if anything, is worth saving.
-             *
-             *     ## Artifact Types
-             *     - **"memory"**: Facts, findings, reference data — for *looking up* information.
-             *     - **"skill"**: Procedures, workflows, step-by-step instructions — for *doing* something.
-             *
-             *     When ambiguous, default to memory.
-             *
-             *     ## Rules
-             *     - Return an empty artifacts array if the conversation is trivial or produced nothing substantive.
-             *     - Each artifact must cover ONE coherent topic. Never combine disparate subjects into a single artifact — create separate artifacts for each distinct topic.
-             *     - Ground everything in the provided context. Do not invent information.
-             *     - Be concise. These are reference documents, not essays.
-             *
-             *     ## Output Format
-             *     JSON with an `artifacts` array. Each item has `wp_type`, `title`, and `content` (markdown).
-             *
-             *     Memory content: `# Title`, date, source, key findings as bullets, source documents.
-             *     Skill content: `# Title`, prerequisites, numbered steps, when to apply.
+             * Title
+             * @description Display title for the artifact
              */
-            SYSTEM_INSTRUCTION: string;
+            title: string;
             /**
-             * Temperature
-             * @description Temperature for synthesis.
-             * @default 0.3
+             * Mode
+             * @description Rendering mode: markdown (default, supports redlines), html, or plain text
+             * @default markdown
+             * @enum {string}
              */
-            TEMPERATURE: number;
+            mode: 'markdown' | 'html' | 'text';
             /**
-             * Max Tokens
-             * @description Maximum tokens for artifact content.
-             * @default 8000
+             * Content
+             * @description The artifact content (markdown, html, or plain text)
              */
-            MAX_TOKENS: number;
+            content: string;
             /**
-             * Max Char Context
-             * @description Maximum characters of input context.
-             * @default 100000
+             * Is Complete
+             * @description Whether the artifact is fully generated (False during streaming)
+             * @default false
              */
-            MAX_CHAR_CONTEXT: number;
+            is_complete: boolean;
             /**
-             * Max Concurrent
-             * @description Maximum concurrent synthesis operations.
-             * @default 5
+             * Version
+             * @description Version number for tracking changes/redlines
+             * @default 1
              */
-            MAX_CONCURRENT: number;
+            version: number;
+            /**
+             * Message Ext Id
+             * @description External ID of the assistant message that generated this artifact
+             */
+            message_ext_id?: string | null;
         };
         /**
          * AuthMessage
@@ -1900,6 +1957,12 @@ interface components {
              * @default false
              */
             heading: boolean;
+            /** Bbox */
+            bbox?: number[] | null;
+            /** Element Type */
+            element_type?: string | null;
+            /** Heading Level */
+            heading_level?: number | null;
         };
         /** ChunkerConfig */
         ChunkerConfig: {
@@ -1981,12 +2044,15 @@ interface components {
          */
         ConfigUpdateData: {
             QueryLLM?: components['schemas']['QueryLLMConfig'] | null;
+            ReviewLLM?: components['schemas']['ReviewLLMConfig'] | null;
             Agents?: components['schemas']['AgentsConfig'] | null;
             EvaluatorLLM?: components['schemas']['EvaluatorLLMConfig'] | null;
             TitleLLM?: components['schemas']['TitleLLMConfig'] | null;
             SummariseLLM?: components['schemas']['SummariseLLMConfig'] | null;
             DoctagLLM?: components['schemas']['DoctagLLMConfig'] | null;
-            ArtifactLLM?: components['schemas']['ArtifactLLMConfig'] | null;
+            MemoryLLM?: components['schemas']['MemoryLLMConfig'] | null;
+            PlanningLLM?: components['schemas']['PlanningLLMConfig'] | null;
+            VisionLLM?: components['schemas']['VisionLLMConfig'] | null;
             ModelCitation?: components['schemas']['ModelCitationConfig'] | null;
             Parser?: components['schemas']['ParserConfig'] | null;
             Chunker?: components['schemas']['ChunkerConfig'] | null;
@@ -2304,6 +2370,8 @@ interface components {
             re_ocred?: boolean | null;
             /** Config Ext Id */
             config_ext_id?: string | null;
+            /** Parent Ext Id */
+            parent_ext_id?: string | null;
             /** Created By Ext Id */
             created_by_ext_id: string;
             /** Updated By Ext Id */
@@ -2524,6 +2592,11 @@ interface components {
          * @description An error occurred during streaming. Terminal event — close EventSource.
          */
         ErrorEvent: {
+            /**
+             * T
+             * @description Seconds elapsed since stream start.
+             */
+            t?: number | null;
             /**
              * Type
              * @default error
@@ -2717,6 +2790,86 @@ interface components {
             /** Tools */
             tools: components['schemas']['McpToolInfo'][];
         };
+        /**
+         * MemoryLLMConfig
+         * @description Configuration for MemoryLLM - synthesizes memory documents (skills, memories, reports).
+         *
+         *     Produces markdown documents from gathered context (learnings, retrieval results,
+         *     conversation history). Output is saved as a .txt document through the standard
+         *     upload pipeline and linked to an assistant tag via DocTags.
+         *
+         *     Note: The assistant tag relationship is stored on Configurations.tag_id (FK),
+         *     not in this config. This config just controls synthesis behavior.
+         */
+        MemoryLLMConfig: {
+            /**
+             * Api Type
+             * @description The inference type (local or remote).
+             * @default remote
+             * @enum {string}
+             */
+            API_TYPE: 'local' | 'remote';
+            /**
+             * Model Name
+             * @description The model for memory synthesis. Defaults to reasoning model.
+             * @default GPTOSS120@ARBICITY
+             */
+            MODEL_NAME: string;
+            /**
+             * Enabled
+             * @description Whether to run memory synthesis (skills, memories) after agent queries.
+             * @default true
+             */
+            ENABLED: boolean;
+            /**
+             * System Instruction
+             * @description System instruction for memory classification and synthesis.
+             * @default You are a knowledge synthesizer. You receive the full agent scratchpad from a completed conversation and decide what, if anything, is worth saving.
+             *
+             *     ## Work Product Types
+             *     - **"memory"**: Facts, findings, reference data — for *looking up* information.
+             *     - **"skill"**: Procedures, workflows, step-by-step instructions — for *doing* something.
+             *
+             *     When ambiguous, default to memory.
+             *
+             *     ## Rules
+             *     - Return an empty work_products array if the conversation is trivial or produced nothing substantive.
+             *     - Each work product must cover ONE coherent topic. Never combine disparate subjects into a single document — create separate documents for each distinct topic.
+             *     - Ground everything in the provided context. Do not invent information.
+             *     - Be concise. These are reference documents, not essays.
+             *
+             *     ## Output Format
+             *     JSON with a `work_products` array. Each item has `wp_type`, `title`, and `content` (markdown).
+             *
+             *     Memory content: `# Title`, date, source, key findings as bullets, source documents.
+             *     Skill content: `# Title`, prerequisites, numbered steps, when to apply.
+             */
+            SYSTEM_INSTRUCTION: string;
+            /**
+             * Temperature
+             * @description Temperature for synthesis.
+             * @default 0.3
+             */
+            TEMPERATURE: number;
+            /**
+             * Max Tokens
+             * @description Maximum tokens for memory content.
+             * @default 8000
+             */
+            MAX_TOKENS: number;
+            /**
+             * Max Char Context
+             * @description Maximum characters of input context.
+             * @default 100000
+             */
+            MAX_CHAR_CONTEXT: number;
+            /**
+             * Max Concurrent
+             * @description Maximum concurrent synthesis operations.
+             * @default 5
+             */
+            MAX_CONCURRENT: number;
+        };
         /** MessageDeleteResponse */
         MessageDeleteResponse: {
             /**
@@ -2890,8 +3043,8 @@ interface components {
             Agents: {
                 [key: string]: string | boolean;
             };
-            /** Artifactllm */
-            ArtifactLLM: {
+            /** Memoryllm */
+            MemoryLLM: {
                 [key: string]: boolean;
             };
         };
@@ -2935,7 +3088,7 @@ interface components {
          *     Type is self-descriptive, no need to parse content field.
          * @enum {string}
          */
-        NotificationType: 'user_message' | 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted';
+        NotificationType: 'user_message' | 'workspaceuser_added_owner' | 'workspaceuser_added_collaborator' | 'workspaceuser_added_guest' | 'workspaceuser_removed' | 'workspaceuser_updated_owner' | 'workspaceuser_updated_collaborator' | 'workspaceuser_updated_guest' | 'contact_accepted' | 'email_reply';
         /**
          * NotificationUpdate
          * @description Single notification update for bulk PATCH.
@@ -2989,6 +3142,72 @@ interface components {
         ParsedStage: 'marker' | 'subchunk' | 'final';
         /** ParserConfig */
         ParserConfig: Record<string, never>;
+        /**
+         * PlanningLLMConfig
+         * @description Configuration for PlanningLLM — generates research plans on demand.
+         *
+         *     Backed by a reasoning model. The agent calls the create_plan tool when it
+         *     deems a task complex enough; the plan text is returned as a tool result.
+         */
+        PlanningLLMConfig: {
+            /**
+             * Api Type
+             * @description The inference type (local or remote).
+             * @default remote
+             * @enum {string}
+             */
+            API_TYPE: 'local' | 'remote';
+            /**
+             * Model Name
+             * @description The model for plan generation. Defaults to reasoning model.
+             * @default GPTOSS120@ARBICITY
+             */
+            MODEL_NAME: string;
+            /**
+             * System Instruction
+             * @description System instruction for the planning LLM.
+             * @default You are a research planning assistant. Your job is to analyze a user query and produce a concise, numbered research plan.
+             *
+             *     You have access to a workspace of documents. The available tools for executing the plan are:
+             *     - search_documents: Search workspace documents for relevant passages (semantic, keyword, or hybrid)
+             *     - get_document_passages: Read a specific page range from a document
+             *     - get_table_of_contents: Get document headings with page references
+             *
+             *     Consider:
+             *     - What information is needed to answer the query
+             *     - Which documents are likely relevant based on the document index
+             *     - What search queries and document passages to examine
+             *     - What order of operations will be most efficient
+             *     - Whether parallel searches can be used for different aspects
+             *
+             *     Respond with ONLY the plan (numbered steps). Do not execute any steps.
+             */
+            SYSTEM_INSTRUCTION: string;
+            /**
+             * Temperature
+             * @description Temperature for planning.
+             * @default 0.3
+             */
+            TEMPERATURE: number;
+            /**
+             * Max Tokens
+             * @description Maximum tokens for the plan output.
+             * @default 4000
+             */
+            MAX_TOKENS: number;
+            /**
+             * Max Char Size To Answer
+             * @description Maximum character size for planning context.
+             * @default 200000
+             */
+            MAX_CHAR_SIZE_TO_ANSWER: number;
+            /**
+             * Approval Timeout
+             * @description Seconds to wait for user approval after generating the plan. 0 = no approval (auto-proceed). Safe for non-interactive contexts.
+             * @default 0
+             */
+            APPROVAL_TIMEOUT: number;
+        };
         /**
          * PresenceUpdateMessage
          * @description Sent when a contact's online status changes or is no longer tracked.
@@ -3053,7 +3272,7 @@ interface components {
             API_TYPE: 'local' | 'remote';
             /**
              * Model Name
-             * @description The model for query answering and review.
+             * @description The model for query answering.
              * @default Q3VL@ARBICITY
              */
             MODEL_NAME: string;
@@ -3075,27 +3294,6 @@ interface components {
              *     You should avoid generalisations and provide exact quotations where possible.   Never make up citations, facts or other information.   Acknowledge uncertainty where source materials are insufficient or ambiguous.
              */
             SYSTEM_INSTRUCTION: string;
-            /**
-             * Agent Review Instruction
-             * @description System instruction for reviewing agent draft answers against source material.
-             * @default You are reviewing a draft answer prepared by a research agent. The draft was written based on summaries, but you now have access to the full source material.
-             *
-             *     Your task:
-             *     1. Review the draft answer against the source material provided
-             *     2. Verify claims are supported by the sources
-             *     3. Correct any inaccuracies or unsupported statements
-             *     4. Add any important details from the sources that were missed
-             *     5. Maintain formal, objective tone appropriate for professional contexts
-             *
-             *     If information is not found in the sources, clearly state this. Do not add inline citation markers - the system handles citations automatically.
-             */
-            AGENT_REVIEW_INSTRUCTION: string;
-            /**
-             * Disabled
-             * @description If True, skip agent draft review. The agent's answer is used directly. Does not affect direct LLM mode (non-agent) where QueryLLM is the primary answerer.
-             * @default true
-             */
-            DISABLED: boolean;
             /**
              * Max Char Size To Answer
              * @description Maximum character size to answer.
@@ -3382,6 +3580,59 @@ interface components {
              */
             HYBRID_RERANKER_WEIGHT: number;
         };
+        /**
+         * ReviewLLMConfig
+         * @description Configuration for ReviewLLM - reviews agent draft answers against source material.
+         */
+        ReviewLLMConfig: {
+            /**
+             * Api Type
+             * @description The inference type (local or remote).
+             * @default remote
+             * @enum {string}
+             */
+            API_TYPE: 'local' | 'remote';
+            /**
+             * Model Name
+             * @description The model for reviewing agent draft answers. Defaults to reasoning model.
+             * @default GPTOSS120@ARBICITY
+             */
+            MODEL_NAME: string;
+            /**
+             * System Instruction
+             * @description System instruction for reviewing agent draft answers against source material.
+             * @default You are reviewing a draft answer prepared by a research agent. The draft was written based on summaries, but you now have access to the full source material.
+             *
+             *     Your task:
+             *     1. Review the draft answer against the source material provided
+             *     2. Verify claims are supported by the sources
+             *     3. Correct any inaccuracies or unsupported statements
+             *     4. Add any important details from the sources that were missed
+             *     5. Maintain formal, objective tone appropriate for professional contexts
+             *
+             *     If information is not found in the sources but the draft answer is based on web search results or general knowledge, preserve it and ensure it is clearly labelled as such. Only flag missing source support for claims that purport to come from the documents.
+             *     Do not add inline citation markers - the system handles citations automatically.
+             */
+            SYSTEM_INSTRUCTION: string;
+            /**
+             * Temperature
+             * @description Temperature for review.
+             * @default 0.1
+             */
+            TEMPERATURE: number;
+            /**
+             * Max Tokens
+             * @description Maximum tokens for review response.
+             * @default 5000
+             */
+            MAX_TOKENS: number;
+            /**
+             * Max Char Size To Answer
+             * @description Maximum character size for review context.
+             * @default 200000
+             */
+            MAX_CHAR_SIZE_TO_ANSWER: number;
+        };
         /**
          * SSESchemas
          * @description Container for all SSE event schemas — drives OpenAPI component generation.
@@ -3395,8 +3646,19 @@ interface components {
             agent_step?: components['schemas']['AgentStepEvent'] | null;
             user_input_request?: components['schemas']['UserInputRequestEvent'] | null;
             token?: components['schemas']['TokenEvent'] | null;
+            artifact?: components['schemas']['ArtifactEvent'] | null;
             error?: components['schemas']['ErrorEvent'] | null;
         };
+        /** SSOSendVerificationEmailRequest */
+        SSOSendVerificationEmailRequest: {
+            /** Auth0 Id */
+            auth0_id: string;
+        };
+        /** SSOSendVerificationEmailResponse */
+        SSOSendVerificationEmailResponse: {
+            /** Detail */
+            detail: string;
+        };
         /**
          * SSOStatusRequest
          * @description SSO status request - checks user registration state and syncs profile.
@@ -3484,6 +3746,11 @@ interface components {
          * @description Provides the assistant message ID so frontend can set up the response container.
          */
         StreamStartEvent: {
+            /**
+             * T
+             * @description Seconds elapsed since stream start.
+             */
+            t?: number | null;
             /**
              * Type
              * @default stream_start
@@ -3566,8 +3833,8 @@ interface components {
             API_TYPE: 'local' | 'remote';
             /**
              * Model Name
-             * @description The name of the non-reasoning model to be used.
-             * @default Q3VL@ARBICITY
+             * @description The model for conversation summarisation. Defaults to reasoning model.
+             * @default GPTOSS120@ARBICITY
              */
             MODEL_NAME: string;
             /**
@@ -3777,6 +4044,11 @@ interface components {
          * @description A chunk of the assistant's answer text.
          */
         TokenEvent: {
+            /**
+             * T
+             * @description Seconds elapsed since stream start.
+             */
+            t?: number | null;
             /**
              * Type
              * @default token
@@ -3919,6 +4191,11 @@ interface components {
          *          "timeout_seconds": 300}
          */
         UserInputRequestEvent: {
+            /**
+             * T
+             * @description Seconds elapsed since stream start.
+             */
+            t?: number | null;
             /**
              * Type
              * @default user_input_request
@@ -4087,6 +4364,71 @@ interface components {
             /** Detail */
             detail: string;
         };
+        /**
+         * VisionLLMConfig
+         * @description Configuration for VisionLLM — visually inspects document pages.
+         *
+         *     Used as a targeted fallback when text extraction (get_document_passages)
+         *     is insufficient, e.g. for figures, charts, tables, scanned pages.
+         *     The prompt is constructed dynamically per call (no system instruction).
+         */
+        VisionLLMConfig: {
+            /**
+             * Api Type
+             * @description The inference type (local or remote).
+             * @default remote
+             * @enum {string}
+             */
+            API_TYPE: 'local' | 'remote';
+            /**
+             * Model Name
+             * @description The vision-capable model name (must support image inputs).
+             * @default Q3VL@ARBICITY
+             */
+            MODEL_NAME: string;
+            /**
+             * Temperature
+             * @description Temperature for vision analysis.
+             * @default 0.1
+             */
+            TEMPERATURE: number;
+            /**
+             * Max Tokens
+             * @description Maximum tokens for the vision response.
+             * @default 4000
+             */
+            MAX_TOKENS: number;
+            /**
+             * Max Pages Per Call
+             * @description Maximum number of pages that can be inspected in a single call.
+             * @default 5
+             */
+            MAX_PAGES_PER_CALL: number;
+            /**
+             * Image Max Dimension
+             * @description Resize images so the longest side does not exceed this value (pixels).
+             * @default 1280
+             */
+            IMAGE_MAX_DIMENSION: number;
+        };
+        /**
+         * WebSearchConfig
+         * @description Configuration for web search tools.
+         */
+        WebSearchConfig: {
+            /**
+             * Enabled
+             * @description Enable web_search and read_urls tools.
+             * @default true
+             */
+            ENABLED: boolean;
+            /**
+             * Save Sources
+             * @description Save fetched webpages as workspace documents for citations.
+             * @default true
+             */
+            SAVE_SOURCES: boolean;
+        };
         /**
          * WebSocketSchemas
          * @description Container for all WebSocket message schemas.
@@ -4511,6 +4853,39 @@ interface operations {
             };
         };
     };
+    sso_send_verification_email_api_user_sso_send_verification_email_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['SSOSendVerificationEmailRequest'];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['SSOSendVerificationEmailResponse'];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['HTTPValidationError'];
+                };
+            };
+        };
+    };
     get_user_workspaces: {
         parameters: {
             query?: never;
@@ -5239,6 +5614,12 @@ interface operations {
                 shared?: boolean;
                 /** @description Configuration to use for processing */
                 config_ext_id?: string | null;
+                /** @description Parent document ID for version tracking */
+                parent_ext_id?: string | null;
+                /** @description Work product type: source, skill, memory, artifact */
+                wp_type?: string | null;
+                /** @description Tag to link the document to */
+                tag_ext_id?: string | null;
             };
             header?: {
                 'workspace-key'?: string;
@@ -5452,44 +5833,6 @@ interface operations {
             };
         };
     };
-    upload_email: {
-        parameters: {
-            query: {
-                user_email: string;
-            };
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        requestBody?: {
-            content: {
-                'multipart/form-data': {
-                    /** @description Multiple files to upload */
-                    files: string[];
-                };
-            };
-        };
-        responses: {
-            /** @description Successful Response */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/json': unknown;
-                };
-            };
-            /** @description Validation Error */
-            422: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    'application/json': components['schemas']['HTTPValidationError'];
-                };
-            };
-        };
-    };
     get_message_details: {
         parameters: {
             query?: never;