@arke-institute/sdk 2.7.0 → 2.7.1

package/dist/generated/index.d.cts

@@ -6,7 +6,7 @@
  *
  * Source: Arke v1 API
  * Version: 1.0.0
- * Generated: 2026-01-26T22:08:41.056Z
+ * Generated: 2026-01-28T21:31:10.509Z
  */
 type paths = {
     "/ops-reference": {
@@ -2064,6 +2064,121 @@ type paths = {
         patch?: never;
         trace?: never;
     };
+    "/entities/batch": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Batch create entities
+         * @description Creates multiple entities in a single request with bounded internal concurrency.
+         *
+         *     Entities are created in chunks of 10 internally. Each entity follows the same permission model as single creates.
+         *
+         *     Returns per-entity results. HTTP 201 if all succeed, 207 if some fail.
+         *
+         *     **Max batch size:** 100 entities.
+         *
+         *     ---
+         *     **Permission:** `entity:create`
+         *     **Auth:** required
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: {
+                content: {
+                    "application/json": components["schemas"]["BatchCreateEntityRequest"];
+                };
+            };
+            responses: {
+                /** @description All entities created successfully */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["BatchCreateEntityResponse"];
+                    };
+                };
+                /** @description Partial success - some entities failed */
+                207: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["BatchCreateEntityResponse"];
+                    };
+                };
+                /** @description Bad Request - Invalid input */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Validation failed",
+                         *       "details": {
+                         *         "issues": [
+                         *           {
+                         *             "path": [
+                         *               "properties",
+                         *               "label"
+                         *             ],
+                         *             "message": "Required"
+                         *           }
+                         *         ]
+                         *       }
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ValidationErrorResponse"];
+                    };
+                };
+                /** @description Unauthorized - Missing or invalid authentication */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Unauthorized: Missing or invalid authentication token"
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Forbidden - Insufficient permissions */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Forbidden: You do not have permission to perform this action"
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/entities/{id}": {
         parameters: {
             query?: never;
@@ -7669,18 +7784,19 @@ type paths = {
          * Search agents by text
          * @description Search for agents using semantic text search.
          *
-         *     Use this endpoint to discover agents across the network. Only active agents are returned. Results are ranked by semantic similarity to your query based on agent descriptions and capabilities.
+         *     **Official Agents (Default):** By default, this endpoint searches only the official Arke agents collection (`01KFF0H1KSR4SHHDQ7T2HXQEK6`). These agents are pre-approved, actively maintained, and tested for security and reliability.
          *
-         *     **Entity Expansion:**
+         *     **All Agents:** Set `scope: "all"` to search network-wide. This is not recommended as results may include duplicates, outdated agents, or unapproved implementations.
          *
-         *     Use `expand` in the request body to fetch entity data inline with search results:
+         *     Results are ranked by semantic similarity to your query based on agent descriptions and capabilities.
          *
-         *     - **`expand: "preview"` (default)**: Adds `entity_preview` with fresh lightweight data (id, type, label, timestamps)
-         *     - **`expand: "full"`**: Adds `entity` with complete manifest including all properties and relationships
-         *     - **`expand: "none"`**: Returns search metadata only (fastest, lowest bandwidth)
+         *     **Entity Expansion:**
          *
-         *     Preview mode is recommended for most use cases. Full expansion can result in large payloads.
-         *     Gracefully handles deleted or inaccessible entities (returns results without expansion data).
+         *     By default, agent search returns **full entity manifests** (including `endpoint`, `input_schema`, `actions_required`, etc.) to make discovery results immediately useful.
+         *
+         *     - **`expand: "full"` (default)**: Complete agent manifests with all properties
+         *     - **`expand: "preview"`**: Lightweight previews (id, type, label, description_preview, timestamps)
+         *     - **`expand: "none"`**: Search metadata only (fastest)
          *
          *     ---
          *     **Permission:** `search:query`
@@ -7709,6 +7825,12 @@ type paths = {
                          * @enum {string}
                          */
                         expand?: "preview" | "full" | "none";
+                        /**
+                         * @description Search scope. "official" (default) searches only the pre-approved Arke agents collection. "all" searches all agents network-wide (not recommended - may include duplicates, outdated, or unapproved agents).
+                         * @default official
+                         * @enum {string}
+                         */
+                        scope?: "official" | "all";
                     };
                 };
             };
@@ -8113,6 +8235,12 @@ type paths = {
          *     {"type":"message_delta","delta":{"usage":{"input_tokens":123,"output_tokens":456}}}
          *     ```
          *
+         *     ## Storage Limits
+         *
+         *     - **Single message**: 2 MB max (returns 413 with code `MESSAGE_TOO_LARGE`)
+         *     - **Chat database**: 10 GB max (returns 507 with code `CHAT_STORAGE_FULL`)
+         *     - **LLM context**: ~128K tokens (returns stream error)
+         *
          *
          *     ---
          *     **Permission:** `chat:send`
@@ -8168,8 +8296,89 @@ type paths = {
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
+                /** @description Message exceeds 2MB storage limit */
+                413: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["MessageTooLargeError"];
+                    };
+                };
+                /** @description Chat storage full (10GB limit) */
+                507: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ChatStorageFullError"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/chat/sessions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List user chats
+         * @description Returns a paginated list of the authenticated user's chats, sorted newest-first.
+         *
+         *     Only returns chats owned by the authenticated user. Anonymous chats are not indexed.
+         *
+         *     Query parameters:
+         *     - `limit`: Max chats to return (1-100, default 20)
+         *     - `offset`: Number of chats to skip for pagination (default 0)
+         *
+         *     ---
+         *     **Permission:** `chat:view`
+         *     **Auth:** required
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description List of user chats */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ListChatsResponse"];
+                    };
+                };
+                /** @description Unauthorized - Missing or invalid authentication */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Unauthorized: Missing or invalid authentication token"
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
             };
         };
+        put?: never;
+        post?: never;
         delete?: never;
         options?: never;
         head?: never;
@@ -8187,11 +8396,11 @@ type paths = {
          * Get chat session
          * @description Get information about a chat session including message history.
          *
-         *     Sessions are publicly viewable for sharing purposes. Only the owner can send messages or delete the session.
+         *     Only the session owner can view their chat sessions.
          *
          *     ---
          *     **Permission:** `chat:view`
-         *     **Auth:** optional
+         *     **Auth:** required
          */
         get: {
             parameters: {
@@ -8211,6 +8420,34 @@ type paths = {
                         "application/json": components["schemas"]["ChatSession"];
                     };
                 };
+                /** @description Unauthorized - Missing or invalid authentication */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Unauthorized: Missing or invalid authentication token"
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
+                /** @description Forbidden - Insufficient permissions */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        /**
+                         * @example {
+                         *       "error": "Forbidden: You do not have permission to perform this action"
+                         *     }
+                         */
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
                 /** @description Not Found - Resource does not exist */
                 404: {
                     headers: {
@@ -8677,17 +8914,28 @@ type components = {
              */
             ts: number;
             /**
-             * @description Audit trail for edits
+             * @description Audit trail for edits. Label fields are populated when ?expand=relationships is used.
              * @example {
              *       "user_id": "01JCAPTAINAHAB000000000000",
+             *       "user_label": "Captain Ahab",
              *       "method": "manual"
              *     }
              */
             edited_by: {
                 user_id: string;
+                /**
+                 * @description Display name of the user/agent (populated during expansion)
+                 * @example Captain Ahab
+                 */
+                user_label?: string;
                 /** @enum {string} */
                 method: "manual" | "ai_generated" | "system" | "import";
                 on_behalf_of?: string;
+                /**
+                 * @description Display name of the on_behalf_of user/agent (populated during expansion)
+                 * @example Research Assistant
+                 */
+                on_behalf_of_label?: string;
             };
             /**
              * @description Previous version CID (present on updates)
@@ -9509,17 +9757,28 @@ type components = {
              */
             ts: number;
             /**
-             * @description Audit trail for edits
+             * @description Audit trail for edits. Label fields are populated when ?expand=relationships is used.
              * @example {
              *       "user_id": "01JCAPTAINAHAB000000000000",
+             *       "user_label": "Captain Ahab",
              *       "method": "manual"
              *     }
              */
             edited_by: {
                 user_id: string;
+                /**
+                 * @description Display name of the user/agent (populated during expansion)
+                 * @example Captain Ahab
+                 */
+                user_label?: string;
                 /** @enum {string} */
                 method: "manual" | "ai_generated" | "system" | "import";
                 on_behalf_of?: string;
+                /**
+                 * @description Display name of the on_behalf_of user/agent (populated during expansion)
+                 * @example Research Assistant
+                 */
+                on_behalf_of_label?: string;
             };
             /**
              * @description Previous version CID (present on updates)
@@ -9569,6 +9828,79 @@ type components = {
              */
             collection?: string;
         };
+        BatchCreateSuccess: {
+            /** @enum {boolean} */
+            success: true;
+            index: number;
+            /**
+             * @description Entity ID (ULID format)
+             * @example 01KDETYWYWM0MJVKM8DK3AEXPY
+             */
+            id: string;
+            /**
+             * @description Content Identifier (CID) - content-addressed hash
+             * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
+             */
+            cid: string;
+            type: string;
+            /**
+             * @description Entity version number
+             * @example 1
+             */
+            ver: number;
+        };
+        BatchCreateFailure: {
+            /** @enum {boolean} */
+            success: false;
+            index: number;
+            error: string;
+            code: string;
+        };
+        BatchCreateEntityResponse: {
+            results: (components["schemas"]["BatchCreateSuccess"] | components["schemas"]["BatchCreateFailure"])[];
+            summary: {
+                total: number;
+                succeeded: number;
+                failed: number;
+            };
+        };
+        BatchCreateEntityItem: {
+            /**
+             * @description Optional note describing this change
+             * @example Added Chapter 42: The Whiteness of the Whale
+             */
+            note?: string;
+            /** @description Entity type identifier */
+            type: string;
+            /** @description Entity properties */
+            properties?: {
+                [key: string]: unknown;
+            };
+            /** @description Entity relationships */
+            relationships?: {
+                predicate: string;
+                peer: string;
+                peer_type?: string;
+                peer_label?: string;
+                properties?: {
+                    [key: string]: unknown;
+                };
+            }[];
+            /**
+             * @description Parent collection ID (creates collection relationship)
+             * @example 01KDETYWYWM0MJVKM8DK3AEXPY
+             */
+            collection?: string;
+        };
+        BatchCreateEntityRequest: {
+            /** @description Array of entities to create (1-100) */
+            entities: components["schemas"]["BatchCreateEntityItem"][];
+            /**
+             * @description Default collection for entities that do not specify one
+             * @example 01KDETYWYWM0MJVKM8DK3AEXPY
+             */
+            default_collection?: string;
+        };
         TipResponse: {
             /**
              * @description Entity ID (ULID format)
@@ -10235,17 +10567,28 @@ type components = {
              */
             ts: number;
             /**
-             * @description Audit trail for edits
+             * @description Audit trail for edits. Label fields are populated when ?expand=relationships is used.
              * @example {
              *       "user_id": "01JCAPTAINAHAB000000000000",
+             *       "user_label": "Captain Ahab",
              *       "method": "manual"
              *     }
              */
             edited_by: {
                 user_id: string;
+                /**
+                 * @description Display name of the user/agent (populated during expansion)
+                 * @example Captain Ahab
+                 */
+                user_label?: string;
                 /** @enum {string} */
                 method: "manual" | "ai_generated" | "system" | "import";
                 on_behalf_of?: string;
+                /**
+                 * @description Display name of the on_behalf_of user/agent (populated during expansion)
+                 * @example Research Assistant
+                 */
+                on_behalf_of_label?: string;
             };
         };
         CreateFileRequest: {
@@ -10494,17 +10837,28 @@ type components = {
              */
             ts: number;
             /**
-             * @description Audit trail for edits
+             * @description Audit trail for edits. Label fields are populated when ?expand=relationships is used.
              * @example {
              *       "user_id": "01JCAPTAINAHAB000000000000",
+             *       "user_label": "Captain Ahab",
              *       "method": "manual"
              *     }
              */
             edited_by: {
                 user_id: string;
+                /**
+                 * @description Display name of the user/agent (populated during expansion)
+                 * @example Captain Ahab
+                 */
+                user_label?: string;
                 /** @enum {string} */
                 method: "manual" | "ai_generated" | "system" | "import";
                 on_behalf_of?: string;
+                /**
+                 * @description Display name of the on_behalf_of user/agent (populated during expansion)
+                 * @example Research Assistant
+                 */
+                on_behalf_of_label?: string;
             };
         };
         CreateFolderRequest: {
@@ -10827,17 +11181,28 @@ type components = {
              */
             ts: string;
             /**
-             * @description Audit trail for edits
+             * @description Audit trail for edits. Label fields are populated when ?expand=relationships is used.
              * @example {
              *       "user_id": "01JCAPTAINAHAB000000000000",
+             *       "user_label": "Captain Ahab",
              *       "method": "manual"
              *     }
              */
             edited_by: {
                 user_id: string;
+                /**
+                 * @description Display name of the user/agent (populated during expansion)
+                 * @example Captain Ahab
+                 */
+                user_label?: string;
                 /** @enum {string} */
                 method: "manual" | "ai_generated" | "system" | "import";
                 on_behalf_of?: string;
+                /**
+                 * @description Display name of the on_behalf_of user/agent (populated during expansion)
+                 * @example Research Assistant
+                 */
+                on_behalf_of_label?: string;
             };
             /** @description Optional note describing this version */
             note?: string;
@@ -10926,17 +11291,28 @@ type components = {
                     };
                 }[];
                 /**
-                 * @description Audit trail for edits
+                 * @description Audit trail for edits. Label fields are populated when ?expand=relationships is used.
                  * @example {
                  *       "user_id": "01JCAPTAINAHAB000000000000",
+                 *       "user_label": "Captain Ahab",
                  *       "method": "manual"
                  *     }
                  */
                 edited_by: {
                     user_id: string;
+                    /**
+                     * @description Display name of the user/agent (populated during expansion)
+                     * @example Captain Ahab
+                     */
+                    user_label?: string;
                     /** @enum {string} */
                     method: "manual" | "ai_generated" | "system" | "import";
                     on_behalf_of?: string;
+                    /**
+                     * @description Display name of the on_behalf_of user/agent (populated during expansion)
+                     * @example Research Assistant
+                     */
+                    on_behalf_of_label?: string;
                 };
                 note?: string;
             };
@@ -11925,6 +12301,48 @@ type components = {
              */
             expand?: "none" | "preview" | "full";
         };
+        MessageTooLargeDetails: {
+            /** @enum {string} */
+            code: "MESSAGE_TOO_LARGE";
+            message: string;
+            /** @example 2MB */
+            limit: string;
+            /** @example 2.48MB */
+            actual?: string;
+        };
+        MessageTooLargeError: {
+            /**
+             * @description Human-readable error message
+             * @example Message exceeds maximum size limit. Please shorten your message.
+             */
+            error: string;
+            /**
+             * @description Error code for client handling
+             * @enum {string}
+             */
+            code: "MESSAGE_TOO_LARGE";
+            details?: components["schemas"]["MessageTooLargeDetails"];
+        };
+        ChatStorageFullDetails: {
+            /** @enum {string} */
+            code: "CHAT_STORAGE_FULL";
+            message: string;
+            /** @example 10GB */
+            limit: string;
+        };
+        ChatStorageFullError: {
+            /**
+             * @description Human-readable error message
+             * @example This conversation has reached its maximum storage capacity. Please start a new conversation.
+             */
+            error: string;
+            /**
+             * @description Error code for client handling
+             * @enum {string}
+             */
+            code: "CHAT_STORAGE_FULL";
+            details?: components["schemas"]["ChatStorageFullDetails"];
+        };
         TextPart: {
             /** @enum {string} */
             type: "text";
@@ -11955,6 +12373,47 @@ type components = {
             /** @description Array of chat messages in AI SDK v5 UIMessage format */
             messages: components["schemas"]["ChatMessage"][];
         };
+        ChatListItem: {
+            /**
+             * @description Chat UUID (use with X-Chat-ID header)
+             * @example 550e8400-e29b-41d4-a716-446655440000
+             */
+            id: string;
+            /**
+             * @description Auto-generated from first message (50 chars)
+             * @example Help me understand the Arke API...
+             */
+            title: string | null;
+            /**
+             * @description ISO8601 timestamp of chat creation
+             * @example 2026-01-26T14:30:00.000Z
+             */
+            createdAt: string;
+            /**
+             * @description ISO8601 timestamp of last message
+             * @example 2026-01-26T15:45:00.000Z
+             */
+            updatedAt: string;
+            /**
+             * @description Last assistant response (100 chars, markdown stripped)
+             * @example I found 3 entities matching your query. The first one is...
+             */
+            lastMessagePreview: string | null;
+        };
+        ListChatsResponse: {
+            /** @description Array of chat metadata objects */
+            chats: components["schemas"]["ChatListItem"][];
+            /**
+             * @description Total number of chats for this user
+             * @example 42
+             */
+            total: number;
+            /**
+             * @description True if more chats exist beyond current page
+             * @example true
+             */
+            hasMore: boolean;
+        };
         ChatSession: {
             /**
              * @description Chat session ID