@arbidocs/client 0.4.62 → 0.4.64

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.
Files changed (3) hide show
  1. package/dist/index.d.cts +868 -120
  2. package/dist/index.d.ts +868 -120
  3. package/package.json +1 -1
package/dist/index.d.cts CHANGED
@@ -919,7 +919,10 @@ interface paths {
919
919
  * along:
920
920
  *
921
921
  * - ``doc-`` document — row + MinIO files + Qdrant vectors, all re-encrypted
922
- * with the target workspace key. Chunk external IDs are preserved.
922
+ * with the target workspace key, for EVERY version of the document (any
923
+ * version's id names it; the copy of the current one is current in the
924
+ * target). Chunk external IDs are preserved; email-family and provenance
925
+ * links between copied documents are kept.
923
926
  * - ``tag-`` tag — merged into a same-named tag already in the target if there
924
927
  * is one, otherwise created. A parent tag that is not in the target flattens
925
928
  * the copy to a root tag.
@@ -929,7 +932,11 @@ interface paths {
929
932
  * - ``fct-`` fact — content, date span, timezone and citations preserved; pins
930
933
  * are not (a pin is the pinning account's own state).
931
934
  * - ``con-`` chat — conversation + every message, with the parent/child tree
932
- * and the encrypted ``tools`` blob rebuilt.
935
+ * and the encrypted ``tools`` blob rebuilt; a task keeps its definition.
936
+ * - ``wfl-`` automation — copied paused.
937
+ *
938
+ * For a scoped, resumable copy or move that brings dependencies along, use
939
+ * ``POST /v1/workspace/transfer`` instead.
933
940
  *
934
941
  * Facts and chats need no vector copy: both live in pointer-only collections
935
942
  * keyed by external ID and are indexed on write / by the lazy backfill.
@@ -976,6 +983,169 @@ interface paths {
976
983
  patch: operations['update_workspace'];
977
984
  trace?: never;
978
985
  };
986
+ '/v1/workspace/transfer/plan': {
987
+ parameters: {
988
+ query?: never;
989
+ header?: never;
990
+ path?: never;
991
+ cookie?: never;
992
+ };
993
+ get?: never;
994
+ put?: never;
995
+ /**
996
+ * Plan Workspace Transfer
997
+ * @description Preview what a download / copy / move of this scope would include.
998
+ *
999
+ * Counts per entity type, what rides along (older versions, attachments, cited
1000
+ * documents, labels in use), provenance links kept vs dropped, references left
1001
+ * dangling, and — for a move — how many items you may not delete here.
1002
+ */
1003
+ post: operations['plan_workspace_transfer'];
1004
+ delete?: never;
1005
+ options?: never;
1006
+ head?: never;
1007
+ patch?: never;
1008
+ trace?: never;
1009
+ };
1010
+ '/v1/workspace/export': {
1011
+ parameters: {
1012
+ query?: never;
1013
+ header?: never;
1014
+ path?: never;
1015
+ cookie?: never;
1016
+ };
1017
+ get?: never;
1018
+ put?: never;
1019
+ /**
1020
+ * Export Workspace Data
1021
+ * @description The decrypted structured data of a scope, plus the document files to fetch for a download.
1022
+ *
1023
+ * One JSON array per entity type, a manifest, and ``files`` — each a document
1024
+ * version to fetch through ``/v1/document/{doc_ext_id}/download?version={version}`` and store at
1025
+ * ``path`` (current versions under ``documents/``, older ones under
1026
+ * ``documents/_versions/``).
1027
+ */
1028
+ post: operations['export_workspace_data'];
1029
+ delete?: never;
1030
+ options?: never;
1031
+ head?: never;
1032
+ patch?: never;
1033
+ trace?: never;
1034
+ };
1035
+ '/v1/workspace/transfer': {
1036
+ parameters: {
1037
+ query?: never;
1038
+ header?: never;
1039
+ path?: never;
1040
+ cookie?: never;
1041
+ };
1042
+ /**
1043
+ * List Workspace Transfers
1044
+ * @description Your recent transfers out of the current workspace, newest first (to find one to resume).
1045
+ */
1046
+ get: operations['list_workspace_transfers'];
1047
+ put?: never;
1048
+ /**
1049
+ * Start Workspace Transfer
1050
+ * @description Copy or move a scope of the current workspace into another one, in the background.
1051
+ *
1052
+ * The target must be a workspace you own or collaborate on. Poll
1053
+ * ``GET /transfer/{id}`` for progress. Everything is re-encrypted under the
1054
+ * target workspace key; each item keeps its privacy (a private item is in scope
1055
+ * only if it is yours). Copied automations arrive paused. A move removes an item
1056
+ * from here only after it, and everything else, has been copied — and only if you
1057
+ * may delete it here; otherwise it is copied and kept.
1058
+ */
1059
+ post: operations['start_workspace_transfer'];
1060
+ delete?: never;
1061
+ options?: never;
1062
+ head?: never;
1063
+ patch?: never;
1064
+ trace?: never;
1065
+ };
1066
+ '/v1/workspace/transfer/{transfer_ext_id}': {
1067
+ parameters: {
1068
+ query?: never;
1069
+ header?: never;
1070
+ path?: never;
1071
+ cookie?: never;
1072
+ };
1073
+ /**
1074
+ * Get Workspace Transfer
1075
+ * @description Progress and outcome of one transfer, with the items that need attention.
1076
+ */
1077
+ get: operations['get_workspace_transfer'];
1078
+ put?: never;
1079
+ post?: never;
1080
+ delete?: never;
1081
+ options?: never;
1082
+ head?: never;
1083
+ patch?: never;
1084
+ trace?: never;
1085
+ };
1086
+ '/v1/workspace/transfer/{transfer_ext_id}/items': {
1087
+ parameters: {
1088
+ query?: never;
1089
+ header?: never;
1090
+ path?: never;
1091
+ cookie?: never;
1092
+ };
1093
+ /**
1094
+ * List Workspace Transfer Items
1095
+ * @description The full ledger of a transfer: every item, where it went and what happened to it.
1096
+ */
1097
+ get: operations['list_workspace_transfer_items'];
1098
+ put?: never;
1099
+ post?: never;
1100
+ delete?: never;
1101
+ options?: never;
1102
+ head?: never;
1103
+ patch?: never;
1104
+ trace?: never;
1105
+ };
1106
+ '/v1/workspace/transfer/{transfer_ext_id}/resume': {
1107
+ parameters: {
1108
+ query?: never;
1109
+ header?: never;
1110
+ path?: never;
1111
+ cookie?: never;
1112
+ };
1113
+ get?: never;
1114
+ put?: never;
1115
+ /**
1116
+ * Resume Workspace Transfer
1117
+ * @description Resume an interrupted, cancelled or failed transfer (also retries the items that failed).
1118
+ *
1119
+ * Items already copied are not copied again. Must be called from the source
1120
+ * workspace, with the target workspace key sealed for this session.
1121
+ */
1122
+ post: operations['resume_workspace_transfer'];
1123
+ delete?: never;
1124
+ options?: never;
1125
+ head?: never;
1126
+ patch?: never;
1127
+ trace?: never;
1128
+ };
1129
+ '/v1/workspace/transfer/{transfer_ext_id}/cancel': {
1130
+ parameters: {
1131
+ query?: never;
1132
+ header?: never;
1133
+ path?: never;
1134
+ cookie?: never;
1135
+ };
1136
+ get?: never;
1137
+ put?: never;
1138
+ /**
1139
+ * Cancel Workspace Transfer
1140
+ * @description Stop a transfer after the item in flight. What was copied stays copied; it can be resumed.
1141
+ */
1142
+ post: operations['cancel_workspace_transfer'];
1143
+ delete?: never;
1144
+ options?: never;
1145
+ head?: never;
1146
+ patch?: never;
1147
+ trace?: never;
1148
+ };
979
1149
  '/v1/editor/{document_id}/mentions': {
980
1150
  parameters: {
981
1151
  query?: never;
@@ -1128,7 +1298,10 @@ interface paths {
1128
1298
  path?: never;
1129
1299
  cookie?: never;
1130
1300
  };
1131
- /** Native Content */
1301
+ /**
1302
+ * Native Content
1303
+ * @description The document as DOCX — its current version, or ``version`` (a read-only snapshot).
1304
+ */
1132
1305
  get: operations['native_content_v1_editor__document_id__content_get'];
1133
1306
  put?: never;
1134
1307
  post?: never;
@@ -1149,10 +1322,11 @@ interface paths {
1149
1322
  put?: never;
1150
1323
  /**
1151
1324
  * Create Word Redline
1152
- * @description Compare two documents into a NEW redline document (base -> revised).
1325
+ * @description Compare two document versions into a NEW redline document (base -> revised).
1153
1326
  *
1154
- * Without ``base_ext_id`` the base is the revised document's previous version.
1155
- * The redline records both inputs as provenance and is shared only if both are.
1327
+ * Without ``base_ext_id`` the base is the revised document's version before the
1328
+ * one compared. The redline records both inputs (document and version) as
1329
+ * provenance and is shared only if both documents are.
1156
1330
  */
1157
1331
  post: operations['create_word_redline_v1_editor_redline_post'];
1158
1332
  delete?: never;
@@ -1273,10 +1447,11 @@ interface paths {
1273
1447
  };
1274
1448
  /**
1275
1449
  * List Document Versions
1276
- * @description Every version of the document ``document_ext_id`` belongs to (any version's id), oldest first.
1450
+ * @description Every version of the document, oldest first; ``is_current`` marks the current one.
1277
1451
  *
1278
- * ``is_current`` marks the current one. Lists and search show only current
1279
- * versions; this is how older ones are reached.
1452
+ * A document keeps one id for its whole life: an older version is opened with
1453
+ * ``?version=n`` on the view / download / parsed / signature endpoints, and
1454
+ * retrieval asks about it as ``doc-…@v{n}``.
1280
1455
  */
1281
1456
  get: operations['list_document_versions'];
1282
1457
  put?: never;
@@ -1337,7 +1512,7 @@ interface paths {
1337
1512
  * - version_of: Saves the file as the next version of that document
1338
1513
  * - derived_from + derived_role: Records that the new document was made from another (a crop, a
1339
1514
  * redacted or annotated copy) or, with derived_from repeated, from several (a production set)
1340
- * - wp_type: Document type (source, skill, memory, artifact). Defaults to 'source'.
1515
+ * - wp_type: Document type (source, skill, artifact). Defaults to 'source'.
1341
1516
  * - tag_ext_id: Links document to a tag
1342
1517
  * - folder: Logical folder path for grouping (URL safe, e.g., 'skills/weather')
1343
1518
  *
@@ -1449,7 +1624,7 @@ interface paths {
1449
1624
  };
1450
1625
  /**
1451
1626
  * Download Document
1452
- * @description Download a document by its external ID.
1627
+ * @description Download a document (its original file) by its external ID — ``version`` for an older version.
1453
1628
  * Retrieves and decrypts the document for downloading as an attachment.
1454
1629
  */
1455
1630
  get: operations['download_document'];
@@ -1614,7 +1789,8 @@ interface paths {
1614
1789
  put?: never;
1615
1790
  /**
1616
1791
  * Sign Document
1617
- * @description Sign a document: verify the signer's statement, seal a signed copy, save it as a new child document.
1792
+ * @description Sign a document: verify the signer's statement, seal a signed copy, save it as the document's next
1793
+ * version (reason ``signed``; the document keeps its id).
1618
1794
  */
1619
1795
  post: operations['sign_document'];
1620
1796
  delete?: never;
@@ -1632,7 +1808,7 @@ interface paths {
1632
1808
  };
1633
1809
  /**
1634
1810
  * Get Document Signature Status
1635
- * @description Is this document a signed copy, and is it unchanged since signing? Read from the PDF itself.
1811
+ * @description Is this document version a signed copy, and is it unchanged since signing? Read from the PDF itself.
1636
1812
  */
1637
1813
  get: operations['get_document_signature_status'];
1638
1814
  put?: never;
@@ -4882,12 +5058,6 @@ interface components {
4882
5058
  * @description Allowlist of skill slugs this config may invoke via run_skill/list_skills. None = no restriction (every skill the caller can see — back-compat default). A list (including []) restricts to exactly those slugs. Set a list on an agent's config to scope which skills that agent can use.
4883
5059
  */
4884
5060
  ENABLED_SKILLS?: string[] | null;
4885
- /**
4886
- * Memory Creation
4887
- * @description Transient flag set by /setup command to enable the save_profile agent tool (authors the per-workspace practice-profile memory document).
4888
- * @default false
4889
- */
4890
- MEMORY_CREATION: boolean;
4891
5061
  /**
4892
5062
  * Goals Enabled
4893
5063
  * @description Feature gate for the goal/Ralph-loop system. When False, the /goal command is unavailable (falls through to a normal query) and the router may not auto-escalate to goal mode. Mirrors SKILLS_ENABLED; set per workspace/config to expose the feature.
@@ -5210,7 +5380,6 @@ interface components {
5210
5380
  * "SKILL_CREATION": false,
5211
5381
  * "WORKSPACE_TOOLS_ENABLED": false,
5212
5382
  * "REMOTE_CONTROL_ENABLED": false,
5213
- * "MEMORY_CREATION": false,
5214
5383
  * "GOALS_ENABLED": false,
5215
5384
  * "GOAL_MAX_OUTER_LOOPS": 6,
5216
5385
  * "PERSONA": "You are ARBI, an AI assistant created by ARBI CITY. Be proactive, helpful and professional.",
@@ -5235,7 +5404,7 @@ interface components {
5235
5404
  * @default {
5236
5405
  * "API_TYPE": "remote",
5237
5406
  * "ENABLE_THINKING": false,
5238
- * "MODEL_NAME": "dummy",
5407
+ * "MODEL_NAME": "Fast",
5239
5408
  * "SYSTEM_INSTRUCTION": "You are ARBI, an AI assistant created by ARBI CITY. Be proactive, helpful and professional.Be concise. Use markdown where it helps readability. Cross-check information across sources before answering. Never fabricate facts. Not all assertions in the sources are factual — some are arguments by a party. Attribute claims to their source, especially where parties disagree.",
5240
5409
  * "MAX_TOKEN_SIZE_TO_ANSWER": 200000,
5241
5410
  * "TEMPERATURE": 0.1,
@@ -5247,7 +5416,7 @@ interface components {
5247
5416
  * @default {
5248
5417
  * "API_TYPE": "remote",
5249
5418
  * "ENABLE_THINKING": false,
5250
- * "MODEL_NAME": "dummy",
5419
+ * "MODEL_NAME": "Wise",
5251
5420
  * "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.",
5252
5421
  * "TEMPERATURE": 0.1,
5253
5422
  * "MAX_TOKENS": 0,
@@ -5259,7 +5428,7 @@ interface components {
5259
5428
  * @default {
5260
5429
  * "API_TYPE": "remote",
5261
5430
  * "ENABLE_THINKING": false,
5262
- * "MODEL_NAME": "dummy",
5431
+ * "MODEL_NAME": "Fast",
5263
5432
  * "SYSTEM_INSTRUCTION": "You are a chunk evaluator. Analyze retrieved chunks to determine which are relevant to the user's query and extract key learnings from the RELEVANT chunks only. You must return your response as valid JSON matching the provided schema.",
5264
5433
  * "TEMPERATURE": 0.1,
5265
5434
  * "MAX_TOKENS": 0,
@@ -5274,7 +5443,7 @@ interface components {
5274
5443
  * @default {
5275
5444
  * "API_TYPE": "remote",
5276
5445
  * "ENABLE_THINKING": false,
5277
- * "MODEL_NAME": "dummy",
5446
+ * "MODEL_NAME": "Fast",
5278
5447
  * "SYSTEM_INSTRUCTION": "You are a title generator that creates concise, descriptive titles.\n\nOutput the title as plain text only. Do not use Markdown or any other formatting. Specifically:\n- Do not bold, italicize, or otherwise emphasize any part of the title.\n- Do not include asterisks (*), underscores (_), backticks (`), or other Markdown markers.\n- Do not prefix the title with bullets, dashes (-), or numbered/lettered enumeration (e.g. \"1.\", \"a)\").\n- Do not wrap the title in quotes or brackets.",
5279
5448
  * "MAX_TOKEN_SIZE_TO_ANSWER": 20,
5280
5449
  * "TEMPERATURE": 0.3,
@@ -5286,7 +5455,7 @@ interface components {
5286
5455
  * @default {
5287
5456
  * "API_TYPE": "remote",
5288
5457
  * "ENABLE_THINKING": false,
5289
- * "MODEL_NAME": "dummy",
5458
+ * "MODEL_NAME": "Wise",
5290
5459
  * "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.",
5291
5460
  * "TEMPERATURE": 0.1,
5292
5461
  * "MAX_TOKENS": 0,
@@ -5300,7 +5469,7 @@ interface components {
5300
5469
  * @default {
5301
5470
  * "API_TYPE": "remote",
5302
5471
  * "ENABLE_THINKING": false,
5303
- * "MODEL_NAME": "dummy",
5472
+ * "MODEL_NAME": "Fast",
5304
5473
  * "SYSTEM_INSTRUCTION": "You are a document analysis assistant. Answer questions based on the document content.\n\nYour answers are displayed directly as cell values in a table, so keep every answer as short as possible.\n\nGuidelines:\n- Answer with the value only — never a full sentence. Do not restate the question or add lead-ins such as \"This document is...\" or \"The document describes...\". Good: \"German\". Bad: \"This document is written in German.\"\n- When an answer has multiple values, put each value on its own line: separate values with a newline character. Do not separate them with commas, bullets, dashes, numbering, or by writing them as a sentence.\n- Answer from the document. Reasonable inferences are fine; if the document gives no basis for an answer, the value is null and sources is empty.\n- Follow the format instructions exactly for each answer.\n- Output answers as plain text only. Do not use Markdown or any other formatting: no bold, italics, asterisks (*), underscores (_), backticks (`), bullets, or numbered/lettered enumeration.\n- Passages may be preceded by markers like [p3.2]: not document content. Cite them in \"sources\", never in a value.",
5305
5474
  * "MAX_TOKEN_CONTEXT_TO_ANSWER": 200000,
5306
5475
  * "TEMPERATURE": 0.1,
@@ -5361,7 +5530,7 @@ interface components {
5361
5530
  * @default {
5362
5531
  * "API_TYPE": "remote",
5363
5532
  * "ENABLE_THINKING": false,
5364
- * "MODEL_NAME": "dummy",
5533
+ * "MODEL_NAME": "Wise",
5365
5534
  * "TEMPERATURE": 0.3,
5366
5535
  * "MAX_TOKENS": 0,
5367
5536
  * "MAX_TOKEN_CONTEXT": 200000,
@@ -5373,7 +5542,7 @@ interface components {
5373
5542
  * @default {
5374
5543
  * "API_TYPE": "remote",
5375
5544
  * "ENABLE_THINKING": true,
5376
- * "MODEL_NAME": "dummy",
5545
+ * "MODEL_NAME": "Wise",
5377
5546
  * "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_inside_documents: Search workspace documents for relevant passages (semantic, keyword, or hybrid). Use digest=true to extract learnings.\n- read_document: Read page ranges or entire documents. Use digest=true to extract learnings with citations.\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.",
5378
5547
  * "TEMPERATURE": 0.3,
5379
5548
  * "MAX_TOKENS": 0,
@@ -5386,7 +5555,7 @@ interface components {
5386
5555
  * @default {
5387
5556
  * "API_TYPE": "remote",
5388
5557
  * "ENABLE_THINKING": false,
5389
- * "MODEL_NAME": "dummy",
5558
+ * "MODEL_NAME": "Fast",
5390
5559
  * "SYSTEM_INSTRUCTION": "You are a context selector. Given a user's query, conversation history, and a table of available documents, determine the user's goal and select relevant context.\n\n## Instructions\n\n1. **goal**: 1-2 concise sentences describing the user's intent AND your filtering rationale. Explain what documents are needed and why. Examples:\n - \"The user is greeting the assistant. No documents are needed.\"\n - \"The user wants to find force majeure clauses. Only the three contracts are relevant, so I will keep only those.\"\n - \"The user wants a full timeline of the case. Most documents are relevant, so I will drop only the unrelated procedural orders.\"\n\n2. **doc_filter_mode** and **doc_ids**: Select which documents the agent needs.\n - `\"keep\"` mode: `doc_ids` lists the ONLY docs to keep. Everything else is dropped.\n - `\"drop\"` mode: `doc_ids` lists the ONLY docs to drop. Everything else is kept.\n - Pick whichever mode produces the **shorter `doc_ids` list**.\n - Doc IDs are in the **Id** column of the Available Documents table (e.g. `\"doc-abc12345\"`). Copy them **exactly** from the table — do not invent, guess, or modify IDs.\n\n | Scenario | doc_filter_mode | doc_ids |\n |----------|----------------|---------|\n | Need ALL docs | `\"drop\"` | `[]` |\n | Need NO docs | `\"keep\"` | `[]` |\n | Need 3 of 100 docs | `\"keep\"` | `[\"id1\",\"id2\",\"id3\"]` |\n | Drop 3 of 100 docs | `\"drop\"` | `[\"id1\",\"id2\",\"id3\"]` |\n\n3. **chat_range_start** and **chat_range_end**: 0-based inclusive range of earlier history messages that provide relevant context. The last 3 messages are always included automatically. Set both to -1 if no earlier history is needed.\n\n## Rules\n\n- **Never repeat a doc ID.** Each ID must appear at most once.\n- Before writing `doc_ids`, count how many you would keep vs drop, then pick the shorter list.\n- Greetings or meta-questions about the assistant (e.g. \"hello\", \"who are you?\", \"what can you do?\"): the agent does NOT need any documents → `\"keep\"` with `[]`.\n- Ambiguous references like \"the document\" or \"this contract\" without specifying which: keep all → `\"drop\"` with `[]`.\n- For follow-up questions, include history messages that establish the topic.\n- Always return valid JSON matching the schema.",
5391
5560
  * "TEMPERATURE": 0,
5392
5561
  * "MAX_TOKENS": 0
@@ -5397,7 +5566,7 @@ interface components {
5397
5566
  * @default {
5398
5567
  * "API_TYPE": "remote",
5399
5568
  * "ENABLE_THINKING": false,
5400
- * "MODEL_NAME": "dummy",
5569
+ * "MODEL_NAME": "Fast",
5401
5570
  * "TEMPERATURE": 0.1,
5402
5571
  * "MAX_TOKENS": 0,
5403
5572
  * "MAX_PAGES_PER_CALL": 5,
@@ -5418,7 +5587,7 @@ interface components {
5418
5587
  * @default {
5419
5588
  * "API_TYPE": "remote",
5420
5589
  * "ENABLE_THINKING": true,
5421
- * "MODEL_NAME": "",
5590
+ * "MODEL_NAME": "Premium",
5422
5591
  * "SYSTEM_INSTRUCTION": "You are a code execution agent. You write and run code to accomplish tasks.\n\nYou have access to an execute_code tool that runs code in a sandboxed Docker container.\n\nThe sandbox has:\n- Python 3.12 with numpy, pandas, matplotlib, requests, beautifulsoup4,\n httpx, pillow, sympy, pyyaml (plus uv for installing more)\n- Node.js 22 with TypeScript (ts-node) and npm\n- Bash with git, curl, wget, jq, sqlite3, build-essential\n- Network access (can pip/npm install additional packages)\n\nInstructions:\n1. Write clean, correct code to accomplish the user's task\n2. Always call execute_code to run your code — never guess the output\n3. If execution errors, analyze the traceback, fix the code, and retry\n4. Once you have the correct output, respond with ONLY the final result\n\nKeep code simple and direct. Prefer Python unless the task specifically requires another language.",
5423
5592
  * "TEMPERATURE": 0.2,
5424
5593
  * "MAX_TOKENS": 0
@@ -5488,7 +5657,7 @@ interface components {
5488
5657
  * },
5489
5658
  * "MAX_CONCURRENT_REQUESTS": 256,
5490
5659
  * "MODEL_NAME": "Qwen/Qwen3-Reranker-0.6B",
5491
- * "API_TYPE": "local",
5660
+ * "API_TYPE": "remote",
5492
5661
  * "RETRIEVAL_INSTRUCTION": "Judge whether the passage contains the specific facts, figures, names, or references mentioned in the query. Only answer yes if the passage directly contains these details"
5493
5662
  * }
5494
5663
  */
@@ -5509,7 +5678,7 @@ interface components {
5509
5678
  /**
5510
5679
  * @default {
5511
5680
  * "MODEL_NAME": "Qwen/Qwen3-Embedding-0.6B",
5512
- * "API_TYPE": "local",
5681
+ * "API_TYPE": "remote",
5513
5682
  * "BATCH_SIZE": 128,
5514
5683
  * "MAX_CONCURRENT_REQUESTS": 256,
5515
5684
  * "DOCUMENT_PREFIX": "",
@@ -5778,13 +5947,13 @@ interface components {
5778
5947
  is_complete: boolean;
5779
5948
  /**
5780
5949
  * Version
5781
- * @description Version number for tracking changes/redlines
5950
+ * @description The document version this artifact was saved as (1 for a new artifact)
5782
5951
  * @default 1
5783
5952
  */
5784
5953
  version: number;
5785
5954
  /**
5786
5955
  * Version Of
5787
- * @description Document this artifact updates; it is saved as the next version in that document's chain
5956
+ * @description Set when this artifact updates an existing document: that document (equal to doc_ext_id — the update is saved as its next version, same id)
5788
5957
  */
5789
5958
  version_of?: string | null;
5790
5959
  /**
@@ -6120,6 +6289,8 @@ interface components {
6120
6289
  workspace_ext_id?: string | null;
6121
6290
  /** Doc Ext Id */
6122
6291
  doc_ext_id?: string | null;
6292
+ /** Doc Version */
6293
+ doc_version?: number | null;
6123
6294
  /** Doc Title */
6124
6295
  doc_title?: string | null;
6125
6296
  /** Chunk Id */
@@ -6235,6 +6406,8 @@ interface components {
6235
6406
  CitedDocument: {
6236
6407
  /** Doc Ext Id */
6237
6408
  doc_ext_id: string;
6409
+ /** Version */
6410
+ version?: number | null;
6238
6411
  /** Chunks */
6239
6412
  chunks?: components['schemas']['CitedChunk'][];
6240
6413
  };
@@ -6259,7 +6432,7 @@ interface components {
6259
6432
  /**
6260
6433
  * Model Name
6261
6434
  * @description Model for code generation. Should be a strong coding model.
6262
- * @default
6435
+ * @default Premium
6263
6436
  */
6264
6437
  MODEL_NAME: string;
6265
6438
  /**
@@ -6532,6 +6705,12 @@ interface components {
6532
6705
  /** Email */
6533
6706
  email: string;
6534
6707
  };
6708
+ /**
6709
+ * ConflictPolicy
6710
+ * @description When the target already has a same-named document / automation, or an identical note.
6711
+ * @enum {string}
6712
+ */
6713
+ ConflictPolicy: 'skip' | 'keep_both';
6535
6714
  /** ConnectMailAccount */
6536
6715
  ConnectMailAccount: {
6537
6716
  /** Profile Id */
@@ -6936,13 +7115,18 @@ interface components {
6936
7115
  kind: components['schemas']['CopyItemKind'];
6937
7116
  /** Warning */
6938
7117
  warning?: string | null;
7118
+ /**
7119
+ * Skipped
7120
+ * @default false
7121
+ */
7122
+ skipped: boolean;
6939
7123
  };
6940
7124
  /**
6941
7125
  * CopyItemKind
6942
7126
  * @description Which entity a copy result refers to — derived from the ext-id prefix.
6943
7127
  * @enum {string}
6944
7128
  */
6945
- CopyItemKind: 'document' | 'tag' | 'doctag' | 'fact' | 'chat' | 'unknown';
7129
+ CopyItemKind: 'document' | 'tag' | 'doctag' | 'fact' | 'chat' | 'workflow' | 'unknown';
6946
7130
  /** CopyRequest */
6947
7131
  CopyRequest: {
6948
7132
  /** Target Workspace Ext Id */
@@ -6954,7 +7138,7 @@ interface components {
6954
7138
  target_workspace_key: string;
6955
7139
  /**
6956
7140
  * Items
6957
- * @description External IDs to copy. Heterogeneous: documents (doc-), tags (tag-), doctags (dtj-), facts (fct-) and chats (con-) may be mixed in one call — the server dispatches on the prefix and copies them in dependency order (tags → documents → doctags/facts → chats). Selection is exact: nothing is copied that was not listed.
7141
+ * @description External IDs to copy. Heterogeneous: documents (doc-), tags (tag-), doctags (dtj-), facts (fct-), chats (con-) and automations (wfl-) may be mixed in one call — the server dispatches on the prefix and copies them in dependency order (tags → documents → doctags/facts → chats → automations). Selection is exact: nothing is copied that was not listed, except that a document always brings all of its versions. For a scoped, resumable copy or move with dependencies, use POST /v1/workspace/transfer.
6958
7142
  */
6959
7143
  items: string[];
6960
7144
  };
@@ -7421,12 +7605,16 @@ interface components {
7421
7605
  };
7422
7606
  /**
7423
7607
  * DerivedFrom
7424
- * @description One provenance link of a document: it was made from ``doc_ext_id`` as ``role``.
7608
+ * @description One provenance link of a document: it was made from version ``version`` of
7609
+ * ``doc_ext_id`` as ``role``. ``version`` is None only for links whose version was
7610
+ * never recorded.
7425
7611
  */
7426
7612
  DerivedFrom: {
7427
7613
  /** Doc Ext Id */
7428
7614
  doc_ext_id: string;
7429
7615
  role: components['schemas']['DocRelationRole'];
7616
+ /** Version */
7617
+ version?: number | null;
7430
7618
  };
7431
7619
  /**
7432
7620
  * DmAttachmentUploadResponse
@@ -7457,9 +7645,11 @@ interface components {
7457
7645
  /**
7458
7646
  * DocRelationRole
7459
7647
  * @description How ``from_doc`` was derived from ``to_doc`` (provenance only, no behaviour).
7648
+ *
7649
+ * Versions are not relations: they live inside their document (``docs.versions``).
7460
7650
  * @enum {string}
7461
7651
  */
7462
- DocRelationRole: 'edit' | 'sync' | 'crop' | 'redline_base' | 'redline_revised' | 'redaction' | 'annotated' | 'production';
7652
+ DocRelationRole: 'crop' | 'redline_base' | 'redline_revised' | 'redaction' | 'annotated' | 'production';
7463
7653
  /** DocResponse */
7464
7654
  DocResponse: {
7465
7655
  /** External Id */
@@ -7498,18 +7688,16 @@ interface components {
7498
7688
  config_ext_id?: string | null;
7499
7689
  /** Parent Ext Id */
7500
7690
  parent_ext_id?: string | null;
7501
- /** Lineage Id */
7502
- lineage_id?: string | null;
7503
7691
  /**
7504
- * Version Number
7692
+ * Current Version
7505
7693
  * @default 1
7506
7694
  */
7507
- version_number: number;
7695
+ current_version: number;
7508
7696
  /**
7509
- * Is Current
7510
- * @default true
7697
+ * Versions
7698
+ * @default []
7511
7699
  */
7512
- is_current: boolean;
7700
+ versions: components['schemas']['DocVersion'][];
7513
7701
  /** Thread Id */
7514
7702
  thread_id?: string | null;
7515
7703
  /**
@@ -7636,6 +7824,45 @@ interface components {
7636
7824
  */
7637
7825
  config_ext_id?: string | null;
7638
7826
  };
7827
+ /**
7828
+ * DocVersion
7829
+ * @description One version of a document (``GET /v1/document/{id}/versions`` and ``DocResponse.versions``).
7830
+ */
7831
+ DocVersion: {
7832
+ /** N */
7833
+ n: number;
7834
+ /** Created At */
7835
+ created_at?: string | null;
7836
+ /** Created By Ext Id */
7837
+ created_by_ext_id?: string | null;
7838
+ /**
7839
+ * Reason
7840
+ * @default upload
7841
+ * @enum {string}
7842
+ */
7843
+ reason: 'upload' | 'edit' | 'signed' | 'sync';
7844
+ /** File Name */
7845
+ file_name?: string | null;
7846
+ /** File Type */
7847
+ file_type?: string | null;
7848
+ /** File Size */
7849
+ file_size?: number | null;
7850
+ /** Content Hash */
7851
+ content_hash?: string | null;
7852
+ /** Status */
7853
+ status?: string | null;
7854
+ /** N Pages */
7855
+ n_pages?: number | null;
7856
+ /** N Chunks */
7857
+ n_chunks?: number | null;
7858
+ /** Made From */
7859
+ made_from?: number | null;
7860
+ /**
7861
+ * Is Current
7862
+ * @default false
7863
+ */
7864
+ is_current: boolean;
7865
+ };
7639
7866
  /**
7640
7867
  * DoctagLLMConfig
7641
7868
  * @description Configuration for DoctagLLM - extracts information from documents based on tag instructions.
@@ -7657,7 +7884,7 @@ interface components {
7657
7884
  /**
7658
7885
  * Model Name
7659
7886
  * @description The name of the non-reasoning model to be used.
7660
- * @default dummy
7887
+ * @default Fast
7661
7888
  */
7662
7889
  MODEL_NAME: string;
7663
7890
  /**
@@ -7955,7 +8182,7 @@ interface components {
7955
8182
  /**
7956
8183
  * Api Type
7957
8184
  * @description The inference type (local or remote).
7958
- * @default local
8185
+ * @default remote
7959
8186
  * @enum {string}
7960
8187
  */
7961
8188
  API_TYPE: 'local' | 'remote';
@@ -8100,7 +8327,7 @@ interface components {
8100
8327
  /**
8101
8328
  * Model Name
8102
8329
  * @description The name of the non-reasoning model to be used.
8103
- * @default dummy
8330
+ * @default Fast
8104
8331
  */
8105
8332
  MODEL_NAME: string;
8106
8333
  /**
@@ -8146,6 +8373,27 @@ interface components {
8146
8373
  */
8147
8374
  EVAL_BATCH_TIMEOUT_S: number;
8148
8375
  };
8376
+ /**
8377
+ * ExportFile
8378
+ * @description One file of a download: fetch ``/v1/document/{doc_ext_id}/download?version={version}`` and store
8379
+ * it at ``path``.
8380
+ */
8381
+ ExportFile: {
8382
+ /** Doc Ext Id */
8383
+ doc_ext_id: string;
8384
+ /**
8385
+ * Version
8386
+ * @default 1
8387
+ */
8388
+ version: number;
8389
+ /** Path */
8390
+ path: string;
8391
+ /**
8392
+ * Is Current
8393
+ * @default true
8394
+ */
8395
+ is_current: boolean;
8396
+ };
8149
8397
  /** FactDeleteResponse */
8150
8398
  FactDeleteResponse: {
8151
8399
  /**
@@ -8361,7 +8609,7 @@ interface components {
8361
8609
  /**
8362
8610
  * Model Name
8363
8611
  * @description The name of the non-reasoning model to be used.
8364
- * @default dummy
8612
+ * @default Fast
8365
8613
  */
8366
8614
  MODEL_NAME: string;
8367
8615
  /**
@@ -9251,7 +9499,7 @@ interface components {
9251
9499
  /**
9252
9500
  * Model Name
9253
9501
  * @description The model for note consolidation. Defaults to reasoning model.
9254
- * @default dummy
9502
+ * @default Wise
9255
9503
  */
9256
9504
  MODEL_NAME: string;
9257
9505
  /**
@@ -9984,6 +10232,8 @@ interface components {
9984
10232
  ParsedDocMetadata: {
9985
10233
  /** Doc Ext Id */
9986
10234
  doc_ext_id?: string | null;
10235
+ /** Doc Version */
10236
+ doc_version?: number | null;
9987
10237
  /** File Name */
9988
10238
  file_name?: string | null;
9989
10239
  /**
@@ -10143,7 +10393,7 @@ interface components {
10143
10393
  /**
10144
10394
  * Model Name
10145
10395
  * @description The model for plan generation. Defaults to reasoning model.
10146
- * @default dummy
10396
+ * @default Wise
10147
10397
  */
10148
10398
  MODEL_NAME: string;
10149
10399
  /**
@@ -10604,7 +10854,7 @@ interface components {
10604
10854
  /**
10605
10855
  * Model Name
10606
10856
  * @description The model for query answering.
10607
- * @default dummy
10857
+ * @default Fast
10608
10858
  */
10609
10859
  MODEL_NAME: string;
10610
10860
  /**
@@ -10737,6 +10987,12 @@ interface components {
10737
10987
  /** @description ARBI agent-trace extension (non-standard). */
10738
10988
  arbi?: components['schemas']['ArbiItemMeta'] | null;
10739
10989
  };
10990
+ /**
10991
+ * ReferencedDocuments
10992
+ * @description What to do with a document a note / conversation / automation cites but the scope does not include.
10993
+ * @enum {string}
10994
+ */
10995
+ ReferencedDocuments: 'include' | 'link';
10740
10996
  /**
10741
10997
  * RegisterRequest
10742
10998
  * @description Unified user registration request (local and SSO).
@@ -10929,7 +11185,7 @@ interface components {
10929
11185
  /**
10930
11186
  * Api Type
10931
11187
  * @description The inference type (local or remote).
10932
- * @default local
11188
+ * @default remote
10933
11189
  * @enum {string}
10934
11190
  */
10935
11191
  API_TYPE: 'local' | 'remote';
@@ -11714,7 +11970,7 @@ interface components {
11714
11970
  /**
11715
11971
  * Model Name
11716
11972
  * @description The model for reviewing agent draft answers. Defaults to reasoning model.
11717
- * @default dummy
11973
+ * @default Wise
11718
11974
  */
11719
11975
  MODEL_NAME: string;
11720
11976
  /**
@@ -12172,8 +12428,16 @@ interface components {
12172
12428
  };
12173
12429
  /** SignDocumentResponse */
12174
12430
  SignDocumentResponse: {
12175
- /** Signed Doc Ext Id */
12176
- signed_doc_ext_id: string;
12431
+ /**
12432
+ * Doc Ext Id
12433
+ * @description The signed document (it keeps its id)
12434
+ */
12435
+ doc_ext_id: string;
12436
+ /**
12437
+ * Version
12438
+ * @description The new version holding the signed, sealed PDF
12439
+ */
12440
+ version: number;
12177
12441
  signature: components['schemas']['SignatureRecord'];
12178
12442
  };
12179
12443
  /**
@@ -12529,7 +12793,7 @@ interface components {
12529
12793
  /**
12530
12794
  * Model Name
12531
12795
  * @description The model for conversation summarisation. Defaults to reasoning model.
12532
- * @default dummy
12796
+ * @default Wise
12533
12797
  */
12534
12798
  MODEL_NAME: string;
12535
12799
  /**
@@ -12804,6 +13068,11 @@ interface components {
12804
13068
  type: 'task_update';
12805
13069
  /** Doc Ext Id */
12806
13070
  doc_ext_id: string;
13071
+ /**
13072
+ * Version
13073
+ * @default 1
13074
+ */
13075
+ version: number;
12807
13076
  /** Workspace Ext Id */
12808
13077
  workspace_ext_id: string;
12809
13078
  /** File Name */
@@ -12873,7 +13142,7 @@ interface components {
12873
13142
  /**
12874
13143
  * Model Name
12875
13144
  * @description The name of the non-reasoning model to be used.
12876
- * @default dummy
13145
+ * @default Fast
12877
13146
  */
12878
13147
  MODEL_NAME: string;
12879
13148
  /**
@@ -13063,64 +13332,247 @@ interface components {
13063
13332
  /** Text */
13064
13333
  text: string;
13065
13334
  };
13335
+ /** TransferItemResult */
13336
+ TransferItemResult: {
13337
+ /** Kind */
13338
+ kind: string;
13339
+ /** Source Ext Id */
13340
+ source_ext_id: string;
13341
+ /** Target Ext Id */
13342
+ target_ext_id?: string | null;
13343
+ status: components['schemas']['TransferItemStatus'];
13344
+ /** Message */
13345
+ message?: string | null;
13346
+ };
13066
13347
  /**
13067
- * UpdateAgentRequest
13068
- * @description Mutable agent fields. Only appearance for now — identity (name/email/keys)
13069
- * is server-managed and renames would break the derived agent email.
13348
+ * TransferItemStatus
13349
+ * @enum {string}
13070
13350
  */
13071
- UpdateAgentRequest: {
13072
- /** Picture */
13073
- picture?: string | null;
13074
- };
13075
- /** UpdateConversationRequest */
13076
- UpdateConversationRequest: {
13077
- /** Add Label Ext Ids */
13078
- add_label_ext_ids?: string[];
13079
- /** Remove Label Ext Ids */
13080
- remove_label_ext_ids?: string[];
13081
- /** Title */
13082
- title?: string | null;
13083
- /** Shared */
13084
- shared?: boolean | null;
13085
- /** Description */
13086
- description?: string | null;
13087
- /** Due At */
13088
- due_at?: string | null;
13089
- /** Parent Conversation Ext Id */
13090
- parent_conversation_ext_id?: string | null;
13091
- /** Status */
13092
- status?: ('todo' | 'done') | null;
13093
- plan?: components['schemas']['TaskPlan'] | null;
13094
- };
13351
+ TransferItemStatus: 'pending' | 'copied' | 'skipped' | 'failed' | 'removed' | 'kept';
13095
13352
  /**
13096
- * UpdateDocTagRequest
13097
- * @description Update a doctag's note or citations. Identified by (tag_ext_id, doc_ext_id) pair.
13353
+ * TransferKind
13354
+ * @description The entity types a user can tick. Folders are not a kind: they are a property of documents.
13355
+ * @enum {string}
13098
13356
  */
13099
- UpdateDocTagRequest: {
13100
- /** Tag Ext Id */
13101
- tag_ext_id: string;
13102
- /** Doc Ext Id */
13103
- doc_ext_id: string;
13104
- /** Note */
13105
- note?: string | null;
13106
- citations?: components['schemas']['CitationSources'] | null;
13107
- };
13357
+ TransferKind: 'documents' | 'skills' | 'labels' | 'fields' | 'facts' | 'conversations' | 'automations';
13108
13358
  /**
13109
- * UpdateDocumentsRequest
13110
- * @description Update one or more documents.
13359
+ * TransferMode
13360
+ * @enum {string}
13111
13361
  */
13112
- UpdateDocumentsRequest: {
13113
- /** Documents */
13114
- documents: components['schemas']['DocUpdateRequest'][];
13362
+ TransferMode: 'download' | 'copy' | 'move';
13363
+ /**
13364
+ * TransferPhase
13365
+ * @enum {string}
13366
+ */
13367
+ TransferPhase: 'copy' | 'link' | 'remove' | 'done';
13368
+ /** TransferPlanRequest */
13369
+ TransferPlanRequest: {
13370
+ scope: components['schemas']['TransferScope'];
13371
+ /** @default copy */
13372
+ mode: components['schemas']['TransferMode'];
13115
13373
  };
13116
13374
  /**
13117
- * UpdateFactRequest
13118
- * @description Patch a fact. An edit to ``text`` soft-deletes the old row and
13119
- * inserts a replacement (append + soft-delete lifecycle); ``pinned``/``shared``/
13120
- * ``tag_ext_ids`` update in place.
13375
+ * TransferPlanResponse
13376
+ * @description What a transfer with this scope would touch — shown to the user before they confirm.
13121
13377
  */
13122
- UpdateFactRequest: {
13123
- /** Text */
13378
+ TransferPlanResponse: {
13379
+ /**
13380
+ * Counts
13381
+ * @default {}
13382
+ */
13383
+ counts: {
13384
+ [key: string]: number;
13385
+ };
13386
+ /**
13387
+ * Added
13388
+ * @default {}
13389
+ */
13390
+ added: {
13391
+ [key: string]: number;
13392
+ };
13393
+ /**
13394
+ * Relations Inside
13395
+ * @default 0
13396
+ */
13397
+ relations_inside: number;
13398
+ /**
13399
+ * Relations Outside
13400
+ * @default 0
13401
+ */
13402
+ relations_outside: number;
13403
+ /**
13404
+ * Dangling References
13405
+ * @default 0
13406
+ */
13407
+ dangling_references: number;
13408
+ /**
13409
+ * Not Removable
13410
+ * @default 0
13411
+ */
13412
+ not_removable: number;
13413
+ /**
13414
+ * Total Bytes
13415
+ * @default 0
13416
+ */
13417
+ total_bytes: number;
13418
+ /**
13419
+ * Item Count
13420
+ * @default 0
13421
+ */
13422
+ item_count: number;
13423
+ };
13424
+ /** TransferResumeRequest */
13425
+ TransferResumeRequest: {
13426
+ /**
13427
+ * Target Workspace Key
13428
+ * @description SealedBox-encrypted target workspace key (encrypted with the session public key)
13429
+ */
13430
+ target_workspace_key: string;
13431
+ };
13432
+ /**
13433
+ * TransferScope
13434
+ * @description What to transfer.
13435
+ */
13436
+ TransferScope: {
13437
+ kind: components['schemas']['TransferScopeKind'];
13438
+ /**
13439
+ * Items
13440
+ * @description selection: external ids — documents (doc-), labels/fields (tag-), facts (fct-), conversations (con-) and automations (wfl-). A document brings all its versions and its attachments.
13441
+ */
13442
+ items?: string[];
13443
+ /** Label Ext Id */
13444
+ label_ext_id?: string | null;
13445
+ /** Kinds */
13446
+ kinds?: components['schemas']['TransferKind'][];
13447
+ /** @default include */
13448
+ referenced_documents: components['schemas']['ReferencedDocuments'];
13449
+ };
13450
+ /**
13451
+ * TransferScopeKind
13452
+ * @enum {string}
13453
+ */
13454
+ TransferScopeKind: 'selection' | 'label' | 'all';
13455
+ /** TransferStartRequest */
13456
+ TransferStartRequest: {
13457
+ scope: components['schemas']['TransferScope'];
13458
+ /** @default copy */
13459
+ mode: components['schemas']['TransferMode'];
13460
+ /** Target Workspace Ext Id */
13461
+ target_workspace_ext_id: string;
13462
+ /**
13463
+ * Target Workspace Key
13464
+ * @description SealedBox-encrypted target workspace key (encrypted with the session public key)
13465
+ */
13466
+ target_workspace_key: string;
13467
+ /** @default skip */
13468
+ on_conflict: components['schemas']['ConflictPolicy'];
13469
+ };
13470
+ /**
13471
+ * TransferStatus
13472
+ * @enum {string}
13473
+ */
13474
+ TransferStatus: 'queued' | 'running' | 'completed' | 'failed' | 'cancelled' | 'interrupted';
13475
+ /** TransferStatusResponse */
13476
+ TransferStatusResponse: {
13477
+ /** External Id */
13478
+ external_id: string;
13479
+ mode: components['schemas']['TransferMode'];
13480
+ status: components['schemas']['TransferStatus'];
13481
+ phase: components['schemas']['TransferPhase'];
13482
+ /** Source Workspace Ext Id */
13483
+ source_workspace_ext_id?: string | null;
13484
+ /** Target Workspace Ext Id */
13485
+ target_workspace_ext_id?: string | null;
13486
+ /**
13487
+ * Total
13488
+ * @default 0
13489
+ */
13490
+ total: number;
13491
+ /**
13492
+ * Processed
13493
+ * @default 0
13494
+ */
13495
+ processed: number;
13496
+ /**
13497
+ * Counts
13498
+ * @default {}
13499
+ */
13500
+ counts: {
13501
+ [key: string]: unknown;
13502
+ };
13503
+ /** Error */
13504
+ error?: string | null;
13505
+ /**
13506
+ * Created At
13507
+ * Format: date-time
13508
+ */
13509
+ created_at: string;
13510
+ /** Finished At */
13511
+ finished_at?: string | null;
13512
+ /**
13513
+ * Issues
13514
+ * @default []
13515
+ */
13516
+ issues: components['schemas']['TransferItemResult'][];
13517
+ };
13518
+ /**
13519
+ * UpdateAgentRequest
13520
+ * @description Mutable agent fields. Only appearance for now — identity (name/email/keys)
13521
+ * is server-managed and renames would break the derived agent email.
13522
+ */
13523
+ UpdateAgentRequest: {
13524
+ /** Picture */
13525
+ picture?: string | null;
13526
+ };
13527
+ /** UpdateConversationRequest */
13528
+ UpdateConversationRequest: {
13529
+ /** Add Label Ext Ids */
13530
+ add_label_ext_ids?: string[];
13531
+ /** Remove Label Ext Ids */
13532
+ remove_label_ext_ids?: string[];
13533
+ /** Title */
13534
+ title?: string | null;
13535
+ /** Shared */
13536
+ shared?: boolean | null;
13537
+ /** Description */
13538
+ description?: string | null;
13539
+ /** Due At */
13540
+ due_at?: string | null;
13541
+ /** Parent Conversation Ext Id */
13542
+ parent_conversation_ext_id?: string | null;
13543
+ /** Status */
13544
+ status?: ('todo' | 'done') | null;
13545
+ plan?: components['schemas']['TaskPlan'] | null;
13546
+ };
13547
+ /**
13548
+ * UpdateDocTagRequest
13549
+ * @description Update a doctag's note or citations. Identified by (tag_ext_id, doc_ext_id) pair.
13550
+ */
13551
+ UpdateDocTagRequest: {
13552
+ /** Tag Ext Id */
13553
+ tag_ext_id: string;
13554
+ /** Doc Ext Id */
13555
+ doc_ext_id: string;
13556
+ /** Note */
13557
+ note?: string | null;
13558
+ citations?: components['schemas']['CitationSources'] | null;
13559
+ };
13560
+ /**
13561
+ * UpdateDocumentsRequest
13562
+ * @description Update one or more documents.
13563
+ */
13564
+ UpdateDocumentsRequest: {
13565
+ /** Documents */
13566
+ documents: components['schemas']['DocUpdateRequest'][];
13567
+ };
13568
+ /**
13569
+ * UpdateFactRequest
13570
+ * @description Patch a fact. An edit to ``text`` soft-deletes the old row and
13571
+ * inserts a replacement (append + soft-delete lifecycle); ``pinned``/``shared``/
13572
+ * ``tag_ext_ids`` update in place.
13573
+ */
13574
+ UpdateFactRequest: {
13575
+ /** Text */
13124
13576
  text?: string | null;
13125
13577
  /** Pinned */
13126
13578
  pinned?: boolean | null;
@@ -13268,6 +13720,8 @@ interface components {
13268
13720
  UploadDocumentsResponse: {
13269
13721
  /** Doc Ext Ids */
13270
13722
  doc_ext_ids?: string[];
13723
+ /** Version */
13724
+ version?: number | null;
13271
13725
  /**
13272
13726
  * Batch Id
13273
13727
  * @description Batch ID for tracking completion via WebSocket batch_complete events
@@ -13295,7 +13749,7 @@ interface components {
13295
13749
  config_ext_id?: string | null;
13296
13750
  /**
13297
13751
  * Version Of
13298
- * @description Upload as the next version of this document (any of its versions)
13752
+ * @description Upload as the next version of this document
13299
13753
  */
13300
13754
  version_of?: string | null;
13301
13755
  /** Wp Type */
@@ -13855,7 +14309,7 @@ interface components {
13855
14309
  /**
13856
14310
  * Model Name
13857
14311
  * @description The vision-capable model name (must support image inputs).
13858
- * @default dummy
14312
+ * @default Fast
13859
14313
  */
13860
14314
  MODEL_NAME: string;
13861
14315
  /**
@@ -14098,6 +14552,31 @@ interface components {
14098
14552
  /** Project Ext Id */
14099
14553
  project_ext_id: string;
14100
14554
  };
14555
+ /** WorkspaceExportRequest */
14556
+ WorkspaceExportRequest: {
14557
+ scope: components['schemas']['TransferScope'];
14558
+ };
14559
+ /**
14560
+ * WorkspaceExportResponse
14561
+ * @description Structured data for a download, plus the files to fetch.
14562
+ *
14563
+ * ``data`` is decrypted plaintext keyed by entity type (one JSON file per type in
14564
+ * the archive); ``manifest`` describes the archive itself.
14565
+ */
14566
+ WorkspaceExportResponse: {
14567
+ /** Manifest */
14568
+ manifest: {
14569
+ [key: string]: unknown;
14570
+ };
14571
+ /** Data */
14572
+ data: {
14573
+ [key: string]: {
14574
+ [key: string]: unknown;
14575
+ }[];
14576
+ };
14577
+ /** Files */
14578
+ files: components['schemas']['ExportFile'][];
14579
+ };
14101
14580
  /**
14102
14581
  * WorkspaceOpenRequest
14103
14582
  * @description Request to open a workspace — stores encrypted key in session and sets active.
@@ -15712,6 +16191,253 @@ interface operations {
15712
16191
  };
15713
16192
  };
15714
16193
  };
16194
+ plan_workspace_transfer: {
16195
+ parameters: {
16196
+ query?: never;
16197
+ header?: never;
16198
+ path?: never;
16199
+ cookie?: never;
16200
+ };
16201
+ requestBody: {
16202
+ content: {
16203
+ 'application/json': components['schemas']['TransferPlanRequest'];
16204
+ };
16205
+ };
16206
+ responses: {
16207
+ /** @description Successful Response */
16208
+ 200: {
16209
+ headers: {
16210
+ [name: string]: unknown;
16211
+ };
16212
+ content: {
16213
+ 'application/json': components['schemas']['TransferPlanResponse'];
16214
+ };
16215
+ };
16216
+ /** @description Validation Error */
16217
+ 422: {
16218
+ headers: {
16219
+ [name: string]: unknown;
16220
+ };
16221
+ content: {
16222
+ 'application/json': components['schemas']['HTTPValidationError'];
16223
+ };
16224
+ };
16225
+ };
16226
+ };
16227
+ export_workspace_data: {
16228
+ parameters: {
16229
+ query?: never;
16230
+ header?: never;
16231
+ path?: never;
16232
+ cookie?: never;
16233
+ };
16234
+ requestBody: {
16235
+ content: {
16236
+ 'application/json': components['schemas']['WorkspaceExportRequest'];
16237
+ };
16238
+ };
16239
+ responses: {
16240
+ /** @description Successful Response */
16241
+ 200: {
16242
+ headers: {
16243
+ [name: string]: unknown;
16244
+ };
16245
+ content: {
16246
+ 'application/json': components['schemas']['WorkspaceExportResponse'];
16247
+ };
16248
+ };
16249
+ /** @description Validation Error */
16250
+ 422: {
16251
+ headers: {
16252
+ [name: string]: unknown;
16253
+ };
16254
+ content: {
16255
+ 'application/json': components['schemas']['HTTPValidationError'];
16256
+ };
16257
+ };
16258
+ };
16259
+ };
16260
+ list_workspace_transfers: {
16261
+ parameters: {
16262
+ query?: never;
16263
+ header?: never;
16264
+ path?: never;
16265
+ cookie?: never;
16266
+ };
16267
+ requestBody?: never;
16268
+ responses: {
16269
+ /** @description Successful Response */
16270
+ 200: {
16271
+ headers: {
16272
+ [name: string]: unknown;
16273
+ };
16274
+ content: {
16275
+ 'application/json': components['schemas']['TransferStatusResponse'][];
16276
+ };
16277
+ };
16278
+ };
16279
+ };
16280
+ start_workspace_transfer: {
16281
+ parameters: {
16282
+ query?: never;
16283
+ header?: never;
16284
+ path?: never;
16285
+ cookie?: never;
16286
+ };
16287
+ requestBody: {
16288
+ content: {
16289
+ 'application/json': components['schemas']['TransferStartRequest'];
16290
+ };
16291
+ };
16292
+ responses: {
16293
+ /** @description Successful Response */
16294
+ 202: {
16295
+ headers: {
16296
+ [name: string]: unknown;
16297
+ };
16298
+ content: {
16299
+ 'application/json': components['schemas']['TransferStatusResponse'];
16300
+ };
16301
+ };
16302
+ /** @description Validation Error */
16303
+ 422: {
16304
+ headers: {
16305
+ [name: string]: unknown;
16306
+ };
16307
+ content: {
16308
+ 'application/json': components['schemas']['HTTPValidationError'];
16309
+ };
16310
+ };
16311
+ };
16312
+ };
16313
+ get_workspace_transfer: {
16314
+ parameters: {
16315
+ query?: never;
16316
+ header?: never;
16317
+ path: {
16318
+ transfer_ext_id: string;
16319
+ };
16320
+ cookie?: never;
16321
+ };
16322
+ requestBody?: never;
16323
+ responses: {
16324
+ /** @description Successful Response */
16325
+ 200: {
16326
+ headers: {
16327
+ [name: string]: unknown;
16328
+ };
16329
+ content: {
16330
+ 'application/json': components['schemas']['TransferStatusResponse'];
16331
+ };
16332
+ };
16333
+ /** @description Validation Error */
16334
+ 422: {
16335
+ headers: {
16336
+ [name: string]: unknown;
16337
+ };
16338
+ content: {
16339
+ 'application/json': components['schemas']['HTTPValidationError'];
16340
+ };
16341
+ };
16342
+ };
16343
+ };
16344
+ list_workspace_transfer_items: {
16345
+ parameters: {
16346
+ query?: never;
16347
+ header?: never;
16348
+ path: {
16349
+ transfer_ext_id: string;
16350
+ };
16351
+ cookie?: never;
16352
+ };
16353
+ requestBody?: never;
16354
+ responses: {
16355
+ /** @description Successful Response */
16356
+ 200: {
16357
+ headers: {
16358
+ [name: string]: unknown;
16359
+ };
16360
+ content: {
16361
+ 'application/json': components['schemas']['TransferItemResult'][];
16362
+ };
16363
+ };
16364
+ /** @description Validation Error */
16365
+ 422: {
16366
+ headers: {
16367
+ [name: string]: unknown;
16368
+ };
16369
+ content: {
16370
+ 'application/json': components['schemas']['HTTPValidationError'];
16371
+ };
16372
+ };
16373
+ };
16374
+ };
16375
+ resume_workspace_transfer: {
16376
+ parameters: {
16377
+ query?: never;
16378
+ header?: never;
16379
+ path: {
16380
+ transfer_ext_id: string;
16381
+ };
16382
+ cookie?: never;
16383
+ };
16384
+ requestBody: {
16385
+ content: {
16386
+ 'application/json': components['schemas']['TransferResumeRequest'];
16387
+ };
16388
+ };
16389
+ responses: {
16390
+ /** @description Successful Response */
16391
+ 202: {
16392
+ headers: {
16393
+ [name: string]: unknown;
16394
+ };
16395
+ content: {
16396
+ 'application/json': components['schemas']['TransferStatusResponse'];
16397
+ };
16398
+ };
16399
+ /** @description Validation Error */
16400
+ 422: {
16401
+ headers: {
16402
+ [name: string]: unknown;
16403
+ };
16404
+ content: {
16405
+ 'application/json': components['schemas']['HTTPValidationError'];
16406
+ };
16407
+ };
16408
+ };
16409
+ };
16410
+ cancel_workspace_transfer: {
16411
+ parameters: {
16412
+ query?: never;
16413
+ header?: never;
16414
+ path: {
16415
+ transfer_ext_id: string;
16416
+ };
16417
+ cookie?: never;
16418
+ };
16419
+ requestBody?: never;
16420
+ responses: {
16421
+ /** @description Successful Response */
16422
+ 200: {
16423
+ headers: {
16424
+ [name: string]: unknown;
16425
+ };
16426
+ content: {
16427
+ 'application/json': components['schemas']['TransferStatusResponse'];
16428
+ };
16429
+ };
16430
+ /** @description Validation Error */
16431
+ 422: {
16432
+ headers: {
16433
+ [name: string]: unknown;
16434
+ };
16435
+ content: {
16436
+ 'application/json': components['schemas']['HTTPValidationError'];
16437
+ };
16438
+ };
16439
+ };
16440
+ };
15715
16441
  request_docx_agent_v1_editor__document_id__mentions_post: {
15716
16442
  parameters: {
15717
16443
  query?: never;
@@ -15977,7 +16703,10 @@ interface operations {
15977
16703
  };
15978
16704
  native_content_v1_editor__document_id__content_get: {
15979
16705
  parameters: {
15980
- query?: never;
16706
+ query?: {
16707
+ /** @description Document version (default: the current one) */
16708
+ version?: number | null;
16709
+ };
15981
16710
  header?: never;
15982
16711
  path: {
15983
16712
  document_id: string;
@@ -16011,6 +16740,10 @@ interface operations {
16011
16740
  query: {
16012
16741
  revised_ext_id: string;
16013
16742
  base_ext_id?: string | null;
16743
+ /** @description Version of the revised document (default current) */
16744
+ revised_version?: number | null;
16745
+ /** @description Version of the base document (default current) */
16746
+ base_version?: number | null;
16014
16747
  };
16015
16748
  header?: never;
16016
16749
  path?: never;
@@ -16222,7 +16955,7 @@ interface operations {
16222
16955
  [name: string]: unknown;
16223
16956
  };
16224
16957
  content: {
16225
- 'application/json': components['schemas']['DocResponse'][];
16958
+ 'application/json': components['schemas']['DocVersion'][];
16226
16959
  };
16227
16960
  };
16228
16961
  /** @description Validation Error */
@@ -16340,13 +17073,13 @@ interface operations {
16340
17073
  shared?: boolean;
16341
17074
  /** @description Configuration to use for processing */
16342
17075
  config_ext_id?: string | null;
16343
- /** @description Upload a single file as the next version of this document (any of its versions). It becomes the current version and takes the document's sharing, folder and labels. */
17076
+ /** @description Upload a single file as the next version of this document. The document keeps its id, sharing, folder and labels; the new version becomes current (the response's `version`). */
16344
17077
  version_of?: string | null;
16345
17078
  /** @description A new, separate document made from this one (a crop, a redacted copy) or, repeated, from several (a production set); recorded as provenance only */
16346
17079
  derived_from?: string[] | null;
16347
17080
  /** @description How it was made from `derived_from` */
16348
17081
  derived_role?: ('crop' | 'redline_base' | 'redline_revised' | 'redaction' | 'annotated' | 'production') | null;
16349
- /** @description Work product type: source, skill, memory, artifact */
17082
+ /** @description Work product type: source, skill, artifact */
16350
17083
  wp_type?: string | null;
16351
17084
  /** @description Tag to link the document to */
16352
17085
  tag_ext_id?: string | null;
@@ -16492,7 +17225,10 @@ interface operations {
16492
17225
  };
16493
17226
  download_document: {
16494
17227
  parameters: {
16495
- query?: never;
17228
+ query?: {
17229
+ /** @description Document version (default: the current one) */
17230
+ version?: number | null;
17231
+ };
16496
17232
  header?: never;
16497
17233
  path: {
16498
17234
  document_ext_id: string;
@@ -16523,7 +17259,10 @@ interface operations {
16523
17259
  };
16524
17260
  view_document_inline: {
16525
17261
  parameters: {
16526
- query?: never;
17262
+ query?: {
17263
+ /** @description Document version (default: the current one) */
17264
+ version?: number | null;
17265
+ };
16527
17266
  header?: never;
16528
17267
  path: {
16529
17268
  document_ext_id: string;
@@ -16554,7 +17293,10 @@ interface operations {
16554
17293
  };
16555
17294
  get_document_thumbnail: {
16556
17295
  parameters: {
16557
- query?: never;
17296
+ query?: {
17297
+ /** @description Document version (default: the current one) */
17298
+ version?: number | null;
17299
+ };
16558
17300
  header?: never;
16559
17301
  path: {
16560
17302
  document_ext_id: string;
@@ -16618,7 +17360,10 @@ interface operations {
16618
17360
  };
16619
17361
  get_parsed_document: {
16620
17362
  parameters: {
16621
- query?: never;
17363
+ query?: {
17364
+ /** @description Document version (default: the current one) */
17365
+ version?: number | null;
17366
+ };
16622
17367
  header?: never;
16623
17368
  path: {
16624
17369
  document_ext_id: string;
@@ -16756,7 +17501,10 @@ interface operations {
16756
17501
  };
16757
17502
  get_document_signature_status: {
16758
17503
  parameters: {
16759
- query?: never;
17504
+ query?: {
17505
+ /** @description Document version (default: the current one) */
17506
+ version?: number | null;
17507
+ };
16760
17508
  header?: never;
16761
17509
  path: {
16762
17510
  document_ext_id: string;