oz-agent-sdk 1.0.0-alpha.7

package/resources/agent/agent.d.mts

@@ -0,0 +1,336 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as RunsAPI from "./runs.mjs";
+import { ArtifactItem, RunCancelResponse, RunItem, RunListParams, RunListResponse, RunSourceType, RunState, Runs } from "./runs.mjs";
+import * as SchedulesAPI from "./schedules.mjs";
+import { ScheduleCreateParams, ScheduleDeleteResponse, ScheduleListResponse, ScheduleUpdateParams, ScheduledAgentItem, Schedules } from "./schedules.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Agent extends APIResource {
+    runs: RunsAPI.Runs;
+    schedules: SchedulesAPI.Schedules;
+    /**
+     * Retrieve a list of available agents (skills) that can be used to run tasks.
+     * Agents are discovered from environments or a specific repository.
+     *
+     * @example
+     * ```ts
+     * const agents = await client.agent.list();
+     * ```
+     */
+    list(query?: AgentListParams | null | undefined, options?: RequestOptions): APIPromise<AgentListResponse>;
+    /**
+     * Spawn an cloud agent with a prompt and optional configuration. The agent will be
+     * queued for execution and assigned a unique run ID.
+     *
+     * @example
+     * ```ts
+     * const response = await client.agent.run({
+     *   prompt: 'Fix the bug in auth.go',
+     * });
+     * ```
+     */
+    run(body: AgentRunParams, options?: RequestOptions): APIPromise<AgentRunResponse>;
+}
+export interface AgentSkill {
+    /**
+     * Human-readable name of the agent
+     */
+    name: string;
+    /**
+     * Available variants of this agent
+     */
+    variants: Array<AgentSkill.Variant>;
+}
+export declare namespace AgentSkill {
+    interface Variant {
+        /**
+         * Stable identifier for this skill variant. Format: "{owner}/{repo}:{skill_path}"
+         * Example: "warpdotdev/warp-server:.claude/skills/deploy/SKILL.md"
+         */
+        id: string;
+        /**
+         * Base prompt/instructions for the agent
+         */
+        base_prompt: string;
+        /**
+         * Description of the agent variant
+         */
+        description: string;
+        /**
+         * Environments where this agent variant is available
+         */
+        environments: Array<Variant.Environment>;
+        source: Variant.Source;
+        /**
+         * Timestamp of the last time this skill was run (RFC3339)
+         */
+        last_run_timestamp?: string | null;
+    }
+    namespace Variant {
+        interface Environment {
+            /**
+             * Human-readable name of the environment
+             */
+            name: string;
+            /**
+             * Unique identifier for the environment
+             */
+            uid: string;
+        }
+        interface Source {
+            /**
+             * GitHub repository name
+             */
+            name: string;
+            /**
+             * GitHub repository owner
+             */
+            owner: string;
+            /**
+             * Path to the skill definition file within the repository
+             */
+            skill_path: string;
+        }
+    }
+}
+/**
+ * Configuration for an cloud agent run
+ */
+export interface AmbientAgentConfig {
+    /**
+     * Custom base prompt for the agent
+     */
+    base_prompt?: string;
+    /**
+     * Controls whether computer use is enabled for this agent. If not set, defaults to
+     * false.
+     */
+    computer_use_enabled?: boolean;
+    /**
+     * UID of the environment to run the agent in
+     */
+    environment_id?: string;
+    /**
+     * Map of MCP server configurations by name
+     */
+    mcp_servers?: {
+        [key: string]: McpServerConfig;
+    };
+    /**
+     * LLM model to use (uses team default if not specified)
+     */
+    model_id?: string;
+    /**
+     * Config name for searchability and traceability
+     */
+    name?: string;
+    /**
+     * Skill specification identifying which agent skill to use. Format:
+     * "{owner}/{repo}:{skill_path}" Example:
+     * "warpdotdev/warp-server:.claude/skills/deploy/SKILL.md" Use the list agents
+     * endpoint to discover available skills.
+     */
+    skill_spec?: string;
+    /**
+     * Self-hosted worker ID that should execute this task. If not specified or set to
+     * "warp", the task runs on Warp-hosted workers.
+     */
+    worker_host?: string;
+}
+/**
+ * Configuration for a cloud environment used by scheduled agents
+ */
+export interface CloudEnvironmentConfig {
+    /**
+     * Optional description of the environment
+     */
+    description?: string | null;
+    /**
+     * Docker image to use (e.g., "ubuntu:latest" or "registry/repo:tag")
+     */
+    docker_image?: string;
+    /**
+     * List of GitHub repositories to clone into the environment
+     */
+    github_repos?: Array<CloudEnvironmentConfig.GitHubRepo>;
+    /**
+     * Human-readable name for the environment
+     */
+    name?: string;
+    /**
+     * Shell commands to run during environment setup
+     */
+    setup_commands?: Array<string>;
+}
+export declare namespace CloudEnvironmentConfig {
+    interface GitHubRepo {
+        /**
+         * GitHub repository owner (user or organization)
+         */
+        owner: string;
+        /**
+         * GitHub repository name
+         */
+        repo: string;
+    }
+}
+/**
+ * Configuration for an MCP server. Must have exactly one of: warp_id, command, or
+ * url.
+ */
+export interface McpServerConfig {
+    /**
+     * Stdio transport - command arguments
+     */
+    args?: Array<string>;
+    /**
+     * Stdio transport - command to run
+     */
+    command?: string;
+    /**
+     * Environment variables for the server
+     */
+    env?: {
+        [key: string]: string;
+    };
+    /**
+     * HTTP headers for SSE/HTTP transport
+     */
+    headers?: {
+        [key: string]: string;
+    };
+    /**
+     * SSE/HTTP transport - server URL
+     */
+    url?: string;
+    /**
+     * Reference to a Warp shared MCP server by UUID
+     */
+    warp_id?: string;
+}
+export interface UserProfile {
+    /**
+     * Display name of the creator
+     */
+    display_name?: string;
+    /**
+     * URL to the creator's photo
+     */
+    photo_url?: string;
+    /**
+     * Type of the creator principal
+     */
+    type?: 'user' | 'service_account';
+    /**
+     * Unique identifier of the creator
+     */
+    uid?: string;
+}
+export interface AgentListResponse {
+    /**
+     * List of available agents
+     */
+    agents: Array<AgentSkill>;
+}
+export interface AgentRunResponse {
+    /**
+     * Unique identifier for the created run
+     */
+    run_id: string;
+    /**
+     * Current state of the run:
+     *
+     * - QUEUED: Run is waiting to be picked up
+     * - PENDING: Run is being prepared
+     * - CLAIMED: Run has been claimed by a worker
+     * - INPROGRESS: Run is actively being executed
+     * - SUCCEEDED: Run completed successfully
+     * - FAILED: Run failed
+     * - CANCELLED: Run was cancelled by user
+     */
+    state: RunsAPI.RunState;
+    /**
+     * @deprecated Use run_id instead.
+     */
+    task_id: string;
+}
+export interface AgentListParams {
+    /**
+     * When true, clears the agent list cache before fetching. Use this to force a
+     * refresh of the available agents.
+     */
+    refresh?: boolean;
+    /**
+     * Optional repository specification to list agents from (format: "owner/repo"). If
+     * not provided, lists agents from all accessible environments.
+     */
+    repo?: string;
+    /**
+     * Sort order for the returned agents.
+     *
+     * - "name": Sort alphabetically by name (default)
+     * - "last_run": Sort by most recently used
+     */
+    sort_by?: 'name' | 'last_run';
+}
+export interface AgentRunParams {
+    /**
+     * Configuration for an cloud agent run
+     */
+    config?: AmbientAgentConfig;
+    /**
+     * Optional conversation ID to continue an existing conversation. If provided, the
+     * agent will continue from where the previous run left off.
+     */
+    conversation_id?: string;
+    /**
+     * Optional images to include with the prompt (max 5). Images are uploaded to cloud
+     * storage and made available to the agent.
+     */
+    images?: Array<AgentRunParams.Image>;
+    /**
+     * The prompt/instruction for the agent to execute. Required unless a skill is
+     * specified via the skill field or config.skill_spec.
+     */
+    prompt?: string;
+    /**
+     * Skill specification to use as the base prompt for the agent. Supported formats:
+     *
+     * - "repo:skill_name" - Simple name in specific repo
+     * - "repo:skill_path" - Full path in specific repo
+     * - "org/repo:skill_name" - Simple name with org and repo
+     * - "org/repo:skill_path" - Full path with org and repo When provided, this takes
+     *   precedence over config.skill_spec.
+     */
+    skill?: string;
+    /**
+     * Whether to create a team-owned run. Defaults to true for users on a single team.
+     */
+    team?: boolean;
+    /**
+     * Custom title for the run (auto-generated if not provided)
+     */
+    title?: string;
+}
+export declare namespace AgentRunParams {
+    /**
+     * A base64-encoded image to include with the prompt
+     */
+    interface Image {
+        /**
+         * Base64-encoded image data
+         */
+        data: string;
+        /**
+         * MIME type of the image. Supported types: image/jpeg, image/png, image/gif,
+         * image/webp
+         */
+        mime_type: 'image/jpeg' | 'image/png' | 'image/gif' | 'image/webp';
+    }
+}
+export declare namespace Agent {
+    export { type AgentSkill as AgentSkill, type AmbientAgentConfig as AmbientAgentConfig, type CloudEnvironmentConfig as CloudEnvironmentConfig, type McpServerConfig as McpServerConfig, type UserProfile as UserProfile, type AgentListResponse as AgentListResponse, type AgentRunResponse as AgentRunResponse, type AgentListParams as AgentListParams, type AgentRunParams as AgentRunParams, };
+    export { Runs as Runs, type ArtifactItem as ArtifactItem, type RunItem as RunItem, type RunSourceType as RunSourceType, type RunState as RunState, type RunListResponse as RunListResponse, type RunCancelResponse as RunCancelResponse, type RunListParams as RunListParams, };
+    export { Schedules as Schedules, type ScheduledAgentItem as ScheduledAgentItem, type ScheduleListResponse as ScheduleListResponse, type ScheduleDeleteResponse as ScheduleDeleteResponse, type ScheduleCreateParams as ScheduleCreateParams, type ScheduleUpdateParams as ScheduleUpdateParams, };
+}
+//# sourceMappingURL=agent.d.mts.map

package/resources/agent/agent.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent.d.mts","sourceRoot":"","sources":["../../src/resources/agent/agent.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,EACL,YAAY,EACZ,iBAAiB,EACjB,OAAO,EACP,aAAa,EACb,eAAe,EACf,aAAa,EACb,QAAQ,EACR,IAAI,EACL;OACM,KAAK,YAAY;OACjB,EACL,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,SAAS,EACV;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IACpD,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAE7E;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;;;OAUG;IACH,GAAG,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;CAGlF;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;CACrC;AAED,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,OAAO;QACtB;;;WAGG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAEzC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC;QAEvB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACpC;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,WAAW;YAC1B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;QAED,UAAiB,MAAM;YACrB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAA;KAAE,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAExD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,UAAU;QACzB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,GAAG,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC;IAElC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;OAUG;IACH,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;CAC/B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAE5B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAErC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,SAAS,EAAE,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,YAAY,CAAC;KACpE;CACF;AAKD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/agent/agent.d.ts

@@ -0,0 +1,336 @@
+import { APIResource } from "../../core/resource.js";
+import * as RunsAPI from "./runs.js";
+import { ArtifactItem, RunCancelResponse, RunItem, RunListParams, RunListResponse, RunSourceType, RunState, Runs } from "./runs.js";
+import * as SchedulesAPI from "./schedules.js";
+import { ScheduleCreateParams, ScheduleDeleteResponse, ScheduleListResponse, ScheduleUpdateParams, ScheduledAgentItem, Schedules } from "./schedules.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Agent extends APIResource {
+    runs: RunsAPI.Runs;
+    schedules: SchedulesAPI.Schedules;
+    /**
+     * Retrieve a list of available agents (skills) that can be used to run tasks.
+     * Agents are discovered from environments or a specific repository.
+     *
+     * @example
+     * ```ts
+     * const agents = await client.agent.list();
+     * ```
+     */
+    list(query?: AgentListParams | null | undefined, options?: RequestOptions): APIPromise<AgentListResponse>;
+    /**
+     * Spawn an cloud agent with a prompt and optional configuration. The agent will be
+     * queued for execution and assigned a unique run ID.
+     *
+     * @example
+     * ```ts
+     * const response = await client.agent.run({
+     *   prompt: 'Fix the bug in auth.go',
+     * });
+     * ```
+     */
+    run(body: AgentRunParams, options?: RequestOptions): APIPromise<AgentRunResponse>;
+}
+export interface AgentSkill {
+    /**
+     * Human-readable name of the agent
+     */
+    name: string;
+    /**
+     * Available variants of this agent
+     */
+    variants: Array<AgentSkill.Variant>;
+}
+export declare namespace AgentSkill {
+    interface Variant {
+        /**
+         * Stable identifier for this skill variant. Format: "{owner}/{repo}:{skill_path}"
+         * Example: "warpdotdev/warp-server:.claude/skills/deploy/SKILL.md"
+         */
+        id: string;
+        /**
+         * Base prompt/instructions for the agent
+         */
+        base_prompt: string;
+        /**
+         * Description of the agent variant
+         */
+        description: string;
+        /**
+         * Environments where this agent variant is available
+         */
+        environments: Array<Variant.Environment>;
+        source: Variant.Source;
+        /**
+         * Timestamp of the last time this skill was run (RFC3339)
+         */
+        last_run_timestamp?: string | null;
+    }
+    namespace Variant {
+        interface Environment {
+            /**
+             * Human-readable name of the environment
+             */
+            name: string;
+            /**
+             * Unique identifier for the environment
+             */
+            uid: string;
+        }
+        interface Source {
+            /**
+             * GitHub repository name
+             */
+            name: string;
+            /**
+             * GitHub repository owner
+             */
+            owner: string;
+            /**
+             * Path to the skill definition file within the repository
+             */
+            skill_path: string;
+        }
+    }
+}
+/**
+ * Configuration for an cloud agent run
+ */
+export interface AmbientAgentConfig {
+    /**
+     * Custom base prompt for the agent
+     */
+    base_prompt?: string;
+    /**
+     * Controls whether computer use is enabled for this agent. If not set, defaults to
+     * false.
+     */
+    computer_use_enabled?: boolean;
+    /**
+     * UID of the environment to run the agent in
+     */
+    environment_id?: string;
+    /**
+     * Map of MCP server configurations by name
+     */
+    mcp_servers?: {
+        [key: string]: McpServerConfig;
+    };
+    /**
+     * LLM model to use (uses team default if not specified)
+     */
+    model_id?: string;
+    /**
+     * Config name for searchability and traceability
+     */
+    name?: string;
+    /**
+     * Skill specification identifying which agent skill to use. Format:
+     * "{owner}/{repo}:{skill_path}" Example:
+     * "warpdotdev/warp-server:.claude/skills/deploy/SKILL.md" Use the list agents
+     * endpoint to discover available skills.
+     */
+    skill_spec?: string;
+    /**
+     * Self-hosted worker ID that should execute this task. If not specified or set to
+     * "warp", the task runs on Warp-hosted workers.
+     */
+    worker_host?: string;
+}
+/**
+ * Configuration for a cloud environment used by scheduled agents
+ */
+export interface CloudEnvironmentConfig {
+    /**
+     * Optional description of the environment
+     */
+    description?: string | null;
+    /**
+     * Docker image to use (e.g., "ubuntu:latest" or "registry/repo:tag")
+     */
+    docker_image?: string;
+    /**
+     * List of GitHub repositories to clone into the environment
+     */
+    github_repos?: Array<CloudEnvironmentConfig.GitHubRepo>;
+    /**
+     * Human-readable name for the environment
+     */
+    name?: string;
+    /**
+     * Shell commands to run during environment setup
+     */
+    setup_commands?: Array<string>;
+}
+export declare namespace CloudEnvironmentConfig {
+    interface GitHubRepo {
+        /**
+         * GitHub repository owner (user or organization)
+         */
+        owner: string;
+        /**
+         * GitHub repository name
+         */
+        repo: string;
+    }
+}
+/**
+ * Configuration for an MCP server. Must have exactly one of: warp_id, command, or
+ * url.
+ */
+export interface McpServerConfig {
+    /**
+     * Stdio transport - command arguments
+     */
+    args?: Array<string>;
+    /**
+     * Stdio transport - command to run
+     */
+    command?: string;
+    /**
+     * Environment variables for the server
+     */
+    env?: {
+        [key: string]: string;
+    };
+    /**
+     * HTTP headers for SSE/HTTP transport
+     */
+    headers?: {
+        [key: string]: string;
+    };
+    /**
+     * SSE/HTTP transport - server URL
+     */
+    url?: string;
+    /**
+     * Reference to a Warp shared MCP server by UUID
+     */
+    warp_id?: string;
+}
+export interface UserProfile {
+    /**
+     * Display name of the creator
+     */
+    display_name?: string;
+    /**
+     * URL to the creator's photo
+     */
+    photo_url?: string;
+    /**
+     * Type of the creator principal
+     */
+    type?: 'user' | 'service_account';
+    /**
+     * Unique identifier of the creator
+     */
+    uid?: string;
+}
+export interface AgentListResponse {
+    /**
+     * List of available agents
+     */
+    agents: Array<AgentSkill>;
+}
+export interface AgentRunResponse {
+    /**
+     * Unique identifier for the created run
+     */
+    run_id: string;
+    /**
+     * Current state of the run:
+     *
+     * - QUEUED: Run is waiting to be picked up
+     * - PENDING: Run is being prepared
+     * - CLAIMED: Run has been claimed by a worker
+     * - INPROGRESS: Run is actively being executed
+     * - SUCCEEDED: Run completed successfully
+     * - FAILED: Run failed
+     * - CANCELLED: Run was cancelled by user
+     */
+    state: RunsAPI.RunState;
+    /**
+     * @deprecated Use run_id instead.
+     */
+    task_id: string;
+}
+export interface AgentListParams {
+    /**
+     * When true, clears the agent list cache before fetching. Use this to force a
+     * refresh of the available agents.
+     */
+    refresh?: boolean;
+    /**
+     * Optional repository specification to list agents from (format: "owner/repo"). If
+     * not provided, lists agents from all accessible environments.
+     */
+    repo?: string;
+    /**
+     * Sort order for the returned agents.
+     *
+     * - "name": Sort alphabetically by name (default)
+     * - "last_run": Sort by most recently used
+     */
+    sort_by?: 'name' | 'last_run';
+}
+export interface AgentRunParams {
+    /**
+     * Configuration for an cloud agent run
+     */
+    config?: AmbientAgentConfig;
+    /**
+     * Optional conversation ID to continue an existing conversation. If provided, the
+     * agent will continue from where the previous run left off.
+     */
+    conversation_id?: string;
+    /**
+     * Optional images to include with the prompt (max 5). Images are uploaded to cloud
+     * storage and made available to the agent.
+     */
+    images?: Array<AgentRunParams.Image>;
+    /**
+     * The prompt/instruction for the agent to execute. Required unless a skill is
+     * specified via the skill field or config.skill_spec.
+     */
+    prompt?: string;
+    /**
+     * Skill specification to use as the base prompt for the agent. Supported formats:
+     *
+     * - "repo:skill_name" - Simple name in specific repo
+     * - "repo:skill_path" - Full path in specific repo
+     * - "org/repo:skill_name" - Simple name with org and repo
+     * - "org/repo:skill_path" - Full path with org and repo When provided, this takes
+     *   precedence over config.skill_spec.
+     */
+    skill?: string;
+    /**
+     * Whether to create a team-owned run. Defaults to true for users on a single team.
+     */
+    team?: boolean;
+    /**
+     * Custom title for the run (auto-generated if not provided)
+     */
+    title?: string;
+}
+export declare namespace AgentRunParams {
+    /**
+     * A base64-encoded image to include with the prompt
+     */
+    interface Image {
+        /**
+         * Base64-encoded image data
+         */
+        data: string;
+        /**
+         * MIME type of the image. Supported types: image/jpeg, image/png, image/gif,
+         * image/webp
+         */
+        mime_type: 'image/jpeg' | 'image/png' | 'image/gif' | 'image/webp';
+    }
+}
+export declare namespace Agent {
+    export { type AgentSkill as AgentSkill, type AmbientAgentConfig as AmbientAgentConfig, type CloudEnvironmentConfig as CloudEnvironmentConfig, type McpServerConfig as McpServerConfig, type UserProfile as UserProfile, type AgentListResponse as AgentListResponse, type AgentRunResponse as AgentRunResponse, type AgentListParams as AgentListParams, type AgentRunParams as AgentRunParams, };
+    export { Runs as Runs, type ArtifactItem as ArtifactItem, type RunItem as RunItem, type RunSourceType as RunSourceType, type RunState as RunState, type RunListResponse as RunListResponse, type RunCancelResponse as RunCancelResponse, type RunListParams as RunListParams, };
+    export { Schedules as Schedules, type ScheduledAgentItem as ScheduledAgentItem, type ScheduleListResponse as ScheduleListResponse, type ScheduleDeleteResponse as ScheduleDeleteResponse, type ScheduleCreateParams as ScheduleCreateParams, type ScheduleUpdateParams as ScheduleUpdateParams, };
+}
+//# sourceMappingURL=agent.d.ts.map

package/resources/agent/agent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../../src/resources/agent/agent.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,EACL,YAAY,EACZ,iBAAiB,EACjB,OAAO,EACP,aAAa,EACb,eAAe,EACf,aAAa,EACb,QAAQ,EACR,IAAI,EACL;OACM,KAAK,YAAY;OACjB,EACL,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,SAAS,EACV;OACM,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IACpD,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAE7E;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;;;OAUG;IACH,GAAG,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;CAGlF;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;CACrC;AAED,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,OAAO;QACtB;;;WAGG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAEzC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC;QAEvB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACpC;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,WAAW;YAC1B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;QAED,UAAiB,MAAM;YACrB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAA;KAAE,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAExD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,UAAU;QACzB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,GAAG,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC;IAElC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;OAUG;IACH,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;CAC/B;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAE5B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAErC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,SAAS,EAAE,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,YAAY,CAAC;KACpE;CACF;AAKD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}