API Reference

{
  "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" }
}

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

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

{
  "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" }
}

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

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

{ "device_id": "device_123456" }

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

{ "success": false, "message": "Invalid device_id or device not found" }

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

{
  "logs": [
    {
      "id": "e0e1a3ef-7b2a-42b5-8f21-b845fa41c8b9",
      "automationId": "550e8400-e29b-41d4-a716-446655440000",
      "message": "Processing screen content...",
      "lineNumber": 42,
      "messageLevel": "log",
      "timestamp": 1755811585870
    }
  ]
}

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

{ "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'."]
}

{ "message": "Automation project not found or access denied" }

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

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

{ "message": "File or automation project not found" }

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

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

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

{ "message": "Automation project not found or access denied" }

{
  "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/.../ui_....json",
        "screenshot": {
          "screenshotUrl": "https://server.com/outofsteps/.../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
}

{ "status": "solved" }

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

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

{ "message": "You don't have permission to mark this out of steps record" }

const API_BASE = "https://xgodo.com";
const TOKEN = "your_api_token";

async function runDirectAutomation(deviceId: string, code: string) {
  const launchId = crypto.randomUUID();

  const launchRes = await fetch(`${API_BASE}/api/v2/devices/launchDirectAutomation`, {
    method: "POST",
    headers: { "Content-Type": "application/json", "Authorization": `Bearer ${TOKEN}` },
    body: JSON.stringify({
      device_id: deviceId,
      launch_id: launchId,
      command: "start",
      code,
      automationParameters: { maxRetries: 3 },
      jobVariables: { targetUrl: "https://example.com" }
    })
  });

  const launchData = await launchRes.json();
  if (!launchData.success) throw new Error(launchData.message);

  let lastLogId: string | undefined;

  const pollLogs = async () => {
    const logsRes = await fetch(`${API_BASE}/api/v2/devices/automationLogs`, {
      method: "POST",
      headers: { "Content-Type": "application/json", "Authorization": `Bearer ${TOKEN}` },
      body: JSON.stringify({ device_id: deviceId, automation_ids: [launchId], from: lastLogId })
    });
    const logsData = await logsRes.json();
    for (const log of logsData.logs) {
      console.log(`[${log.messageLevel}] ${log.message}`);
      lastLogId = log.id;
    }
  };

  const interval = setInterval(pollLogs, 2000);

  setTimeout(async () => {
    clearInterval(interval);
    await fetch(`${API_BASE}/api/v2/devices/stopAllAutomations`, {
      method: "POST",
      headers: { "Content-Type": "application/json", "Authorization": `Bearer ${TOKEN}` },
      body: JSON.stringify({ device_id: deviceId })
    });
  }, 60000);
}