feat(api): manual updates

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 12
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/warp-bnavetta%2Fwarp-api-c99d72d8d845f1eeabf7a716949a12408df952a2a0ca2b97df570da3a7c8bb49.yml
-openapi_spec_hash: 8a503cbccc8a5741554282327a557114
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/warp-bnavetta%2Fwarp-api-91a7db62ba0752b9bdccd4bac4c6d09c1d59b7b69788159fe13598b7a5def7ee.yml
+openapi_spec_hash: f03a889deaf6df14d678643be1e4dbe3
 config_hash: 433e7a5579323a048aa173a0ace06bfc

src/resources/agent/agent.ts

@@ -45,7 +45,7 @@ export class Agent extends APIResource {
   }
 
   /**
-   * Spawn an cloud agent with a prompt and optional configuration. The agent will be
+   * Spawn a cloud agent with a prompt and optional configuration. The agent will be
    * queued for execution and assigned a unique run ID.
    *
    * @example
@@ -136,7 +136,7 @@ export namespace AgentSkill {
 }
 
 /**
- * Configuration for an cloud agent run
+ * Configuration for a cloud agent run
  */
 export interface AmbientAgentConfig {
   /**
@@ -166,7 +166,10 @@ export interface AmbientAgentConfig {
   model_id?: string;
 
   /**
-   * Config name for searchability and traceability
+   * Human-readable label for grouping, filtering, and traceability. Automatically
+   * set to the skill name when running a skill-based agent. Set this explicitly to
+   * categorize runs by intent (e.g., "nightly-dependency-check") so you can filter
+   * and track them via the name query parameter on GET /agent/runs.
    */
   name?: string;
 
@@ -271,6 +274,11 @@ export interface UserProfile {
    */
   display_name?: string;
 
+  /**
+   * Email address of the creator
+   */
+  email?: string;
+
   /**
    * URL to the creator's photo
    */
@@ -309,6 +317,8 @@ export interface AgentRunResponse {
    * - 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;
@@ -317,6 +327,11 @@ export interface AgentRunResponse {
    * @deprecated Use run_id instead.
    */
   task_id: string;
+
+  /**
+   * Whether the system is at capacity when the run was created
+   */
+  at_capacity?: boolean;
 }
 
 export interface AgentListParams {
@@ -343,7 +358,13 @@ export interface AgentListParams {
 
 export interface AgentRunParams {
   /**
-   * Configuration for an cloud agent run
+   * Optional file attachments to include with the prompt (max 5). Attachments are
+   * uploaded to cloud storage and made available to the agent.
+   */
+  attachments?: Array<AgentRunParams.Attachment>;
+
+  /**
+   * Configuration for a cloud agent run
    */
   config?: AmbientAgentConfig;
 
@@ -353,12 +374,6 @@ export interface AgentRunParams {
    */
   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.
@@ -389,19 +404,24 @@ export interface AgentRunParams {
 
 export namespace AgentRunParams {
   /**
-   * A base64-encoded image to include with the prompt
+   * A base64-encoded file attachment to include with the prompt
    */
-  export interface Image {
+  export interface Attachment {
     /**
-     * Base64-encoded image data
+     * Base64-encoded attachment data
      */
     data: string;
 
     /**
-     * MIME type of the image. Supported types: image/jpeg, image/png, image/gif,
-     * image/webp
+     * Name of the attached file
+     */
+    file_name: string;
+
+    /**
+     * MIME type of the attachment. Supported image types: image/jpeg, image/png,
+     * image/gif, image/webp
      */
-    mime_type: 'image/jpeg' | 'image/png' | 'image/gif' | 'image/webp';
+    mime_type: string;
   }
 }
 

src/resources/agent/runs.ts

@@ -47,7 +47,10 @@ export class Runs extends APIResource {
   }
 }
 
-export type ArtifactItem = ArtifactItem.PlanArtifact | ArtifactItem.PullRequestArtifact;
+export type ArtifactItem =
+  | ArtifactItem.PlanArtifact
+  | ArtifactItem.PullRequestArtifact
+  | ArtifactItem.ScreenshotArtifact;
 
 export namespace ArtifactItem {
   export interface PlanArtifact {
@@ -110,6 +113,39 @@ export namespace ArtifactItem {
       url: string;
     }
   }
+
+  export interface ScreenshotArtifact {
+    /**
+     * Type of the artifact
+     */
+    artifact_type: 'SCREENSHOT';
+
+    /**
+     * Timestamp when the artifact was created (RFC3339)
+     */
+    created_at: string;
+
+    data: ScreenshotArtifact.Data;
+  }
+
+  export namespace ScreenshotArtifact {
+    export 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 {
@@ -137,6 +173,8 @@ export interface RunItem {
    * - 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;
@@ -157,7 +195,7 @@ export interface RunItem {
   updated_at: string;
 
   /**
-   * Configuration for an cloud agent run
+   * Configuration for a cloud agent run
    */
   agent_config?: AgentAPI.AmbientAgentConfig;
 
@@ -352,9 +390,20 @@ export type RunSourceType =
  * - 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' | 'CANCELLED';
+export type RunState =
+  | 'QUEUED'
+  | 'PENDING'
+  | 'CLAIMED'
+  | 'INPROGRESS'
+  | 'SUCCEEDED'
+  | 'FAILED'
+  | 'BLOCKED'
+  | 'ERROR'
+  | 'CANCELLED';
 
 export interface RunListResponse {
   page_info: RunListResponse.PageInfo;
@@ -385,7 +434,7 @@ export interface RunListParams {
   /**
    * Filter runs by artifact type (PLAN or PULL_REQUEST)
    */
-  artifact_type?: 'PLAN' | 'PULL_REQUEST';
+  artifact_type?: 'PLAN' | 'PULL_REQUEST' | 'SCREENSHOT';
 
   /**
    * Filter runs created after this timestamp (RFC3339 format)

src/resources/agent/schedules.ts

@@ -17,9 +17,9 @@ export class Schedules extends APIResource {
    *   await client.agent.schedules.create({
    *     cron_schedule: '0 9 * * *',
    *     name: 'Daily Code Review',
+   *     enabled: true,
    *     prompt:
    *       'Review open pull requests and provide feedback',
-   *     enabled: true,
    *   });
    * ```
    */
@@ -52,7 +52,6 @@ export class Schedules extends APIResource {
    *     cron_schedule: 'cron_schedule',
    *     enabled: true,
    *     name: 'name',
-   *     prompt: 'prompt',
    *   });
    * ```
    */
@@ -158,7 +157,7 @@ export interface ScheduledAgentItem {
   updated_at: string;
 
   /**
-   * Configuration for an cloud agent run
+   * Configuration for a cloud agent run
    */
   agent_config?: AgentAPI.AmbientAgentConfig;
 
@@ -246,12 +245,7 @@ export interface ScheduleCreateParams {
   name: string;
 
   /**
-   * The prompt/instruction for the agent to execute
-   */
-  prompt: string;
-
-  /**
-   * Configuration for an cloud agent run
+   * Configuration for a cloud agent run
    */
   agent_config?: AgentAPI.AmbientAgentConfig;
 
@@ -260,6 +254,12 @@ export interface ScheduleCreateParams {
    */
   enabled?: boolean;
 
+  /**
+   * The prompt/instruction for the agent to execute. Required unless
+   * agent_config.skill_spec is provided.
+   */
+  prompt?: string;
+
   /**
    * Whether to create a team-owned schedule. Defaults to true for users on a single
    * team.
@@ -284,14 +284,15 @@ export interface ScheduleUpdateParams {
   name: string;
 
   /**
-   * The prompt/instruction for the agent to execute
+   * Configuration for a cloud agent run
    */
-  prompt: string;
+  agent_config?: AgentAPI.AmbientAgentConfig;
 
   /**
-   * Configuration for an cloud agent run
+   * The prompt/instruction for the agent to execute. Required unless
+   * agent_config.skill_spec is provided.
    */
-  agent_config?: AgentAPI.AmbientAgentConfig;
+  prompt?: string;
 }
 
 export declare namespace Schedules {

tests/api-resources/agent/schedules.test.ts

@@ -13,7 +13,6 @@ describe('resource schedules', () => {
     const responsePromise = client.agent.schedules.create({
       cron_schedule: '0 9 * * *',
       name: 'Daily Code Review',
-      prompt: 'Review open pull requests and provide feedback',
     });
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
@@ -29,7 +28,6 @@ describe('resource schedules', () => {
     const response = await client.agent.schedules.create({
       cron_schedule: '0 9 * * *',
       name: 'Daily Code Review',
-      prompt: 'Review open pull requests and provide feedback',
       agent_config: {
         base_prompt: 'base_prompt',
         computer_use_enabled: true,
@@ -50,6 +48,7 @@ describe('resource schedules', () => {
         worker_host: 'worker_host',
       },
       enabled: true,
+      prompt: 'Review open pull requests and provide feedback',
       team: true,
     });
   });
@@ -72,7 +71,6 @@ describe('resource schedules', () => {
       cron_schedule: 'cron_schedule',
       enabled: true,
       name: 'name',
-      prompt: 'prompt',
     });
     const rawResponse = await responsePromise.asResponse();
     expect(rawResponse).toBeInstanceOf(Response);
@@ -89,7 +87,6 @@ describe('resource schedules', () => {
       cron_schedule: 'cron_schedule',
       enabled: true,
       name: 'name',
-      prompt: 'prompt',
       agent_config: {
         base_prompt: 'base_prompt',
         computer_use_enabled: true,
@@ -109,6 +106,7 @@ describe('resource schedules', () => {
         skill_spec: 'skill_spec',
         worker_host: 'worker_host',
       },
+      prompt: 'prompt',
     });
   });