POST
/
boxes
/
{boxId}
/
actions
/
swipe
JavaScript
import GboxSDK from "gbox-sdk";

const gboxSDK = new GboxSDK({
  apiKey: process.env["GBOX_API_KEY"] // This is the default and can be omitted
});

async function main() {
  const box = await gboxSDK.create({ type: "android" });

  // Swipe up
  await box.action.swipe({
    direction: "up",
    duration: "200ms"
  });

  // Swipe with custom path
  await box.action.swipe({
    start: { x: 100, y: 150 },
    end: { x: 400, y: 300 },
    duration: "200ms"
  });
}

main();
{
  "screenshot": {
    "trace": {
      "uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."
    },
    "before": {
      "uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."
    },
    "after": {
      "uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."
    }
  }
}

Authorizations

Authorization
string
header
required

Enter your API Key in the format: Bearer <token>. Get it from https://gbox.ai

Path Parameters

boxId
string
required

Box ID

Example:

"c9bdc193-b54b-4ddb-a035-5ac0c598d32d"

Body

application/json

Simple swipe action configuration. The gesture will be performed from the center of the screen towards the specified direction.

Response

200 - application/json

Result of an UI action execution with screenshots