@runtypelabs/sdk 4.8.1 → 4.9.0

package/dist/index.d.ts

@@ -3240,6 +3240,826 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/apps": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List apps
+         * @description List apps for the authenticated owner, newest first.
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Apps */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                activeVersionId: string | null;
+                                clientTokenId: string | null;
+                                createdAt: string;
+                                description: string | null;
+                                hostname: string;
+                                id: string;
+                                name: string;
+                                shortId: string;
+                                slug: string;
+                                /** @enum {string} */
+                                status: "active" | "suspended";
+                                updatedAt: string;
+                                url: string;
+                                /** @enum {string} */
+                                visibility: "public" | "unlisted";
+                            }[];
+                        };
+                    };
+                };
+                /** @description Unauthorized */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Insufficient permissions */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Internal server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        /**
+         * Create an app
+         * @description Create an app. The hostname is {slug}-{shortId}.runtype.run; a client token scoped to that origin is auto-provisioned. Upload a version and activate it to start serving.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        description?: string;
+                        name: string;
+                        /** @description Hostname slug: lowercase letters, digits, and hyphens; must start with a letter. The app serves at {slug}-{shortId}.runtype.run. */
+                        slug: string;
+                        /**
+                         * @default unlisted
+                         * @enum {string}
+                         */
+                        visibility?: "public" | "unlisted";
+                    };
+                };
+            };
+            responses: {
+                /** @description App created */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            activeVersionId: string | null;
+                            clientTokenId: string | null;
+                            createdAt: string;
+                            description: string | null;
+                            hostname: string;
+                            id: string;
+                            name: string;
+                            shortId: string;
+                            slug: string;
+                            /** @enum {string} */
+                            status: "active" | "suspended";
+                            updatedAt: string;
+                            url: string;
+                            /** @enum {string} */
+                            visibility: "public" | "unlisted";
+                        };
+                    };
+                };
+                /** @description Invalid input */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Unauthorized */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Plan limit reached */
+                402: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Insufficient permissions */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Internal server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/apps/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get an app */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description App */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            activeVersionId: string | null;
+                            clientTokenId: string | null;
+                            createdAt: string;
+                            description: string | null;
+                            hostname: string;
+                            id: string;
+                            name: string;
+                            shortId: string;
+                            slug: string;
+                            /** @enum {string} */
+                            status: "active" | "suspended";
+                            updatedAt: string;
+                            url: string;
+                            /** @enum {string} */
+                            visibility: "public" | "unlisted";
+                        };
+                    };
+                };
+                /** @description Invalid id */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Unauthorized */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Insufficient permissions */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        /**
+         * Delete an app
+         * @description Delete an app, its versions, and its routing. Stored bundle files are cleaned up in the background; the auto-provisioned client token is deactivated.
+         */
+        delete: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Deleted */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            success: boolean;
+                        };
+                    };
+                };
+                /** @description Invalid id */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Unauthorized */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Insufficient permissions */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Internal server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+            };
+        };
+        options?: never;
+        head?: never;
+        /**
+         * Update an app
+         * @description Update name, description, visibility, or status. Setting status to suspended makes the edge serve 410 for the app.
+         */
+        patch: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        description?: string | null;
+                        name?: string;
+                        /** @enum {string} */
+                        status?: "active" | "suspended";
+                        /** @enum {string} */
+                        visibility?: "public" | "unlisted";
+                    };
+                };
+            };
+            responses: {
+                /** @description Updated app */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            activeVersionId: string | null;
+                            clientTokenId: string | null;
+                            createdAt: string;
+                            description: string | null;
+                            hostname: string;
+                            id: string;
+                            name: string;
+                            shortId: string;
+                            slug: string;
+                            /** @enum {string} */
+                            status: "active" | "suspended";
+                            updatedAt: string;
+                            url: string;
+                            /** @enum {string} */
+                            visibility: "public" | "unlisted";
+                        };
+                    };
+                };
+                /** @description Invalid input */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Unauthorized */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Plan limit reached */
+                402: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Insufficient permissions */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Internal server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+            };
+        };
+        trace?: never;
+    };
+    "/v1/apps/{id}/activate": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Activate an app version
+         * @description Flip the active-version pointer to the given version (deploy or rollback). Syncs the app client token to the manifest capabilities and updates edge routing.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody: {
+                content: {
+                    "application/json": {
+                        versionId: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description Activated */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            app: {
+                                activeVersionId: string | null;
+                                clientTokenId: string | null;
+                                createdAt: string;
+                                description: string | null;
+                                hostname: string;
+                                id: string;
+                                name: string;
+                                shortId: string;
+                                slug: string;
+                                /** @enum {string} */
+                                status: "active" | "suspended";
+                                updatedAt: string;
+                                url: string;
+                                /** @enum {string} */
+                                visibility: "public" | "unlisted";
+                            };
+                            version: {
+                                appId: string;
+                                bundleHash: string;
+                                createdAt: string;
+                                createdBy: string;
+                                fileCount: number;
+                                id: string;
+                                manifest: {
+                                    /** @enum {string} */
+                                    auth: "none" | "optional" | "required";
+                                    capabilities: {
+                                        agents: string[];
+                                        flows: string[];
+                                    };
+                                    data: {
+                                        /** @enum {string} */
+                                        access: "read" | "read-write";
+                                        namespace: string;
+                                    }[];
+                                    description?: string;
+                                    name: string;
+                                };
+                                sizeBytes: number;
+                                /** @enum {string} */
+                                status: "uploaded" | "active" | "superseded";
+                                versionNumber: number;
+                            };
+                        };
+                    };
+                };
+                /** @description Invalid input */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Unauthorized */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Insufficient permissions */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Internal server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/apps/{id}/versions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List an app's versions
+         * @description List all versions of an app, newest first.
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Versions */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            data: {
+                                appId: string;
+                                bundleHash: string;
+                                createdAt: string;
+                                createdBy: string;
+                                fileCount: number;
+                                id: string;
+                                manifest: {
+                                    /** @enum {string} */
+                                    auth: "none" | "optional" | "required";
+                                    capabilities: {
+                                        agents: string[];
+                                        flows: string[];
+                                    };
+                                    data: {
+                                        /** @enum {string} */
+                                        access: "read" | "read-write";
+                                        namespace: string;
+                                    }[];
+                                    description?: string;
+                                    name: string;
+                                };
+                                sizeBytes: number;
+                                /** @enum {string} */
+                                status: "uploaded" | "active" | "superseded";
+                                versionNumber: number;
+                            }[];
+                        };
+                    };
+                };
+                /** @description Invalid id */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Unauthorized */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Insufficient permissions */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+            };
+        };
+        put?: never;
+        /**
+         * Upload an app version
+         * @description Upload a zip bundle as a new version. The bundle must contain index.html and runtype.app.json at the root. Uploading does not change what is served; call activate to deploy.
+         */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    id: string;
+                };
+                cookie?: never;
+            };
+            /** @description The app bundle as a zip archive. */
+            requestBody: {
+                content: {
+                    "application/zip": string;
+                };
+            };
+            responses: {
+                /** @description Version uploaded */
+                201: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            appId: string;
+                            bundleHash: string;
+                            createdAt: string;
+                            createdBy: string;
+                            fileCount: number;
+                            id: string;
+                            manifest: {
+                                /** @enum {string} */
+                                auth: "none" | "optional" | "required";
+                                capabilities: {
+                                    agents: string[];
+                                    flows: string[];
+                                };
+                                data: {
+                                    /** @enum {string} */
+                                    access: "read" | "read-write";
+                                    namespace: string;
+                                }[];
+                                description?: string;
+                                name: string;
+                            };
+                            sizeBytes: number;
+                            /** @enum {string} */
+                            status: "uploaded" | "active" | "superseded";
+                            versionNumber: number;
+                        };
+                    };
+                };
+                /** @description Invalid bundle */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Unauthorized */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Plan limit reached */
+                402: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Insufficient permissions */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Manifest uses reserved features */
+                422: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description Internal server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+                /** @description App storage not configured */
+                503: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["Error"];
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/assets/preview/{orgId}/{assetId}": {
         parameters: {
             query?: never;
@@ -3428,7 +4248,7 @@ interface paths {
         };
         /**
          * Get current user info
-         * @description Get the current user and organization info from the Clerk session.
+         * @description Get the current user and organization info for the authenticated caller (Clerk session or API key).
          */
         get: {
             parameters: {
@@ -39355,6 +40175,12 @@ interface LocalToolExecutionLoopSnapshot {
 }
 interface ExecuteWithLocalToolsOptions {
     onLocalToolResult?: (snapshot: LocalToolExecutionLoopSnapshot) => AgentCompleteEvent | null | undefined;
+    /**
+     * Polled after each local tool execution. Returning true ends the session
+     * early (synthetic `agent_complete`) so queued user steering can be
+     * delivered at the next session boundary instead of after the full session.
+     */
+    shouldInterrupt?: () => boolean;
 }
 /**
  * Status of a long-task agent run
@@ -39610,6 +40436,20 @@ interface RunTaskOptions {
     workflow?: WorkflowDefinition;
     /** IDs of built-in tools to enable for the agent (e.g., "exa", "firecrawl", "dalle") */
     toolIds?: string[];
+    /**
+     * Mid-run steering queue: called at every session boundary; returned
+     * messages are DRAINED and injected as user steering at the start of the
+     * next session's context. Pair with `hasQueuedUserMessages` to also end
+     * in-flight sessions early at the next local-tool pause.
+     */
+    getQueuedUserMessages?: () => string[] | undefined;
+    /**
+     * Non-draining peek at the steering queue. When it returns true after a
+     * local tool executes, the current session ends early (synthetic
+     * `agent_complete`) so the queued steering is delivered within seconds
+     * instead of after the session completes.
+     */
+    hasQueuedUserMessages?: () => boolean;
 }
 /**
  * Final result returned by `agents.runTask()`