Launches a saved automation project on one or more devices. Use this to run automations that have been created and saved in the IDE.

Request Parameters

{
  "device_ids": ["device_123456", "device_789012"],
  "automationId": "83ba7359-d8eb-4374-8ecb-055af01fddfe",
  "command": "start",
  "automationParameters": {
    "maxRetries": 3,
    "timeout": 30000
  },
  "jobVariables": {
    "email": "user@example.com",
    "password": "secret123"
  }
}

Responses

{
  "success": true,
  "message": "Action performed successfully"
}

{
  "success": false,
  "message": "Some devices offline or not found."
}

Launches automation code directly on a device without saving it as a project. You provide a unique launch ID (UUID) to track the automation and retrieve logs.

Request Parameters

{
  "device_id": "device_123456",
  "launch_id": "550e8400-e29b-41d4-a716-446655440000",
  "command": "start",
  "code": "console.log('Hello from automation!');",
  "automationParameters": {
    "maxRetries": 3
  },
  "jobVariables": {
    "targetUrl": "https://example.com"
  }
}

Responses

{
  "success": true,
  "message": "Action performed successfully"
}

{
  "success": false,
  "message": "Some devices offline or not found."
}

Stops all running automations on the specified device.

Request Parameters

{
  "device_id": "device_123456"
}

Responses

{
  "success": true,
  "message": "All automations stopped successfully"
}

Retrieves console logs from running automations. Only returns logs from the last 10 minutes. Use the from parameter for pagination to get logs after a specific log ID.

Request Parameters

{
  "device_id": "device_123456",
  "automation_ids": ["550e8400-e29b-41d4-a716-446655440000"],
  "from": "e0e1a3ef-7b2a-42b5-8f21-b845fa41c8b9"
}

Responses

{
  "logs": [
    {
      "id": "e0e1a3ef-7b2a-42b5-8f21-b845fa41c8b9",
      "automationId": "550e8400-e29b-41d4-a716-446655440000",
      "message": "Processing screen content...",
      "lineNumber": 42,
      "messageLevel": "log",
      "timestamp": 1755811585870
    },
    {
      "id": "f1f2b4ff-8c3b-53c6-9g32-c956gb52d9ca",
      "automationId": "550e8400-e29b-41d4-a716-446655440000",
      "message": "Button clicked successfully",
      "lineNumber": 45,
      "messageLevel": "log",
      "timestamp": 1755811586120
    }
  ]
}

Log Levels

Creates or updates a file within an automation project. For TypeScript files, the content is automatically compiled to JavaScript.

URL Parameters

Request Body

{
  "path": "main.ts",
  "content": "async function main() {\n  console.log('Hello!');\n  stopCurrentAutomation();\n}\n\nmain();"
}

Responses

{
  "success": true,
  "path": "main.ts",
  "compiledPath": "main.js",
  "compiled": true
}

{
  "success": false,
  "message": "TypeScript compilation failed",
  "errors": ["Error at 5:10: Property 'foo' does not exist on type 'string'."]
}

Reads the content of a file within an automation project.

URL Parameters

Query Parameters

curl "https://xgodo.com/api/v2/automation/file/83ba7359-d8eb-4374-8ecb-055af01fddfe?path=main.ts" \
  -H "Authorization: Bearer your_api_token"

Responses

{
  "success": true,
  "content": "async function main() {\n  console.log('Hello!');\n  stopCurrentAutomation();\n}\n\nmain();",
  "path": "main.ts"
}

Creates a new commit with all current changes in the automation project. The project must have uncommitted changes for this to succeed.

URL Parameters

Request Body

{
  "message": "Add error handling to main automation flow"
}

Responses

{
  "success": true,
  "commit": {
    "hash": "a1b2c3d4e5f6789012345678901234567890abcd",
    "message": "Add error handling to main automation flow"
  }
}

{
  "success": false,
  "message": "No changes to commit"
}

Retrieves out of steps records for automations where you are the owner or a shared editor. These records contain screenshots and UI data captured when an automation encounters an unknown screen or runs out of steps. Returns one record at a time with cursor-based pagination.

Query Parameters

Responses

{
  "success": true,
  "result": {
    "device_info": { "brand": "Samsung", "model": "Galaxy S21", ... },
    "automation_name": "My Automation",
    "out_of_steps_id": "507f1f77bcf86cd799439011",
    "automation_id": "507f1f77bcf86cd799439012",
    "type": "outOfSteps",
    "status": "pending",
    "screens": [
      {
        "_id": "507f1f77bcf86cd799439013",
        "uiUrl": "https://server.com/outofsteps/2024/01/15/.../ui_....json",
        "screenshot": {
          "screenshotUrl": "https://server.com/outofsteps/2024/01/15/.../screenshot_....jpeg",
          "compressedWidth": 540,
          "compressedHeight": 1200,
          "originalWidth": 1080,
          "originalHeight": 2400
        },
        "nextStage": "main",
        "screenState": "unknown",
        "maxSteps": 0,
        "timestamp": 1705334400000
      }
    ],
    "added": "2024-01-15T12:00:00.000Z"
  },
  "total": 100,
  "currentPage": 1,
  "currentCursor": "507f1f77bcf86cd799439011",
  "hasNext": true,
  "hasPrev": false
}

Lists the distinct tags used by an automation's debug out of steps records. Debug submissions can carry a tag (default default), and the server retains the 200 most recent debug records per tag per automation. Use the returned tags with the tag filter of the Get Out of Steps Records endpoint.

Query Parameters

Responses

{
  "success": true,
  "tags": ["default", "login-flow", "checkout"]
}

Mark an out of steps record as solved or skipped. Only automation editors (owner or shared_editor) can mark status. Once marked, status cannot be changed.

URL Parameters

Request Body

{
  "status": "solved"
}

Responses

{
  "success": true,
  "message": "Out of steps marked as solved",
  "status": "solved"
}

{
  "success": false,
  "message": "Status already marked as \"solved\". Cannot change status once marked."
}

Saves or unsaves an out of steps record. The server keeps only the most recent records per category (per tag for debug) and auto-deletes older ones; saved records still count toward that limit but are protected from auto-deletion for 2 monthsfrom creation — after that they are cleaned up like any other record. Only automation editors (owner or shared_editor) can toggle this, and it is reversible at any time. The record's current state is returned as the saved field by the Get Out of Steps Records endpoint.

Request Body

Responses

{
  "success": true,
  "message": "Out of steps saved",
  "saved": true
}