Skip to main content
POST
/
v1
/
phones
/
{phone_id}
/
flick
/
select
Flick by Description
curl --request POST \
  --url https://api.example.com/v1/phones/{phone_id}/flick/select
Flick (quick swipe) starting from an element described in natural language. Uses vision AI to find the element and flick from there.

​
Request

curl -X POST https://api.tapkit.ai/v1/phones/{phone_id}/flick/select \
  -H "X-API-Key: TK_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"selector": "the message list", "direction": "down"}'

​
Path Parameters

ParameterTypeDescription
phone_idstringThe phone identifier

​
Query Parameters

ParameterTypeDefaultDescription
asyncbooleanfalseReturn immediately with job ID

​
Request Body

{
  "selector": "the message list",
  "direction": "down"
}
FieldTypeDescription
selectorstringNatural language description of where to start the flick
directionstring"up", "down", "left", or "right"

​
Response

​
Synchronous

{
  "id": "job_abc123",
  "status": "completed",
  "result": {},
  "created_at": "2024-01-15T10:30:00Z",
  "completed_at": "2024-01-15T10:30:02Z"
}

​
Asynchronous

{
  "job_id": "job_abc123"
}

​
Examples

​
Scroll a List

curl -X POST https://api.tapkit.ai/v1/phones/abc123/flick/select \
  -H "X-API-Key: TK_..." \
  -H "Content-Type: application/json" \
  -d '{"selector": "the email inbox", "direction": "up"}'

​
SDK Usage

The Python SDK provides this through the flick() method with a string argument: 
phone.flick("the message list", "down")
phone.flick("the photo gallery", "left")
phone.flick("the settings menu", "up")
  • Flick - Flick at specific coordinates
  • Pan - Slower scroll gesture