Genfarmer

https://genfarmer-support.gitbook.io/genfarmer-eng
Admin
Genfarmer is a no-code mobile automation platform that enables users to control mobile devices from...
Tokens:13,623
Snippets:174
Trust Score:10
Update:2 days ago
Show doc for...
Tokens:
Raw
### List Apps - cURL Example

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

GET request to list automation apps with query parameters for userId, pagination, and sorting.

```bash
curl -X GET 'http://127.0.0.1:55554/automation/apps?userId=3&page=1&limit=25&order=desc&orderBy=updatedAt'
```

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

### Get Current User - GET /backend/auth/me

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api.md

Fetches the current authenticated user's information.

```bash
curl -X GET 'http://127.0.0.1:55554/backend/auth/me'
```

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

### Get Run Output - GET /automation/runs/:id/storages

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api.md

Retrieves the output storages of a run, with pagination.

```bash
curl -X GET 'http://127.0.0.1:55554/automation/runs/xhfjAeUOB5SXC8d5RiK_c/storages?page=1&limit=25'
```

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

### Get App Details - GET /automation/apps/:id

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api.md

Fetches details of a specific automation app by its ID.

```bash
curl -X GET 'http://127.0.0.1:55554/automation/apps/adoFNVNN6Jwl8FlbZCfni'
```

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

### List Tasks - GET /automation/runs

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api.md

Retrieves a paginated list of tasks (runs) for a user, with optional ordering.

```bash
curl -X GET 'http://127.0.0.1:55554/automation/runs?userId=3&page=1&limit=25&order=desc&orderBy=createdAt'
```

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

### GET /automation/apps

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

Lists automation apps. Supports query parameters for user ID, pagination, and sorting.

```APIDOC
## GET /automation/apps

### Description
Lists automation apps.

### Method
GET

### Endpoint
/automation/apps

### Parameters
#### Query Parameters
- **userId** (integer) - Required - The user ID to filter apps.
- **page** (integer) - Optional - Page number for pagination.
- **limit** (integer) - Optional - Number of items per page.
- **order** (string) - Optional - Sort order (asc or desc).
- **orderBy** (string) - Optional - Field to sort by.

### Request Example
```
curl -X GET 'http://127.0.0.1:55554/automation/apps?userId=3&page=1&limit=25&order=desc&orderBy=updatedAt'
```

### Response
#### Success Response (200)
- No response schema provided in source.

#### Response Example
- No response example provided in source.
```

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

### GET /automation/runs

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

Lists tasks (note: endpoint is /automation/runs, but described as List Tasks).

```APIDOC
## GET /automation/runs

### Description
List Tasks.

### Method
GET

### Endpoint
/automation/runs

### Parameters
- No parameters documented in source.

### Request Example
- No cURL example provided in source.

### Response
#### Success Response (200)
- No response schema provided in source.

#### Response Example
- No response example provided in source.
```

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

### GET /backend/auth/me

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

Retrieves the current authenticated user.

```APIDOC
## GET /backend/auth/me

### Description
Get Current User.

### Method
GET

### Endpoint
/backend/auth/me

### Parameters
- No parameters documented in source.

### Request Example
- No cURL example provided in source.

### Response
#### Success Response (200)
- No response schema provided in source.

#### Response Example
- No response example provided in source.
```

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

### GET /automation/runs/:id/storages

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

Retrieves the output of a specific run.

```APIDOC
## GET /automation/runs/:id/storages

### Description
Get Run Output.

### Method
GET

### Endpoint
/automation/runs/:id/storages

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the run.

### Request Example
- No cURL example provided in source.

### Response
#### Success Response (200)
- No response schema provided in source.

#### Response Example
- No response example provided in source.
```

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

### GET /automation/apps/:id

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

Retrieves details of a specific automation app by its ID.

```APIDOC
## GET /automation/apps/:id

### Description
Get App Details.

### Method
GET

### Endpoint
/automation/apps/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the app.

### Request Example
- No cURL example provided in source.

### Response
#### Success Response (200)
- No response schema provided in source.

#### Response Example
- No response example provided in source.
```

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

### Create Run - POST /automation/runs

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api.md

Creates a new run for a task and app.

```bash
curl -X POST 'http://127.0.0.1:55554/automation/runs' \
  -H 'Content-Type: application/json' \
  -d '{"userId":3,"taskId":"uNDVKT_VwhEDuXT3PGUUv","appId":"adoFNVNN6Jwl8FlbZCfni","status":0}'
```

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

### Create Task - POST /automation/tasks

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api.md

Creates a new automation task with an app ID, input, and device assignment.

```bash
curl -X POST 'http://127.0.0.1:55554/automation/tasks' \
  -H 'Content-Type: application/json' \
  -d '{"appId":"adoFNVNN6Jwl8FlbZCfni","input":[],"userId":3,"name":"test","devices":{"enable":true,"list":[]}}'
```

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

### POST /automation/runs

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

Creates a new run.

```APIDOC
## POST /automation/runs

### Description
Create Run.

### Method
POST

### Endpoint
/automation/runs

### Parameters
#### Request Body
- No request body schema provided in source.

### Request Example
- No cURL example provided in source.

### Response
#### Success Response (200)
- No response schema provided in source.

#### Response Example
- No response example provided in source.
```

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

### Execute Run - PUT /automation/runs/:id/run

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api.md

Executes a run with an optional list of device IDs.

```bash
curl -X PUT 'http://127.0.0.1:55554/automation/runs/xhfjAeUOB5SXC8d5RiK_c/run' \
  -H 'Content-Type: application/json' \
  -d '{"deviceIds":[]}'
```

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

### POST /automation/tasks

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

Creates a new automation task.

```APIDOC
## POST /automation/tasks

### Description
Create Task.

### Method
POST

### Endpoint
/automation/tasks

### Parameters
#### Request Body
- No request body schema provided in source.

### Request Example
- No cURL example provided in source.

### Response
#### Success Response (200)
- No response schema provided in source.

#### Response Example
- No response example provided in source.
```

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

### PUT /automation/tasks/:id/add-devices

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

Assigns devices to a specific task.

```APIDOC
## PUT /automation/tasks/:id/add-devices

### Description
Assign Devices to Task.

### Method
PUT

### Endpoint
/automation/tasks/:id/add-devices

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the task.

#### Request Body
- No request body schema provided in source.

### Request Example
- No cURL example provided in source.

### Response
#### Success Response (200)
- No response schema provided in source.

#### Response Example
- No response example provided in source.
```

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

### PUT /automation/apps

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

Updates an existing automation app.

```APIDOC
## PUT /automation/apps

### Description
Update App.

### Method
PUT

### Endpoint
/automation/apps

### Parameters
#### Request Body
- No request body schema provided in source.

### Request Example
- No cURL example provided in source.

### Response
#### Success Response (200)
- No response schema provided in source.

#### Response Example
- No response example provided in source.
```

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

### PUT /automation/runs/:id/run

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

Executes a specific run.

```APIDOC
## PUT /automation/runs/:id/run

### Description
Execute Run.

### Method
PUT

### Endpoint
/automation/runs/:id/run

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the run.

#### Request Body
- No request body schema provided in source.

### Request Example
- No cURL example provided in source.

### Response
#### Success Response (200)
- No response schema provided in source.

#### Response Example
- No response example provided in source.
```

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

### Update Task - PUT /automation/tasks/:id

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api.md

Updates an existing task, including its input and device list.

```bash
curl -X PUT 'http://127.0.0.1:55554/automation/tasks/uNDVKT_VwhEDuXT3PGUUv' \
  -H 'Content-Type: application/json' \
  -d '{"id":"uNDVKT_VwhEDuXT3PGUUv","userId":3,"appId":"adoFNVNN6Jwl8FlbZCfni","taskSource":0,"name":"test","input":[],"enableInput":true,"devices":{"enable":true,"list":[{"id":"emulator-5554","serialNo":"00f65a5d","name":"SM-G960N"}]}}'
```

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

### Update App - PUT /automation/apps

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api.md

Updates an existing automation app. The script.flow field allows defining automation logic via nodes and edges.

```bash
curl -X PUT 'http://127.0.0.1:55554/automation/apps' \
  -H 'Content-Type: application/json' \
  -d '{"id":"adoFNVNN6Jwl8FlbZCfni","userId":3,"name":"New App","description":"","version":"1.0.0","script":{"flow":{"nodes":[],"edges":[]}}}'
```

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

### Delete App - DELETE /automation/apps

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api.md

Deletes one or more automation apps by providing an array of IDs.

```bash
curl -X DELETE 'http://127.0.0.1:55554/automation/apps' \
  -H 'Content-Type: application/json' \
  -d '{"ids": ["2ykTiCbEOAYC_5_tR5Wp-"]}'
```

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

### PUT /automation/tasks/:id

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

Updates an existing automation task.

```APIDOC
## PUT /automation/tasks/:id

### Description
Update Task.

### Method
PUT

### Endpoint
/automation/tasks/:id

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the task.

#### Request Body
- No request body schema provided in source.

### Request Example
- No cURL example provided in source.

### Response
#### Success Response (200)
- No response schema provided in source.

#### Response Example
- No response example provided in source.
```

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

### Base URL for GenFarmer API

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

Base URL for all GenFarmer API endpoints. Use this as the prefix for every request.

```text
http://127.0.0.1:55554/
```

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

### DELETE /automation/apps

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

Deletes an automation app.

```APIDOC
## DELETE /automation/apps

### Description
Delete App.

### Method
DELETE

### Endpoint
/automation/apps

### Parameters
- No parameters documented in source.

### Request Example
- No cURL example provided in source.

### Response
#### Success Response (200)
- No response schema provided in source.

#### Response Example
- No response example provided in source.
```

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

### PUT /automation/tasks/:id/remove-devices

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

Removes devices from a specific task.

```APIDOC
## PUT /automation/tasks/:id/remove-devices

### Description
Remove Devices from Task.

### Method
PUT

### Endpoint
/automation/tasks/:id/remove-devices

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the task.

#### Request Body
- No request body schema provided in source.

### Request Example
- No cURL example provided in source.

### Response
#### Success Response (200)
- No response schema provided in source.

#### Response Example
- No response example provided in source.
```

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

### Delete Task - DELETE /automation/tasks

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api.md

Deletes one or more tasks by providing an array of IDs.

```bash
curl -X DELETE 'http://127.0.0.1:55554/automation/tasks' \
  -H 'Content-Type: application/json' \
  -d '{"ids": ["uNDVKT_VwhEDuXT3PGUUv"]}'
```

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

### DELETE /automation/tasks

Source: https://genfarmer-support.gitbook.io/genfarmer-eng/main-menu-bar/api

Deletes an automation task.

```APIDOC
## DELETE /automation/tasks

### Description
Delete Task.

### Method
DELETE

### Endpoint
/automation/tasks

### Parameters
- No parameters documented in source.

### Request Example
- No cURL example provided in source.

### Response
#### Success Response (200)
- No response schema provided in source.

#### Response Example
- No response example provided in source.
```
Tokens:
Raw