feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 14
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/warp-bnavetta%2Fwarp-api-8f9c749573846b07a55a3131b66456f0a592838c6bfc986ab30948df66cd6f11.yml
-openapi_spec_hash: 59f1ac98ad6cf13b12c59196bcecffd7
-config_hash: 60052b2c1c0862014416821aba875574
+configured_endpoints: 15
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/warp-bnavetta%2Fwarp-api-abde9a81e648a7bbddbb7c7af07eb9202e584f78dea9cc79ff075da2ad66efd5.yml
+openapi_spec_hash: db45809e85b0f85020a6b046c6eed90e
+config_hash: 253e4b5ca01236d448980a78491c17c5

api.md

@@ -5,6 +5,7 @@ Types:
 - <code><a href="./src/resources/agent/agent.ts">AgentSkill</a></code>
 - <code><a href="./src/resources/agent/agent.ts">AmbientAgentConfig</a></code>
 - <code><a href="./src/resources/agent/agent.ts">AwsProviderConfig</a></code>
+- <code><a href="./src/resources/agent/agent.ts">CloudEnvironment</a></code>
 - <code><a href="./src/resources/agent/agent.ts">CloudEnvironmentConfig</a></code>
 - <code><a href="./src/resources/agent/agent.ts">Error</a></code>
 - <code><a href="./src/resources/agent/agent.ts">ErrorCode</a></code>
@@ -14,12 +15,14 @@ Types:
 - <code><a href="./src/resources/agent/agent.ts">UserProfile</a></code>
 - <code><a href="./src/resources/agent/agent.ts">AgentListResponse</a></code>
 - <code><a href="./src/resources/agent/agent.ts">AgentGetArtifactResponse</a></code>
+- <code><a href="./src/resources/agent/agent.ts">AgentListEnvironmentsResponse</a></code>
 - <code><a href="./src/resources/agent/agent.ts">AgentRunResponse</a></code>
 
 Methods:
 
 - <code title="get /agent">client.agent.<a href="./src/resources/agent/agent.ts">list</a>({ ...params }) -> AgentListResponse</code>
 - <code title="get /agent/artifacts/{artifactUid}">client.agent.<a href="./src/resources/agent/agent.ts">getArtifact</a>(artifactUid) -> AgentGetArtifactResponse</code>
+- <code title="get /agent/environments">client.agent.<a href="./src/resources/agent/agent.ts">listEnvironments</a>({ ...params }) -> AgentListEnvironmentsResponse</code>
 - <code title="post /agent/runs">client.agent.<a href="./src/resources/agent/agent.ts">run</a>({ ...params }) -> AgentRunResponse</code>
 
 ## Runs

src/client.ts

@@ -22,13 +22,16 @@ import { APIPromise } from './core/api-promise';
 import {
   Agent,
   AgentGetArtifactResponse,
+  AgentListEnvironmentsParams,
+  AgentListEnvironmentsResponse,
   AgentListParams,
   AgentListResponse,
   AgentRunParams,
   AgentRunResponse,
   AgentSkill,
   AmbientAgentConfig,
   AwsProviderConfig,
+  CloudEnvironment,
   CloudEnvironmentConfig,
   Error,
   ErrorCode,
@@ -781,6 +784,7 @@ export declare namespace OzAPI {
     type AgentSkill as AgentSkill,
     type AmbientAgentConfig as AmbientAgentConfig,
     type AwsProviderConfig as AwsProviderConfig,
+    type CloudEnvironment as CloudEnvironment,
     type CloudEnvironmentConfig as CloudEnvironmentConfig,
     type Error as Error,
     type ErrorCode as ErrorCode,
@@ -790,8 +794,10 @@ export declare namespace OzAPI {
     type UserProfile as UserProfile,
     type AgentListResponse as AgentListResponse,
     type AgentGetArtifactResponse as AgentGetArtifactResponse,
+    type AgentListEnvironmentsResponse as AgentListEnvironmentsResponse,
     type AgentRunResponse as AgentRunResponse,
     type AgentListParams as AgentListParams,
+    type AgentListEnvironmentsParams as AgentListEnvironmentsParams,
     type AgentRunParams as AgentRunParams,
   };
 }

src/resources/agent/agent.ts

@@ -54,8 +54,9 @@ export class Agent extends APIResource {
   }
 
   /**
-   * Retrieve an artifact by its UUID. For supported downloadable artifacts, returns
-   * a time-limited signed download URL.
+   * Retrieve an artifact by its UUID. For downloadable file-like artifacts, returns
+   * a time-limited signed download URL. For plan artifacts, returns the current plan
+   * content inline.
    *
    * @example
    * ```ts
@@ -68,6 +69,23 @@ export class Agent extends APIResource {
     return this._client.get(path`/agent/artifacts/${artifactUid}`, options);
   }
 
+  /**
+   * Retrieve cloud environments accessible to the authenticated principal. Returns
+   * environments the caller owns, has been granted guest access to, or has accessed
+   * via link sharing.
+   *
+   * @example
+   * ```ts
+   * const response = await client.agent.listEnvironments();
+   * ```
+   */
+  listEnvironments(
+    query: AgentListEnvironmentsParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AgentListEnvironmentsResponse> {
+    return this._client.get('/agent/environments', { query, ...options });
+  }
+
   /**
    * Alias for POST /agent/run. This is the preferred endpoint for creating new agent
    * runs. Behavior is identical to POST /agent/run.
@@ -190,6 +208,12 @@ export interface AmbientAgentConfig {
    */
   harness?: AmbientAgentConfig.Harness;
 
+  /**
+   * Authentication secrets for third-party harnesses. Only the secret for the
+   * harness specified gets injected into the environment.
+   */
+  harness_auth_secrets?: AmbientAgentConfig.HarnessAuthSecrets;
+
   /**
    * Number of minutes to keep the agent environment alive after task completion. If
    * not set, defaults to 10 minutes. Maximum allowed value is min(60,
@@ -236,14 +260,6 @@ export namespace AmbientAgentConfig {
    * uses Warp's built-in harness.
    */
   export interface Harness {
-    /**
-     * Name of a managed secret to use as the authentication credential for the
-     * harness. The secret must exist within the caller's personal or team scope. The
-     * environment variable injected into the agent is determined by the secret type
-     * (e.g. ANTHROPIC_API_KEY for anthropic_api_key secrets).
-     */
-    auth_secret_name?: string;
-
     /**
      * The harness type identifier.
      *
@@ -252,6 +268,19 @@ export namespace AmbientAgentConfig {
      */
     type?: 'oz' | 'claude';
   }
+
+  /**
+   * Authentication secrets for third-party harnesses. Only the secret for the
+   * harness specified gets injected into the environment.
+   */
+  export interface HarnessAuthSecrets {
+    /**
+     * Name of a managed secret for Claude Code harness authentication. The secret must
+     * exist within the caller's personal or team scope. Only applicable when harness
+     * type is "claude".
+     */
+    claude_auth_secret_name?: string;
+  }
 }
 
 /**
@@ -264,6 +293,97 @@ export interface AwsProviderConfig {
   role_arn: string;
 }
 
+/**
+ * A cloud environment for running agents
+ */
+export interface CloudEnvironment {
+  /**
+   * Configuration for a cloud environment used by scheduled agents
+   */
+  config: CloudEnvironmentConfig;
+
+  /**
+   * Timestamp when the environment was last updated (RFC3339)
+   */
+  last_updated: string;
+
+  /**
+   * True when the most recent task failed during setup before it started running
+   */
+  setup_failed: boolean;
+
+  /**
+   * Unique identifier for the environment
+   */
+  uid: string;
+
+  creator?: UserProfile;
+
+  last_editor?: UserProfile;
+
+  /**
+   * Summary of the most recently created task for an environment
+   */
+  last_task_created?: CloudEnvironment.LastTaskCreated;
+
+  /**
+   * Timestamp of the most recent task run in this environment (RFC3339)
+   */
+  last_task_run_timestamp?: string | null;
+
+  /**
+   * Ownership scope for a resource (team or personal)
+   */
+  scope?: Scope;
+}
+
+export namespace CloudEnvironment {
+  /**
+   * Summary of the most recently created task for an environment
+   */
+  export interface LastTaskCreated {
+    /**
+     * Unique identifier of the task
+     */
+    id: string;
+
+    /**
+     * When the task was created (RFC3339)
+     */
+    created_at: 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: RunsAPI.RunState;
+
+    /**
+     * Title of the task
+     */
+    title: string;
+
+    /**
+     * When the task was last updated (RFC3339)
+     */
+    updated_at: string;
+
+    /**
+     * When the task started running (RFC3339), null if not yet started
+     */
+    started_at?: string | null;
+  }
+}
+
 /**
  * Configuration for a cloud environment used by scheduled agents
  */
@@ -536,13 +656,76 @@ export interface AgentListResponse {
 }
 
 /**
- * Response for retrieving a screenshot artifact.
+ * Response for retrieving a plan artifact.
  */
 export type AgentGetArtifactResponse =
+  | AgentGetArtifactResponse.PlanArtifactResponse
   | AgentGetArtifactResponse.ScreenshotArtifactResponse
   | AgentGetArtifactResponse.FileArtifactResponse;
 
 export namespace AgentGetArtifactResponse {
+  /**
+   * Response for retrieving a plan artifact.
+   */
+  export interface PlanArtifactResponse {
+    /**
+     * Type of the artifact
+     */
+    artifact_type: 'PLAN';
+
+    /**
+     * Unique identifier (UUID) for the artifact
+     */
+    artifact_uid: string;
+
+    /**
+     * Timestamp when the artifact was created (RFC3339)
+     */
+    created_at: string;
+
+    /**
+     * Response data for a plan artifact, including current markdown content.
+     */
+    data: PlanArtifactResponse.Data;
+  }
+
+  export namespace PlanArtifactResponse {
+    /**
+     * Response data for a plan artifact, including current markdown content.
+     */
+    export interface Data {
+      /**
+       * Current markdown content of the plan
+       */
+      content: string;
+
+      /**
+       * MIME type of the returned plan content
+       */
+      content_type: string;
+
+      /**
+       * Unique identifier for the plan document
+       */
+      document_uid: string;
+
+      /**
+       * Unique identifier for the associated notebook
+       */
+      notebook_uid: string;
+
+      /**
+       * Current title of the plan
+       */
+      title?: string;
+
+      /**
+       * URL to open the plan in Warp Drive
+       */
+      url?: string;
+    }
+  }
+
   /**
    * Response for retrieving a screenshot artifact.
    */
@@ -663,6 +846,13 @@ export namespace AgentGetArtifactResponse {
   }
 }
 
+export interface AgentListEnvironmentsResponse {
+  /**
+   * List of accessible cloud environments
+   */
+  environments: Array<CloudEnvironment>;
+}
+
 export interface AgentRunResponse {
   /**
    * Unique identifier for the created run
@@ -724,6 +914,16 @@ export interface AgentListParams {
   sort_by?: 'name' | 'last_run';
 }
 
+export interface AgentListEnvironmentsParams {
+  /**
+   * Sort order for the returned environments.
+   *
+   * - `name`: alphabetical by environment name
+   * - `last_updated`: most recently updated first (default)
+   */
+  sort_by?: 'name' | 'last_updated';
+}
+
 export interface AgentRunParams {
   /**
    * Optional agent identity UID to use as the execution principal for the run. This
@@ -819,6 +1019,7 @@ export declare namespace Agent {
     type AgentSkill as AgentSkill,
     type AmbientAgentConfig as AmbientAgentConfig,
     type AwsProviderConfig as AwsProviderConfig,
+    type CloudEnvironment as CloudEnvironment,
     type CloudEnvironmentConfig as CloudEnvironmentConfig,
     type Error as Error,
     type ErrorCode as ErrorCode,
@@ -828,8 +1029,10 @@ export declare namespace Agent {
     type UserProfile as UserProfile,
     type AgentListResponse as AgentListResponse,
     type AgentGetArtifactResponse as AgentGetArtifactResponse,
+    type AgentListEnvironmentsResponse as AgentListEnvironmentsResponse,
     type AgentRunResponse as AgentRunResponse,
     type AgentListParams as AgentListParams,
+    type AgentListEnvironmentsParams as AgentListEnvironmentsParams,
     type AgentRunParams as AgentRunParams,
   };
 

src/resources/agent/index.ts

@@ -5,6 +5,7 @@ export {
   type AgentSkill,
   type AmbientAgentConfig,
   type AwsProviderConfig,
+  type CloudEnvironment,
   type CloudEnvironmentConfig,
   type Error,
   type ErrorCode,
@@ -14,8 +15,10 @@ export {
   type UserProfile,
   type AgentListResponse,
   type AgentGetArtifactResponse,
+  type AgentListEnvironmentsResponse,
   type AgentRunResponse,
   type AgentListParams,
+  type AgentListEnvironmentsParams,
   type AgentRunParams,
 } from './agent';
 export {