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 enum distance
await box.action.swipe({
direction: "up",
distance: "medium",
duration: "500ms"
});
// Swipe with custom pixel distance
await box.action.swipe({
direction: "up",
distance: 300,
duration: "500ms"
});
// Swipe with natural language location
await box.action.swipe({
direction: "up",
distance: 300,
duration: "500ms",
location: "screen bottom"
});
// Swipe with custom path
await box.action.swipe({
start: { x: 100, y: 150 },
end: { x: 400, y: 300 },
duration: "200ms"
});
// Swipe with natural language location
await box.action.swipe({
start: "screen bottom",
end: "screen top",
duration: "200ms"
});
}
main();
{
"message": "Action executed successfully",
"screenshot": {
"trace": {
"uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."
},
"before": {
"uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."
},
"after": {
"uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."
}
}
}
Performs a swipe in the specified direction
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 enum distance
await box.action.swipe({
direction: "up",
distance: "medium",
duration: "500ms"
});
// Swipe with custom pixel distance
await box.action.swipe({
direction: "up",
distance: 300,
duration: "500ms"
});
// Swipe with natural language location
await box.action.swipe({
direction: "up",
distance: 300,
duration: "500ms",
location: "screen bottom"
});
// Swipe with custom path
await box.action.swipe({
start: { x: 100, y: 150 },
end: { x: 400, y: 300 },
duration: "200ms"
});
// Swipe with natural language location
await box.action.swipe({
start: "screen bottom",
end: "screen top",
duration: "200ms"
});
}
main();
{
"message": "Action executed successfully",
"screenshot": {
"trace": {
"uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."
},
"before": {
"uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."
},
"after": {
"uri": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUA..."
}
}
}
Enter your API Key in the format: Bearer <token>. Get it from https://gbox.ai
Box ID
"c9bdc193-b54b-4ddb-a035-5ac0c598d32d"
Simple swipe action configuration. The gesture will be performed from the center of the screen towards the specified direction.
Result of an UI action execution with optional screenshots