API reference / Devices
Discover device capabilities
Returns relay tools plus tools advertised by a currently authorized bridge seen within 15 seconds.
/api/v1/devices/{deviceId}/capabilitiesAuthorization
devices:readSend Authorization: Bearer <FLEETDECK_API_KEY> with the scope above. The key must also grant access to the target device. Authentication guide ↗
Request example
curl --request GET \
--url 'https://fleetdeck.co/api/v1/devices/device_123/capabilities' \
--header "Authorization: Bearer $FLEETDECK_API_KEY"Replace example IDs with returned values. Read credentials from your private environment.
Response examples
{
"deviceId": "device_123",
"platform": "android",
"coordinateSpace": "normalized",
"coordinates": "x and y are 0..1 of the current screenshot; inspect again after rotation",
"backend": "relay",
"capabilities": {
"tools": [
"screenshot",
"tap",
"double_tap",
"long_press",
"swipe",
"text",
"key",
"button",
"launch_app",
"kill_app",
"set_clipboard",
"apps",
"open_url",
"push_media",
"media_chunk"
],
"acknowledgement": "Relay input is submitted only; use a fresh screenshot to verify the intended change",
"limitations": [
"UI hierarchy, clipboard reads and privileged tools require a native bridge"
]
}
}Path parameters
deviceIdstringrequiredExact device ID from List devices. The current key must grant access to this phone.
"device_123"Validation pattern
^[A-Za-z0-9._:-]+$Request body
This endpoint does not require a request body.
Behavior and limits
Returns relay tools plus tools advertised by a currently authorized bridge seen within 15 seconds. Native tool descriptors retain their inputSchema. Discovery indicates available routes, not guaranteed support for every parameter, device state or app.
Response 200
Capabilities · application/json
deviceIdstringalways presentExact device ID from List devices. The current key must grant access to this phone.
"device_123"Validation pattern
^[A-Za-z0-9._:-]+$platformstringalways presentPhone platform reported by the device, such as ios or android.
"android"coordinateSpacestringalways presentCoordinate convention for common FleetDeck actions. Normalized x/y values are relative to the current screen.
"normalized"coordinatesstringalways presentHuman-readable guidance for translating screen coordinates into action coordinates.
"x and y are 0..1 of the current screenshot; inspect again after rotation"backendstringalways presentActive driver route, or the native backend reported by a registering bridge.
"relay""bridge+relay"capabilitiesobjectalways presentCurrently advertised commands, native extensions and limitations.
View child fields
toolsstring[]always presentCommand names supported by this device or advertised by this bridge.
nativeToolsany JSON[]optionalDiscovered upstream descriptors, normally name, description and inputSchema. Validate arguments against each tool’s inputSchema.
nativeBackendstringoptionalNative bridge backend, present when a fresh bridge is registered.
acknowledgementstringalways presentWhat driver acknowledgement guarantees. Submission alone does not verify a physical effect.
"Relay input is submitted only; use a fresh screenshot to verify the intended change"limitationsstring[]always presentPlatform and driver constraints to account for before executing work.
Errors
Expand a code for its recovery steps. Responses use error and code; validation errors also include issues.
401UNAUTHORIZEDMissing, malformed, expired or revoked credential; user verification/password state can also deny access.
Recovery: Use Authorization: Bearer with a valid scoped key. For dashboard routes, sign in. Job children require an active parent job and timely renewal.
Full error reference ↗403FORBIDDENRequired scope, device grant, account membership or worker identity is missing.
Recovery: Check the endpoint’s scopes, exact device, owning key and workerId. A different key cannot access the original key’s sessions or jobs.
Full error reference ↗404NOT_FOUNDUnknown route or resource unavailable to this caller.
Recovery: Check method/path and use returned IDs from this account/key. Do not guess IDs.
Full error reference ↗402PLAN_REQUIREDDevice account has no active entitlement.
Recovery: Restore an active device entitlement in the workspace before controlling it.
Full error reference ↗500INTERNALUnexpected service error.
Recovery: Save nonsecret request context and time for support. Query action status before repeating a mutation; never assume it did not execute.
Full error reference ↗Example error messages are illustrative. Match the code and HTTP status; do not depend on exact message wording.
