@mobilerun/sdk 4.0.0 → 5.2.0

package/src/resources/tasks/tasks.ts

@@ -64,8 +64,16 @@ export class Tasks extends APIResource {
    * Create and dispatch a new agent task. Returns the task ID and device stream
    * details.
    */
-  run(body: TaskRunParams, options?: RequestOptions): APIPromise<TaskRunResponse> {
-    return this._client.post('/tasks', { body, ...options });
+  run(params: TaskRunParams, options?: RequestOptions): APIPromise<TaskRunResponse> {
+    const { 'Idempotency-Key': idempotencyKey, ...body } = params;
+    return this._client.post('/tasks', {
+      body,
+      ...options,
+      headers: buildHeaders([
+        { ...(idempotencyKey != null ? { 'Idempotency-Key': idempotencyKey } : undefined) },
+        options?.headers,
+      ]),
+    });
   }
 
   /**
@@ -104,118 +112,139 @@ export interface PackageCredentials {
 }
 
 export interface Task {
-  deviceId: string;
+  createdAt: string;
+
+  taskId: string;
+
+  updatedAt: string;
+}
+
+export type TaskStatus =
+  | 'queued'
+  | 'created'
+  | 'running'
+  | 'cancelling'
+  | 'completed'
+  | 'failed'
+  | 'cancelled';
+
+export interface UsageResult {
+  request_tokens: number;
+
+  requests: number;
+
+  response_tokens: number;
+
+  total_tokens: number;
+}
 
+export interface TaskRetrieveResponse {
   /**
-   * The LLM model identifier to use for the task (e.g. 'gemini/gemini-2.5-flash')
+   * The task
    */
-  llmModel: string;
-
-  task: string;
+  task: TaskRetrieveResponse.Task;
+}
 
-  userId: string;
+export namespace TaskRetrieveResponse {
+  /**
+   * The task
+   */
+  export interface Task {
+    id: string;
 
-  id?: string;
+    deviceId: string;
 
-  agentId?: number;
+    displayId: number;
 
-  apps?: Array<string>;
+    /**
+     * The LLM model identifier to use for the task (e.g. 'gemini/gemini-2.5-flash')
+     */
+    llmModel: string;
 
-  cancelRequestedAt?: string | null;
+    ownerId: string;
 
-  claimedAt?: string | null;
+    status: TasksAPI.TaskStatus;
 
-  continueOnFailure?: boolean;
+    task: string;
 
-  createdAt?: string;
+    tmpDevice: boolean;
 
-  credentials?: Array<PackageCredentials>;
+    /**
+     * @deprecated Deprecated: use ownerId (tenancy) / createdBy (actor).
+     */
+    userId: string;
 
-  dispatchedAt?: string | null;
+    accessibility?: boolean;
 
-  displayId?: number;
+    agentId?: number;
 
-  executionTimeout?: number;
+    apps?: Array<string>;
 
-  files?: Array<string>;
+    cancelRequestedAt?: string | null;
 
-  finishedAt?: string | null;
+    claimedAt?: string | null;
 
-  maxSteps?: number;
+    continueOnFailure?: boolean;
 
-  /**
-   * Memory namespace for cross-task personalization
-   */
-  memoryNamespace?: string;
+    createdAt?: string;
 
-  message?: string | null;
+    createdBy?: string | null;
 
-  output?: { [key: string]: unknown } | null;
+    credentials?: Array<TasksAPI.PackageCredentials>;
 
-  outputSchema?: { [key: string]: unknown } | null;
+    creditsUsed?: number | null;
 
-  reasoning?: boolean;
+    dispatchedAt?: string | null;
 
-  status?: TaskStatus;
+    executionTimeout?: number;
 
-  stealth?: boolean;
+    files?: Array<string>;
 
-  steps?: number | null;
+    finishedAt?: string | null;
 
-  streamUrl?: string | null;
+    maxSteps?: number;
 
-  /**
-   * LLM model used by sub-agent roles: executor, app_opener, structured_output
-   */
-  subagentModel?: string;
+    /**
+     * Memory namespace for cross-task personalization
+     */
+    memoryNamespace?: string;
 
-  succeeded?: boolean | null;
+    message?: string | null;
 
-  temperature?: number;
+    output?: { [key: string]: unknown } | null;
 
-  tmpDevice?: boolean;
+    outputSchema?: { [key: string]: unknown } | null;
 
-  trajectory?: Array<{ [key: string]: unknown }>;
+    reasoning?: boolean;
 
-  updatedAt?: string;
+    stealth?: boolean;
 
-  vision?: boolean;
+    steps?: number | null;
 
-  vpnCountry?: 'US' | 'BR' | 'FR' | 'DE' | 'IN' | 'JP' | 'KR' | 'ZA' | null;
-}
+    streamUrl?: string | null;
 
-export type TaskStatus =
-  | 'queued'
-  | 'created'
-  | 'running'
-  | 'cancelling'
-  | 'paused'
-  | 'completed'
-  | 'failed'
-  | 'cancelled';
+    /**
+     * LLM model used by sub-agent roles: executor, app_opener, structured_output
+     */
+    subagentModel?: string;
 
-export interface UsageResult {
-  request_tokens: number;
+    succeeded?: boolean | null;
 
-  requests: number;
+    temperature?: number;
 
-  response_tokens: number;
+    updatedAt?: string;
 
-  total_tokens: number;
-}
+    vision?: boolean;
 
-export interface TaskRetrieveResponse {
-  /**
-   * The task
-   */
-  task: Task;
+    vpnCountry?: 'US' | 'BR' | 'FR' | 'DE' | 'IN' | 'JP' | 'KR' | 'ZA' | null;
+  }
 }
 
 export interface TaskListResponse {
   /**
    * The paginated items
    */
-  items: Array<Task>;
+  items: Array<TaskListResponse.Item>;
 
   /**
    * Pagination metadata
@@ -223,12 +252,112 @@ export interface TaskListResponse {
   pagination: Shared.PaginationMeta;
 }
 
+export namespace TaskListResponse {
+  /**
+   * Task representation for list endpoints — omits the large trajectory field.
+   */
+  export interface Item {
+    id: string;
+
+    deviceId: string;
+
+    displayId: number;
+
+    /**
+     * The LLM model identifier to use for the task (e.g. 'gemini/gemini-2.5-flash')
+     */
+    llmModel: string;
+
+    ownerId: string;
+
+    status: TasksAPI.TaskStatus;
+
+    task: string;
+
+    tmpDevice: boolean;
+
+    /**
+     * @deprecated Deprecated: use ownerId (tenancy) / createdBy (actor).
+     */
+    userId: string;
+
+    accessibility?: boolean;
+
+    agentId?: number;
+
+    apps?: Array<string>;
+
+    cancelRequestedAt?: string | null;
+
+    claimedAt?: string | null;
+
+    continueOnFailure?: boolean;
+
+    createdAt?: string;
+
+    createdBy?: string | null;
+
+    credentials?: Array<TasksAPI.PackageCredentials>;
+
+    creditsUsed?: number | null;
+
+    dispatchedAt?: string | null;
+
+    executionTimeout?: number;
+
+    files?: Array<string>;
+
+    finishedAt?: string | null;
+
+    maxSteps?: number;
+
+    /**
+     * Memory namespace for cross-task personalization
+     */
+    memoryNamespace?: string;
+
+    message?: string | null;
+
+    output?: { [key: string]: unknown } | null;
+
+    outputSchema?: { [key: string]: unknown } | null;
+
+    reasoning?: boolean;
+
+    stealth?: boolean;
+
+    steps?: number | null;
+
+    streamUrl?: string | null;
+
+    /**
+     * LLM model used by sub-agent roles: executor, app_opener, structured_output
+     */
+    subagentModel?: string;
+
+    succeeded?: boolean | null;
+
+    temperature?: number;
+
+    updatedAt?: string;
+
+    vision?: boolean;
+
+    vpnCountry?: 'US' | 'BR' | 'FR' | 'DE' | 'IN' | 'JP' | 'KR' | 'ZA' | null;
+  }
+}
+
 export interface TaskGetStatusResponse {
   /**
    * The status of the task
    */
   status: TaskStatus;
 
+  /**
+   * Execution metadata for abnormal terminal outcomes
+   */
+  execution?: TaskGetStatusResponse.Execution | null;
+
   /**
    * The last agent response (FastAgentResponseEvent or ManagerPlanEvent)
    */
@@ -255,6 +384,31 @@ export interface TaskGetStatusResponse {
   succeeded?: boolean | null;
 }
 
+export namespace TaskGetStatusResponse {
+  /**
+   * Execution metadata for abnormal terminal outcomes
+   */
+  export interface Execution {
+    checkpoint: Execution.Checkpoint;
+
+    terminationReason: 'execution_timeout' | 'worker_lost' | 'cancelled' | 'agent_failed';
+
+    retrySafety?: 'unknown';
+  }
+
+  export namespace Execution {
+    export interface Checkpoint {
+      currentSubgoal?: string | null;
+
+      plan?: string | null;
+
+      progressSummary?: string | null;
+
+      steps?: number;
+    }
+  }
+}
+
 export interface TaskGetTrajectoryResponse {
   /**
    * The trajectory of the task
@@ -463,7 +617,7 @@ export namespace TaskGetTrajectoryResponse {
 
   export interface TrajectoryManagerPlanEvent {
     /**
-     * Coordination event from ManagerAgent to DroidAgent.
+     * Coordination event from ManagerAgent to MobileAgent.
      *
      * Used for workflow step routing only (NOT streamed to frontend). For internal
      * events with memory_update metadata, see ManagerPlanDetailsEvent.
@@ -475,7 +629,7 @@ export namespace TaskGetTrajectoryResponse {
 
   export namespace TrajectoryManagerPlanEvent {
     /**
-     * Coordination event from ManagerAgent to DroidAgent.
+     * Coordination event from ManagerAgent to MobileAgent.
      *
      * Used for workflow step routing only (NOT streamed to frontend). For internal
      * events with memory_update metadata, see ManagerPlanDetailsEvent.
@@ -908,6 +1062,16 @@ export interface TaskStopResponse {
 }
 
 export interface TaskListParams {
+  /**
+   * Only tasks created by this user id.
+   */
+  createdBy?: string | null;
+
+  /**
+   * Only tasks created by the calling user.
+   */
+  mine?: boolean;
+
   orderBy?: 'id' | 'createdAt' | 'finishedAt' | 'status' | null;
 
   orderByDirection?: 'asc' | 'desc';
@@ -926,58 +1090,111 @@ export interface TaskListParams {
 
 export interface TaskRunParams {
   /**
-   * The ID of the device to run the task on.
+   * Body param: The ID of the device to run the task on.
    */
   deviceId: string;
 
+  /**
+   * Body param
+   */
   task: string;
 
+  /**
+   * Body param
+   */
+  accessibility?: boolean;
+
+  /**
+   * Body param
+   */
   agentId?: number;
 
+  /**
+   * Body param
+   */
   apps?: Array<string>;
 
+  /**
+   * Body param
+   */
   continueOnFailure?: boolean;
 
+  /**
+   * Body param
+   */
   credentials?: Array<PackageCredentials>;
 
   /**
-   * The display ID of the device to run the task on.
+   * Body param: The display ID of the device to run the task on.
    */
   displayId?: number;
 
+  /**
+   * Body param
+   */
   executionTimeout?: number;
 
+  /**
+   * Body param
+   */
   files?: Array<string>;
 
   /**
-   * The LLM model identifier to use for the task (e.g.
-   * 'google/gemini-3.1-flash-lite-preview')
+   * Body param: The LLM model identifier to use for the task (e.g.
+   * 'google/gemini-3.5-flash')
    */
   llmModel?: string;
 
+  /**
+   * Body param
+   */
   maxSteps?: number;
 
   /**
-   * Memory namespace for cross-task personalization
+   * Body param: Memory namespace for cross-task personalization
    */
   memoryNamespace?: string;
 
+  /**
+   * Body param
+   */
   outputSchema?: { [key: string]: unknown } | null;
 
+  /**
+   * Body param
+   */
   reasoning?: boolean;
 
+  /**
+   * Body param
+   */
   stealth?: boolean;
 
   /**
-   * LLM model used by sub-agent roles: executor, app_opener, structured_output
+   * Body param: LLM model used by sub-agent roles: executor, app_opener,
+   * structured_output
    */
   subagentModel?: string;
 
+  /**
+   * Body param
+   */
   temperature?: number;
 
+  /**
+   * Body param
+   */
   vision?: boolean;
 
+  /**
+   * Body param
+   */
   vpnCountry?: 'US' | 'BR' | 'FR' | 'DE' | 'IN' | 'JP' | 'KR' | 'ZA' | null;
+
+  /**
+   * Header param
+   */
+  'Idempotency-Key'?: string;
 }
 
 export interface TaskRunStreamedParams {
@@ -988,6 +1205,8 @@ export interface TaskRunStreamedParams {
 
   task: string;
 
+  accessibility?: boolean;
+
   agentId?: number;
 
   apps?: Array<string>;
@@ -1006,8 +1225,7 @@ export interface TaskRunStreamedParams {
   files?: Array<string>;
 
   /**
-   * The LLM model identifier to use for the task (e.g.
-   * 'google/gemini-3.1-flash-lite-preview')
+   * The LLM model identifier to use for the task (e.g. 'google/gemini-3.5-flash')
    */
   llmModel?: string;