Automation Interface HTTP API

Getting started

ADB should be running on its default port.

You can ensure this by executing the following command.

adb start-server

Start GameBench Automation Interface server. You can follow the steps here or use Docker. If you don’t have quay.io credentials, please contact support@gamebench.net.

docker run \
    -e GBA_SERVER_CONFIG_PATH=/var/gamebench/gbconfig.json \
    -e GBA_SERVER_HTTP_HOST=127.0.0.1 \
    -e GBA_SERVER_HTTP_PORT=8000 \
    -v $(pwd):/var/gamebench \
    --rm \
    --net=host \
    quay.io/gamebench/automation-server:v1.5.0

Client libraries

We have client libraries for:

API endpoints

List devices

Endpoint

GET /devices

Response

application/json

200

[
    {
        "id": "a-device-id",
        "name": "Example"
    }
]

Retrieve a device

Endpoint

GET /devices/{deviceId}

Response

application/json

200

[
    {
        "id": "a-device-id"
    }
]

Retrieve a device’s apps

Endpoint

GET /devices/{deviceId}/apps

Response

application/json

200

[
    {
        "id": "an-app-id"
    }
]

List sessions

Endpoint

GET /sessions

Query parameters

Parameter Type Required Default
type string No active

Response

application/json

200

[
    {
        "id": "an-example-id"
    }
]

Start a session

Endpoint

POST /sessions

Request body

Request content-type: application/json

Parameter Type Required Default
deviceId string Yes
appId string Yes
username string Yes
passOrToken string Yes
useToken boolean No false
autoSync boolean No false
screenshots boolean No false

Response

application/json

200

{
    "id": "an-example-id"
}

Stop a session

Endpoint

POST /sessions/{sessionId}/stop

Response

204