oz-agent-sdk 1.0.0-alpha.10

package/resources/agent/runs.d.mts

@@ -0,0 +1,412 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as AgentAPI from "./agent.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Runs extends APIResource {
+    /**
+     * Retrieve detailed information about a specific agent run, including the full
+     * prompt, session link, and resolved configuration.
+     *
+     * @example
+     * ```ts
+     * const runItem = await client.agent.runs.retrieve('runId');
+     * ```
+     */
+    retrieve(runID: string, options?: RequestOptions): APIPromise<RunItem>;
+    /**
+     * Retrieve a paginated list of agent runs with optional filtering. Results are
+     * ordered by creation time (newest first).
+     *
+     * @example
+     * ```ts
+     * const runs = await client.agent.runs.list();
+     * ```
+     */
+    list(query?: RunListParams | null | undefined, options?: RequestOptions): APIPromise<RunListResponse>;
+    /**
+     * Cancel an agent run that is currently queued or in progress. Once cancelled, the
+     * run will transition to a failed state.
+     *
+     * @example
+     * ```ts
+     * const response = await client.agent.runs.cancel('runId');
+     * ```
+     */
+    cancel(runID: string, options?: RequestOptions): APIPromise<string>;
+}
+export type ArtifactItem = ArtifactItem.PlanArtifact | ArtifactItem.PullRequestArtifact | ArtifactItem.ScreenshotArtifact;
+export declare namespace ArtifactItem {
+    interface PlanArtifact {
+        /**
+         * Type of the artifact
+         */
+        artifact_type: 'PLAN';
+        /**
+         * Timestamp when the artifact was created (RFC3339)
+         */
+        created_at: string;
+        data: PlanArtifact.Data;
+    }
+    namespace PlanArtifact {
+        interface Data {
+            /**
+             * Unique identifier for the plan document
+             */
+            document_uid: string;
+            /**
+             * Unique identifier for the associated notebook
+             */
+            notebook_uid?: string;
+            /**
+             * Title of the plan
+             */
+            title?: string;
+        }
+    }
+    interface PullRequestArtifact {
+        /**
+         * Type of the artifact
+         */
+        artifact_type: 'PULL_REQUEST';
+        /**
+         * Timestamp when the artifact was created (RFC3339)
+         */
+        created_at: string;
+        data: PullRequestArtifact.Data;
+    }
+    namespace PullRequestArtifact {
+        interface Data {
+            /**
+             * Branch name for the pull request
+             */
+            branch: string;
+            /**
+             * URL of the pull request
+             */
+            url: string;
+        }
+    }
+    interface ScreenshotArtifact {
+        /**
+         * Type of the artifact
+         */
+        artifact_type: 'SCREENSHOT';
+        /**
+         * Timestamp when the artifact was created (RFC3339)
+         */
+        created_at: string;
+        data: ScreenshotArtifact.Data;
+    }
+    namespace ScreenshotArtifact {
+        interface Data {
+            /**
+             * Unique identifier for the screenshot artifact
+             */
+            artifact_uid: string;
+            /**
+             * MIME type of the screenshot image
+             */
+            mime_type: string;
+            /**
+             * Optional description of the screenshot
+             */
+            description?: string;
+        }
+    }
+}
+export interface RunItem {
+    /**
+     * Timestamp when the run was created (RFC3339)
+     */
+    created_at: string;
+    /**
+     * The prompt/instruction for the agent
+     */
+    prompt: string;
+    /**
+     * Unique identifier for the 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
+     * - BLOCKED: Run is blocked (e.g., awaiting user input or approval)
+     * - ERROR: Run encountered an error
+     * - CANCELLED: Run was cancelled by user
+     */
+    state: RunState;
+    /**
+     * @deprecated Use run_id instead.
+     */
+    task_id: string;
+    /**
+     * Human-readable title for the run
+     */
+    title: string;
+    /**
+     * Timestamp when the run was last updated (RFC3339)
+     */
+    updated_at: string;
+    /**
+     * Configuration for a cloud agent run
+     */
+    agent_config?: AgentAPI.AmbientAgentConfig;
+    /**
+     * Information about the agent skill used for the run. Either full_path or
+     * bundled_skill_id will be set, but not both.
+     */
+    agent_skill?: RunItem.AgentSkill;
+    /**
+     * Artifacts created during the run (plans, pull requests, etc.)
+     */
+    artifacts?: Array<ArtifactItem>;
+    /**
+     * UUID of the conversation associated with the run
+     */
+    conversation_id?: string;
+    creator?: AgentAPI.UserProfile;
+    /**
+     * Whether the sandbox environment is currently running
+     */
+    is_sandbox_running?: boolean;
+    /**
+     * Resource usage information for the run
+     */
+    request_usage?: RunItem.RequestUsage;
+    /**
+     * Information about the schedule that triggered this run (only present for
+     * scheduled runs)
+     */
+    schedule?: RunItem.Schedule;
+    /**
+     * Ownership scope for a resource (team or personal)
+     */
+    scope?: RunItem.Scope;
+    /**
+     * UUID of the shared session (if available)
+     */
+    session_id?: string;
+    /**
+     * URL to view the agent session
+     */
+    session_link?: string;
+    /**
+     * Source that created the run:
+     *
+     * - LINEAR: Created from Linear integration
+     * - API: Created via the Warp API
+     * - SLACK: Created from Slack integration
+     * - LOCAL: Created from local CLI/app
+     * - SCHEDULED_AGENT: Created by a scheduled agent
+     * - WEB_APP: Created from the Warp web app
+     * - GITHUB_ACTION: Created from a GitHub action
+     * - CLOUD_MODE: Created from a Cloud Mode
+     * - CLI: Created from the CLI
+     */
+    source?: RunSourceType;
+    /**
+     * Timestamp when the agent started working on the run (RFC3339)
+     */
+    started_at?: string | null;
+    status_message?: RunItem.StatusMessage;
+}
+export declare namespace RunItem {
+    /**
+     * Information about the agent skill used for the run. Either full_path or
+     * bundled_skill_id will be set, but not both.
+     */
+    interface AgentSkill {
+        /**
+         * Unique identifier for bundled skills
+         */
+        bundled_skill_id?: string;
+        /**
+         * Description of the skill
+         */
+        description?: string;
+        /**
+         * Path to the SKILL.md file (for file-based skills)
+         */
+        full_path?: string;
+        /**
+         * Human-readable name of the skill
+         */
+        name?: string;
+    }
+    /**
+     * Resource usage information for the run
+     */
+    interface RequestUsage {
+        /**
+         * Cost of compute resources for the run
+         */
+        compute_cost?: number;
+        /**
+         * Cost of LLM inference for the run
+         */
+        inference_cost?: number;
+    }
+    /**
+     * Information about the schedule that triggered this run (only present for
+     * scheduled runs)
+     */
+    interface Schedule {
+        /**
+         * Cron expression at the time the run was created
+         */
+        cron_schedule: string;
+        /**
+         * Unique identifier for the schedule
+         */
+        schedule_id: string;
+        /**
+         * Name of the schedule at the time the run was created
+         */
+        schedule_name: string;
+    }
+    /**
+     * Ownership scope for a resource (team or personal)
+     */
+    interface Scope {
+        /**
+         * Type of ownership ("User" for personal, "Team" for team-owned)
+         */
+        type: 'User' | 'Team';
+        /**
+         * UID of the owning user or team
+         */
+        uid?: string;
+    }
+    interface StatusMessage {
+        /**
+         * Human-readable status message
+         */
+        message?: string;
+    }
+}
+/**
+ * Source that created the run:
+ *
+ * - LINEAR: Created from Linear integration
+ * - API: Created via the Warp API
+ * - SLACK: Created from Slack integration
+ * - LOCAL: Created from local CLI/app
+ * - SCHEDULED_AGENT: Created by a scheduled agent
+ * - WEB_APP: Created from the Warp web app
+ * - GITHUB_ACTION: Created from a GitHub action
+ * - CLOUD_MODE: Created from a Cloud Mode
+ * - CLI: Created from the CLI
+ */
+export type RunSourceType = 'LINEAR' | 'API' | 'SLACK' | 'LOCAL' | 'SCHEDULED_AGENT' | 'WEB_APP' | 'GITHUB_ACTION' | 'CLOUD_MODE' | 'CLI';
+/**
+ * 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
+ * - BLOCKED: Run is blocked (e.g., awaiting user input or approval)
+ * - ERROR: Run encountered an error
+ * - CANCELLED: Run was cancelled by user
+ */
+export type RunState = 'QUEUED' | 'PENDING' | 'CLAIMED' | 'INPROGRESS' | 'SUCCEEDED' | 'FAILED' | 'BLOCKED' | 'ERROR' | 'CANCELLED';
+export interface RunListResponse {
+    page_info: RunListResponse.PageInfo;
+    runs: Array<RunItem>;
+}
+export declare namespace RunListResponse {
+    interface PageInfo {
+        /**
+         * Whether there are more results available
+         */
+        has_next_page: boolean;
+        /**
+         * Opaque cursor for fetching the next page
+         */
+        next_cursor?: string;
+    }
+}
+/**
+ * The ID of the cancelled run
+ */
+export type RunCancelResponse = string;
+export interface RunListParams {
+    /**
+     * Filter runs by artifact type (PLAN or PULL_REQUEST)
+     */
+    artifact_type?: 'PLAN' | 'PULL_REQUEST' | 'SCREENSHOT';
+    /**
+     * Filter runs created after this timestamp (RFC3339 format)
+     */
+    created_after?: string;
+    /**
+     * Filter runs created before this timestamp (RFC3339 format)
+     */
+    created_before?: string;
+    /**
+     * Filter by creator UID (user or service account)
+     */
+    creator?: string;
+    /**
+     * Pagination cursor from previous response
+     */
+    cursor?: string;
+    /**
+     * Filter runs by environment ID
+     */
+    environment_id?: string;
+    /**
+     * Maximum number of runs to return
+     */
+    limit?: number;
+    /**
+     * Filter by model ID
+     */
+    model_id?: string;
+    /**
+     * Filter by agent config name
+     */
+    name?: string;
+    /**
+     * Fuzzy search query across run title, prompt, and skill_spec
+     */
+    q?: string;
+    /**
+     * Filter runs by the scheduled agent ID that created them
+     */
+    schedule_id?: string;
+    /**
+     * Filter runs by skill spec (e.g., "owner/repo:path/to/SKILL.md"). Alias for
+     * skill_spec.
+     */
+    skill?: string;
+    /**
+     * Filter runs by skill spec (e.g., "owner/repo:path/to/SKILL.md")
+     */
+    skill_spec?: string;
+    /**
+     * Filter by run source type
+     */
+    source?: RunSourceType;
+    /**
+     * Filter by run state. Can be specified multiple times to match any of the given
+     * states.
+     */
+    state?: Array<RunState>;
+    /**
+     * Filter runs updated after this timestamp (RFC3339 format)
+     */
+    updated_after?: string;
+}
+export declare namespace Runs {
+    export { 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, };
+}
+//# sourceMappingURL=runs.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"runs.d.mts","sourceRoot":"","sources":["../../src/resources/agent/runs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;OAQG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAItE;;;;;;;;OAQG;IACH,IAAI,CAAC,KAAK,GAAE,aAAa,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIzG;;;;;;;;OAQG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;CAGpE;AAED,MAAM,MAAM,YAAY,GACpB,YAAY,CAAC,YAAY,GACzB,YAAY,CAAC,mBAAmB,GAChC,YAAY,CAAC,kBAAkB,CAAC;AAEpC,yBAAiB,YAAY,CAAC;IAC5B,UAAiB,YAAY;QAC3B;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC;KACzB;IAED,UAAiB,YAAY,CAAC;QAC5B,UAAiB,IAAI;YACnB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YAEtB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;SAChB;KACF;IAED,UAAiB,mBAAmB;QAClC;;WAEG;QACH,aAAa,EAAE,cAAc,CAAC;QAE9B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;KAChC;IAED,UAAiB,mBAAmB,CAAC;QACnC,UAAiB,IAAI;YACnB;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;IAED,UAAiB,kBAAkB;QACjC;;WAEG;QACH,aAAa,EAAE,YAAY,CAAC;QAE5B;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;KAC/B;IAED,UAAiB,kBAAkB,CAAC;QAClC,UAAiB,IAAI;YACnB;;eAEG;YACH,YAAY,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,SAAS,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;KACF;CACF;AAED,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;OAYG;IACH,KAAK,EAAE,QAAQ,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC,kBAAkB,CAAC;IAE3C;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC;IAEjC;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAEhC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,OAAO,CAAC,EAAE,QAAQ,CAAC,WAAW,CAAC;IAE/B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,cAAc,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC;CACxC;AAED,yBAAiB,OAAO,CAAC;IACvB;;;OAGG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB;IAED;;;OAGG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,aAAa,EAAE,MAAM,CAAC;KACvB;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;QAEtB;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,aAAa;QAC5B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,aAAa,GACrB,QAAQ,GACR,KAAK,GACL,OAAO,GACP,OAAO,GACP,iBAAiB,GACjB,SAAS,GACT,eAAe,GACf,YAAY,GACZ,KAAK,CAAC;AAEV;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,QAAQ,GAChB,QAAQ,GACR,SAAS,GACT,SAAS,GACT,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,SAAS,GACT,OAAO,GACP,WAAW,CAAC;AAEhB,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,eAAe,CAAC,QAAQ,CAAC;IAEpC,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;CACtB;AAED,yBAAiB,eAAe,CAAC;IAC/B,UAAiB,QAAQ;QACvB;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AAEvC,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,cAAc,GAAG,YAAY,CAAC;IAEvD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IAEvB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,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;CACH"}