Mobilerun AI API

https://docs.mobilerun.ai/api-reference/
Admin
Mobilerun AI API is a cloud-based platform that provides programmatic access to mobile device...
Tokens:68,975
Snippets:171
Trust Score:2.6
Update:8 months ago
Show doc for...
Tokens:
Raw
### Start App

Source: https://docs.mobilerun.ai/api-reference/tools/start-app

Starts a specified application on a given device. This endpoint requires authentication and provides details on request parameters and responses.

```APIDOC
## PUT /devices/{deviceId}/apps/{packageName}

### Description
Starts a specified application on a given device. This endpoint requires authentication and provides details on request parameters and responses.

### Method
PUT

### Endpoint
/devices/{deviceId}/apps/{packageName}

### Parameters
#### Path Parameters
- **deviceId** (string) - Required - The unique identifier of the device.
- **packageName** (string) - Required - The package name of the application to start.

#### Query Parameters
- **X-Device-Display-ID** (integer) - Optional - Defaults to 0. The display ID of the device.

#### Request Body
- **activity** (string) - Optional - The specific activity to launch within the application.

### Request Example
```json
{
  "activity": "com.example.MainActivity"
}
```

### Response
#### Success Response (204)
No Content. Indicates the application was successfully started.

#### Error Response (default)
- **status** (integer) - Description of the HTTP status code.
- **title** (string) - A short, human-readable summary of the problem type.
- **detail** (string) - A human-readable explanation specific to this occurrence of the problem.
- **type** (string) - A URI reference to human-readable documentation for the error.
- **instance** (string) - A URI reference that identifies the specific occurrence of the problem.
- **errors** (array) - Optional list of individual error details.

#### Response Example
```json
{
  "status": 400,
  "title": "Bad Request",
  "detail": "Invalid package name provided.",
  "type": "https://example.com/errors/invalid-request",
  "instance": "https://example.com/error-log/abc123xyz"
}
```
```

--------------------------------

### POST /devices/{deviceId}/apps

Source: https://docs.mobilerun.ai/api-reference/tools/install-app

Installs an application on a specified device. This endpoint requires a device ID and the package name of the app to be installed.

```APIDOC
## POST /devices/{deviceId}/apps

### Description
Installs an application on a specified device. This endpoint requires a device ID and the package name of the app to be installed.

### Method
POST

### Endpoint
/devices/{deviceId}/apps

### Parameters
#### Path Parameters
- **deviceId** (string) - Required - The unique identifier of the device.

#### Query Parameters
None

#### Request Body
- **packageName** (string) - Required - The package name of the application to install.
- **$schema** (string) - Optional - A URL to the JSON Schema for this object.

### Request Example
```json
{
  "packageName": "com.example.app"
}
```

### Response
#### Success Response (204)
- Description: No Content. The app installation request was successful.

#### Error Response (default)
- **status** (integer) - The HTTP status code of the error.
- **type** (string) - A URI reference to human-readable documentation for the error.
- **title** (string) - A short, human-readable summary of the problem type.
- **detail** (string) - A human-readable explanation specific to this occurrence of the problem.
- **instance** (string) - A URI reference that identifies the specific occurrence of the problem.
- **errors** (array) - Optional list of individual error details.

#### Response Example
```json
{
  "status": 400,
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "Invalid package name provided.",
  "instance": "https://example.com/error-log/abc123",
  "errors": [
    {
      "location": "body.packageName",
      "message": "Package name is invalid.",
      "value": "invalid-package-name"
    }
  ]
}
```
```

--------------------------------

### Install App using Droidrun Cloud API (OpenAPI)

Source: https://docs.mobilerun.ai/api-reference/tools/install-app

This OpenAPI specification defines the 'install-app' endpoint for the Droidrun Cloud API. It allows users to install an application on a specified device by providing the package name. The endpoint requires a device ID in the path and accepts installation arguments in the request body. It returns a 204 No Content on success or an error response.

```yaml
openapi: 3.1.0
info:
  title: Droidrun Cloud
  version: v1
  description: Droidrun Cloud API
  contact:
    name: Droidrun
    email: support@droidrun.ai
servers:
  - url: https://api.mobilerun.ai/v1
    description: Droidrun Cloud API
security:
  - bearerAuth: []
tags:
  - description: Tasks API
    name: Tasks
paths:
  /devices/{deviceId}/apps:
    post:
      tags:
        - tools
      summary: Install app
      operationId: install-app
      parameters:
        - in: path
          name: deviceId
          required: true
          schema:
            type: string
        - in: header
          name: X-Device-Display-ID
          schema:
            default: 0
            format: int64
            minimum: 0
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstallAppArgs'
        required: true
      responses:
        '204':
          description: No Content
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      security:
        - bearerAuth: []
components:
  schemas:
    InstallAppArgs:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - https://example.com/schemas/InstallAppArgs.json
          format: uri
          readOnly: true
          type: string
        packageName:
          type: string
      required:
        - packageName
      type: object
    ErrorModel:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - https://example.com/schemas/ErrorModel.json
          format: uri
          readOnly: true
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: Bearer token via Authorization header

```

--------------------------------

### GET /hooks/

Source: https://docs.mobilerun.ai/api-reference/hook/list-hooks

Retrieves a paginated list of hooks associated with the authenticated user. Supports filtering and sorting.

```APIDOC
## GET /hooks/

### Description
List hooks belonging to the requesting user (paginated).

### Method
GET

### Endpoint
/hooks/

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve (defaults to 1).
- **pageSize** (integer) - Optional - The number of items per page (defaults to 20, max 100).
- **orderBy** (string) - Optional - The field to order the results by (defaults to 'createdAt').
- **orderByDirection** (string) - Optional - The direction of ordering ('asc' or 'desc', defaults to 'desc').

### Response
#### Success Response (200)
- **items** (array) - An array of Hook objects.
- **pagination** (object) - Pagination metadata.

#### Response Example
```json
{
  "items": [
    {
      "createdAt": "2023-10-27T10:00:00Z",
      "events": ["created", "completed"],
      "id": "uuid-string",
      "service": "some_service",
      "state": "enabled",
      "updatedAt": "2023-10-27T10:05:00Z",
      "url": "https://example.com/webhook",
      "userId": "user-id-string"
    }
  ],
  "pagination": {
    "hasNext": true,
    "hasPrev": false,
    "page": 1,
    "pageSize": 20,
    "pages": 5,
    "total": 100
  }
}
```

#### Error Response (422)
- **detail** (array) - An array of validation error details.

#### Error Response Example
```json
{
  "detail": [
    {
      "loc": ["query", "page"],
      "msg": "value is not a valid integer",
      "type": "type_error.integer"
    }
  ]
}
```
```

--------------------------------

### Start App - Droidrun Cloud API (OpenAPI)

Source: https://docs.mobilerun.ai/api-reference/tools/start-app

This OpenAPI specification defines the 'start-app' operation for the Droidrun Cloud API. It allows starting an application on a specific device. The request requires device ID, package name, and optional activity. Responses include success (204) or error details.

```yaml
openapi: 3.1.0
info:
  title: Droidrun Cloud
  version: v1
  description: Droidrun Cloud API
  contact:
    name: Droidrun
    email: support@droidrun.ai
servers:
  - url: https://api.mobilerun.ai/v1
    description: Droidrun Cloud API
security:
  - bearerAuth: []
tags:
  - description: Tasks API
    name: Tasks
paths:
  /devices/{deviceId}/apps/{packageName}:
    put:
      tags:
        - tools
      summary: Start app
      operationId: start-app
      parameters:
        - in: path
          name: deviceId
          required: true
          schema:
            type: string
        - in: header
          name: X-Device-Display-ID
          schema:
            default: 0
            format: int64
            minimum: 0
            type: integer
        - schema:
            type: string
          required: true
          name: packageName
          in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartAppArgs'
        required: true
      responses:
        '204':
          description: No Content
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      security:
        - bearerAuth: []
components:
  schemas:
    StartAppArgs:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - https://example.com/schemas/StartAppArgs.json
          format: uri
          readOnly: true
          type: string
        activity:
          type: string
      type: object
    ErrorModel:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - https://example.com/schemas/ErrorModel.json
          format: uri
          readOnly: true
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: Bearer token via Authorization header

```

--------------------------------

### Get Device Info API

Source: https://docs.mobilerun.ai/api-reference/devices/get-device-info

Retrieves information about the device.

```APIDOC
## GET /websites/mobilerun_ai_api-reference/device-info

### Description
Retrieves information about the device associated with the API request.

### Method
GET

### Endpoint
/websites/mobilerun_ai_api-reference/device-info

### Parameters
#### No parameters required for this endpoint.

### Response
#### Success Response (200)
- **device_id** (string) - The unique identifier for the device.
- **model** (string) - The model name of the device.
- **os** (string) - The operating system of the device.
- **version** (string) - The version of the operating system.

#### Response Example
```json
{
  "device_id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "model": "ExampleDeviceModel",
  "os": "Android",
  "version": "12.0"
}
```
```

--------------------------------

### GET /devices

Source: https://docs.mobilerun.ai/api-reference/devices/list-devices

Retrieves a list of devices, with options to filter by state, provider, type, country, name, and pagination.

```APIDOC
## GET /devices

### Description
Retrieves a list of devices. You can filter the results by device state, provider, type, country, and name. Pagination and sorting options are also available.

### Method
GET

### Endpoint
/devices

### Parameters
#### Query Parameters
- **state** (string) - Optional - Filters devices by their current state. Allowed values: creating, assigned, ready, terminated, unknown.
- **provider** (string) - Optional - Filters devices by their provider. Allowed values: limrun, personal, remote, roidrun.
- **type** (string) - Optional - Filters devices by their type. Allowed values: device_slot, dedicated_emulated_device, dedicated_physical_device.
- **country** (string) - Optional - Filters devices by country.
- **name** (string) - Optional - Filters devices by name.
- **page** (integer) - Optional - The page number for pagination. Defaults to 1.
- **pageSize** (integer) - Optional - The number of items per page. Defaults to 20.
- **orderBy** (string) - Optional - The field to order the results by. Allowed values: id, createdAt, updatedAt, assignedAt. Defaults to createdAt.
- **orderByDirection** (string) - Optional - The direction of the ordering. Allowed values: asc, desc. Defaults to desc.

### Request Example
```json
{
  "example": "GET /devices?state=ready&provider=limrun&page=1&pageSize=10"
}
```

### Response
#### Success Response (200)
- **items** (array) - An array of DeviceInfo objects.
- **pagination** (object) - Pagination metadata.

#### Response Example
```json
{
  "example": {
    "items": [
      {
        "id": "device-123",
        "createdAt": "2023-10-27T10:00:00Z",
        "updatedAt": "2023-10-27T10:05:00Z",
        "assignedAt": null,
        "state": "ready",
        "provider": "limrun",
        "type": "device_slot",
        "country": "US",
        "name": "Test Device 1"
      }
    ],
    "pagination": {
      "totalItems": 100,
      "totalPages": 10,
      "currentPage": 1,
      "pageSize": 10
    }
  }
}
```

#### Error Response (default)
- **status** (integer) - The HTTP status code.
- **title** (string) - A short, human-readable summary of the problem type.
- **detail** (string) - A human-readable explanation specific to this occurrence of the problem.
- **type** (string) - A URI reference to human-readable documentation for the error.
- **instance** (string) - A URI reference that identifies the specific occurrence of the problem.
- **errors** (array) - Optional list of individual error details.
```

--------------------------------

### GET /hooks/sample

Source: https://docs.mobilerun.ai/api-reference/hook/get-sample-data

Retrieves sample hook data, useful for testing and field mapping in platforms like Zapier. This endpoint is part of the Droidrun Cloud API.

```APIDOC
## GET /hooks/sample

### Description
Get sample hook data for Zapier Perform List (testing/field mapping).

### Method
GET

### Endpoint
/hooks/sample

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **id** (string) - The subscription ID
- **url** (string) - The webhook URL
- **events** (array of strings) - List of subscribed events
- **state** (string) - The hook state
- **createdAt** (string) - ISO timestamp of when the subscription was created
- **updatedAt** (string or null) - ISO timestamp of the last update

#### Response Example
```json
[
  {
    "createdAt": "2023-10-27T10:00:00Z",
    "events": [
      "task.created",
      "task.completed"
    ],
    "id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "state": "active",
    "updatedAt": "2023-10-27T10:05:00Z",
    "url": "https://example.com/webhook"
  }
]
```
```

--------------------------------

### GET /devices/{deviceId}/tasks

Source: https://docs.mobilerun.ai/api-reference/devices/list-tasks-for-a-device

Retrieves a list of tasks associated with a specific device. Supports pagination and sorting.

```APIDOC
## GET /devices/{deviceId}/tasks

### Description
Retrieves a list of tasks for a specific device. You can control the number of results per page, the page number, and the order of the results.

### Method
GET

### Endpoint
/devices/{deviceId}/tasks

### Parameters
#### Path Parameters
- **deviceId** (string) - Required - The unique identifier of the device.

#### Query Parameters
- **page** (integer) - Optional - The page number of the results to retrieve. Defaults to 1.
- **pageSize** (integer) - Optional - The number of tasks to return per page. Defaults to 20.
- **orderBy** (string) - Optional - The field to order the tasks by. Allowed values: `id`, `createdAt`, `updatedAt`, `assignedAt`. Defaults to `createdAt`.
- **orderByDirection** (string) - Optional - The direction to order the tasks. Allowed values: `asc`, `desc`. Defaults to `desc`.

### Request Example
```json
{
  "example": "GET /v1/devices/some-device-id/tasks?page=1&pageSize=10&orderBy=createdAt&orderByDirection=asc"
}
```

### Response
#### Success Response (200)
- **items** (array) - An array of task objects.
- **pagination** (object) - Pagination metadata for the response.

#### Response Example
```json
{
  "example": {
    "$schema": "https://example.com/schemas/ResponseTask.json",
    "items": [
      {
        "taskId": "task-123",
        "createdAt": "2023-10-27T10:00:00Z",
        "updatedAt": "2023-10-27T10:05:00Z"
      }
    ],
    "pagination": {
      "hasNext": true,
      "hasPrev": false,
      "page": 1,
      "pageSize": 10,
      "pages": 5,
      "total": 45
    }
  }
}
```

#### Error Response (default)
- **status** (integer) - The HTTP status code of the error.
- **title** (string) - A short, human-readable summary of the problem type.
- **detail** (string) - A human-readable explanation specific to this occurrence of the problem.
- **type** (string) - A URI reference to human-readable documentation for the error.
- **instance** (string) - A URI reference that identifies the specific occurrence of the problem.
- **errors** (array) - Optional list of individual error details.

#### Error Response Example
```json
{
  "example": {
    "$schema": "https://example.com/schemas/ErrorModel.json",
    "status": 404,
    "title": "Not Found",
    "detail": "Device with ID 'non-existent-device-id' not found.",
    "type": "https://example.com/errors/device-not-found",
    "instance": "https://example.com/error-log/xyz789"
  }
}
```
```

--------------------------------

### List Apps

Source: https://docs.mobilerun.ai/api-reference/tools/list-apps

Retrieves a list of applications installed on a specific device. Supports filtering for system applications.

```APIDOC
## GET /devices/{deviceId}/apps

### Description
Retrieves a list of applications installed on a specific device. You can optionally include system applications in the response.

### Method
GET

### Endpoint
/devices/{deviceId}/apps

### Parameters
#### Path Parameters
- **deviceId** (string) - Required - The unique identifier of the device.

#### Query Parameters
- **includeSystemApps** (boolean) - Optional - Defaults to `false`. If `true`, system applications will be included in the list.

#### Header Parameters
- **X-Device-Display-ID** (integer) - Optional - Defaults to `0`. Represents the display ID of the device.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **Apps** (array) - A list of AppInfo objects.
  - **packageName** (string) - The package name of the application.
  - **label** (string) - The display name of the application.
  - **versionName** (string) - The version name of the application.
  - **versionCode** (integer) - The version code of the application.
  - **isSystemApp** (boolean) - Indicates if the application is a system app.

#### Response Example
```json
{
  "example": [
    {
      "packageName": "com.example.app",
      "label": "Example App",
      "versionName": "1.0.0",
      "versionCode": 1,
      "isSystemApp": false
    }
  ]
}
```

#### Error Response (default)
- **ErrorModel** - Contains details about the error.
  - **type** (string) - A URI reference to human-readable documentation for the error.
  - **title** (string) - A short, human-readable summary of the problem type.
  - **status** (integer) - HTTP status code.
  - **detail** (string) - A human-readable explanation specific to this occurrence of the problem.
  - **instance** (string) - A URI reference that identifies the specific occurrence of the problem.
  - **errors** (array) - Optional list of individual error details.
    - **location** (string) - Where the error occurred.
    - **message** (string) - Error message text.
    - **value** - The value at the given location.

#### Error Response Example
```json
{
  "example": {
    "type": "about:blank",
    "title": "Bad Request",
    "status": 400,
    "detail": "Invalid deviceId provided.",
    "instance": "https://example.com/error-log/abc123",
    "errors": [
      {
        "location": "path.deviceId",
        "message": "Device ID cannot be empty.",
        "value": ""
      }
    ]
  }
}
```
```

--------------------------------

### GET /tasks/

Source: https://docs.mobilerun.ai/api-reference/tasks/list-tasks

Retrieves a list of tasks. Supports filtering by status, sorting, searching by description, and pagination.

```APIDOC
## GET /tasks/

### Description
List all tasks you've created so far. This endpoint supports filtering, sorting, searching, and pagination.

### Method
GET

### Endpoint
/tasks/

### Parameters
#### Query Parameters
- **status** (TaskStatus | null) - Optional - Filters tasks by their status (e.g., created, running, completed).
- **orderBy** (string | null) - Optional - Specifies the field to sort tasks by (e.g., id, createdAt, finishedAt, status). Defaults to 'createdAt'.
- **orderByDirection** (string) - Optional - The direction of sorting ('asc' or 'desc'). Defaults to 'desc'.
- **query** (string | null) - Optional - A search term to filter tasks by their description. Maximum length is 128 characters.
- **page** (integer | null) - Optional - The page number for pagination (1-based). Defaults to 1.
- **pageSize** (integer) - Optional - The number of items to return per page. Defaults to 20, maximum 100.

### Request Example
```json
{
  "example": "No request body for GET requests"
}
```

### Response
#### Success Response (200)
- **items** (array) - An array of Task objects.
- **pagination** (object) - Pagination metadata.

#### Response Example
```json
{
  "items": [
    {
      "apps": ["string"],
      "createdAt": "2023-10-27T10:00:00Z",
      "credentials": ["string"]
      // ... other task properties
    }
  ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 20,
    "totalItems": 100,
    "totalPages": 5
  }
}
```

#### Error Responses
- **401** - UnauthorizedResponse: Indicates that the request lacks valid authentication credentials.
- **422** - HTTPValidationError: Indicates that the request parameters are invalid.
```

--------------------------------

### GET /credentials/packages/{packageName}

Source: https://docs.mobilerun.ai/api-reference/credentials/list-credentials-for-a-specific-package

Retrieves a list of credentials associated with a specific package. This endpoint is useful for managing and accessing secrets tied to a particular application or service.

```APIDOC
## GET /credentials/packages/{packageName}

### Description
Lists credentials for a specific package.

### Method
GET

### Endpoint
/credentials/packages/{packageName}

### Parameters
#### Path Parameters
- **packageName** (string) - Required - The name of the package for which to list credentials.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of credential objects associated with the package.
  - **userId** (string) - The ID of the user.
  - **packageName** (string) - The name of the package.
  - **secretPath** (string) - The path to the secret.
  - **credentialName** (string) - The name of the credential.
  - **fields** (array) - An array of credential fields.
    - **fieldType** (string) - The type of the credential field (e.g., email, username, password).
    - **value** (string) - The value of the credential field.

#### Response Example
```json
{
  "data": [
    {
      "userId": "user123",
      "packageName": "example-package",
      "secretPath": "/secrets/example-package",
      "credentialName": "api-key",
      "fields": [
        {
          "fieldType": "api_token",
          "value": "sk_test_abcdef12345"
        }
      ]
    }
  ]
}
```

#### Error Responses
- **401** - Unauthorized
- **404** - Not Found
- **500** - Internal Server Error
```

--------------------------------

### POST /tasks/

Source: https://docs.mobilerun.ai/api-reference/tasks/run-task

Initiates a new task to be run on a specified device. This endpoint allows for detailed configuration of the task, including applications, credentials, and execution parameters.

```APIDOC
## POST /tasks/

### Description
Initiates a new task to be run on a specified device. This endpoint allows for detailed configuration of the task, including applications, credentials, and execution parameters.

### Method
POST

### Endpoint
/tasks/

### Parameters
#### Query Parameters
None

#### Request Body
- **llmModel** (string) - Required - The language model to use for the task.
- **task** (string) - Required - The description of the task to be executed.
- **apps** (array of strings) - Optional - A list of application names to be used in the task.
- **credentials** (array of objects) - Optional - Credentials required for task execution. (See `PackageCredentials` schema for details).
- **deviceId** (string or null) - Optional - The ID of the device where the task should run.
- **displayId** (integer) - Optional - The display ID of the device. Defaults to 0.
- **executionTimeout** (integer) - Optional - The maximum time in seconds the task is allowed to run. Defaults to 1000.
- **files** (array of strings) - Optional - A list of file paths to be used in the task.
- **maxSteps** (integer) - Optional - The maximum number of steps the task can take. Defaults to 100.
- **outputSchema** (object or null) - Optional - Defines the expected schema for the task's output.
- **reasoning** (boolean) - Optional - Whether to include reasoning steps in the task execution. Defaults to true.
- **temperature** (number) - Optional - The temperature setting for the language model. Defaults to 0.5.
- **vision** (boolean) - Optional - Whether to enable vision capabilities for the task. Defaults to false.
- **vpnCountry** (string or null) - Optional - The VPN country to use for the task.

### Request Example
```json
{
  "llmModel": "gpt-4",
  "task": "Browse to example.com and extract the title of the page.",
  "apps": ["chrome"],
  "deviceId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "reasoning": true
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created task.
- **streamUrl** (string) - The URL to stream the task's output.
- **token** (string) - A token for accessing the stream.

#### Response Example
```json
{
  "id": "f1e2d3c4-b5a6-7890-1234-567890abcdef",
  "streamUrl": "wss://api.mobilerun.ai/v1/streams/f1e2d3c4-b5a6-7890-1234-567890abcdef/output",
  "token": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

#### Error Responses
- **401 Unauthorized** - Returned if the API key is invalid or missing.
- **412 Precondition Failed** - Returned if certain preconditions are not met.
- **422 Unprocessable Content** - Returned if the request body is invalid.
- **500 Internal Server Error** - Returned if an unexpected error occurs on the server.
- **504 Gateway Timeout** - Returned if the gateway takes too long to respond.
```

--------------------------------

### List Packages via OpenAPI Specification

Source: https://docs.mobilerun.ai/api-reference/tools/list-packages

This OpenAPI 3.1.0 specification defines the 'list-packages' GET endpoint for the Droidrun Cloud API. It allows retrieving a list of packages installed on a specific device, with options to include system packages. The endpoint requires a device ID and supports authentication via a Bearer token.

```yaml
openapi: 3.1.0
info:
  title: Droidrun Cloud
  version: v1
  description: Droidrun Cloud API
  contact:
    name: Droidrun
    email: support@droidrun.ai
servers:
  - url: https://api.mobilerun.ai/v1
    description: Droidrun Cloud API
security:
  - bearerAuth: []
tags:
  - description: Tasks API
    name: Tasks
paths:
  /devices/{deviceId}/packages:
    get:
      tags:
        - tools
      summary: List packages
      operationId: list-packages
      parameters:
        - in: path
          name: deviceId
          required: true
          schema:
            type: string
        - in: header
          name: X-Device-Display-ID
          schema:
            default: 0
            format: int64
            minimum: 0
            type: integer
        - explode: false
          in: query
          name: includeSystemPackages
          schema:
            default: false
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  type: string
                type:
                  - array
                  - 'null'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      security:
        - bearerAuth: []
components:
  schemas:
    ErrorModel:
      additionalProperties: false
      properties:
        $schema:
          description: A URL to the JSON Schema for this object.
          examples:
            - https://example.com/schemas/ErrorModel.json
          format: uri
          readOnly: true
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: Bearer token via Authorization header

```

--------------------------------

### Get Hook Subscription by ID (OpenAPI)

Source: https://docs.mobilerun.ai/api-reference/hook/get-hook

Retrieves a specific hook subscription using its unique identifier. This OpenAPI definition details the request parameters, expected responses, and data schemas for the 'get /hooks/{hook_id}' endpoint.

```yaml
openapi: 3.1.0
info:
  title: Droidrun Cloud
  version: v1
  description: Droidrun Cloud API
  contact:
    name: Droidrun
    email: support@droidrun.ai
servers:
  - url: https://api.mobilerun.ai/v1
    description: Droidrun Cloud API
security:
  - bearerAuth: []
tags:
  - description: Tasks API
    name: Tasks
paths:
  /hooks/{hook_id}:
    get:
      tags:
        - Hook
      summary: Get Hook
      description: Get a hook subscription by id.
      operationId: get_hook_hooks__hook_id__get
      parameters:
        - in: path
          name: hook_id
          required: true
          schema:
            format: uuid
            title: Hook Id
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Hook'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - bearerAuth: []
components:
  schemas:
    Hook:
      properties:
        createdAt:
          format: date-time
          title: Createdat
          type: string
        events:
          items:
            $ref: '#/components/schemas/TaskStatus'
          title: Events
          type: array
        id:
          format: uuid
          title: Id
          type: string
        service:
          $ref: '#/components/schemas/HookService'
        state:
          $ref: '#/components/schemas/HookStatus'
          default: disabled
        updatedAt:
          format: date-time
          title: Updatedat
          type: string
        url:
          title: Url
          type: string
        userId:
          title: Userid
          type: string
      required:
        - userId
        - url
        - service
      title: Hook
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    TaskStatus:
      enum:
        - created
        - running
        - paused
        - completed
        - failed
        - cancelled
      title: TaskStatus
      type: string
    HookService:
      enum:
        - zapier
        - n8n
        - make
        - internal
        - other
      title: HookService
      type: string
    HookStatus:
      enum:
        - active
        - disabled
        - deleted
      title: HookStatus
      type: string
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: Bearer token via Authorization header

```

--------------------------------

### Initialize Package/App using OpenAPI

Source: https://docs.mobilerun.ai/api-reference/credentials/initialize-a-new-packageapp

This OpenAPI specification defines the endpoint for initializing a new package or application. It includes details on the request body schema, authentication, and possible responses such as success, bad request, unauthorized, conflict, and internal server error.

```yaml
openapi: 3.1.0
info:
  title: Droidrun Cloud
  version: v1
  description: Droidrun Cloud API
  contact:
    name: Droidrun
    email: support@droidrun.ai
servers:
  - url: https://api.mobilerun.ai/v1
    description: Droidrun Cloud API
security:
  - bearerAuth: []
tags:
  - description: Tasks API
    name: Tasks
paths:
  /credentials/packages:
    post:
      tags:
        - Credentials
      summary: Initialize a new package/app
      operationId: initializePackage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackageSchema'
      responses:
        '200':
          description: Package initialized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  message:
                    type: string
                  data:
                    $ref: '#/components/schemas/PackageSchema'
                required:
                  - success
                  - message
                  - data
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '409':
          description: Conflict
        '500':
          description: Internal Server Error
components:
  schemas:
    PackageSchema:
      type: object
      properties:
        packageName:
          type: string
      required:
        - packageName
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: Bearer token via Authorization header

```

--------------------------------

### GET /tasks/{task_id}/screenshots

Source: https://docs.mobilerun.ai/api-reference/tasks/get-task-screenshots

Retrieves a list of screenshots associated with a specific task. Requires authentication.

```APIDOC
## GET /tasks/{task_id}/screenshots

### Description
Retrieves a list of screenshots for a given task ID.

### Method
GET

### Endpoint
/tasks/{task_id}/screenshots

### Parameters
#### Path Parameters
- **task_id** (string) - Required - The unique identifier of the task (UUID format).

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **urls** (array) - A list of URLs pointing to the task screenshots.

#### Response Example
```json
{
  "urls": [
    "https://example.com/screenshot1.png",
    "https://example.com/screenshot2.png"
  ]
}
```

#### Error Responses
- **401 Unauthorized**: Returned if the request is not authenticated.
- **422 Unprocessable Content**: Returned for invalid input or other processing errors.
```

--------------------------------

### Documentation Index

Source: https://docs.mobilerun.ai/api-reference/apps/list-apps

Fetch the complete documentation index.

```APIDOC
## GET /llms.txt

### Description
Fetch the complete documentation index. Use this file to discover all available pages before exploring further.

### Method
GET

### Endpoint
/llms.txt

### Response
#### Success Response (200)
- **documentation_index** (string) - A text file containing the documentation index.

#### Response Example
```
https://docs.mobilerun.ai/llms.txt
```
```

--------------------------------

### POST /credentials/packages

Source: https://docs.mobilerun.ai/api-reference/credentials/initialize-a-new-packageapp

Initializes a new package or application within the Droidrun Cloud system. This endpoint requires authentication and accepts a package name in the request body.

```APIDOC
## POST /credentials/packages

### Description
Initializes a new package or application within the Droidrun Cloud system. This endpoint requires authentication and accepts a package name in the request body.

### Method
POST

### Endpoint
/credentials/packages

### Parameters
#### Request Body
- **packageName** (string) - Required - The name of the package to initialize.

### Request Example
```json
{
  "packageName": "my-new-app"
}
```

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the operation was successful (always true).
- **message** (string) - A confirmation message.
- **data** (object) - The initialized package schema.
  - **packageName** (string) - The name of the initialized package.

#### Response Example
```json
{
  "success": true,
  "message": "Package initialized successfully.",
  "data": {
    "packageName": "my-new-app"
  }
}
```

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **409** Conflict
- **500** Internal Server Error
```
Tokens:
Raw