Skip to main content
With the phone agent you don’t send single actions. You write a task, and the agent looks at the screen, picks one action, looks again, and repeats until the screen shows that the task is done. You can run it from two places:
  • The Agent panel on the Phone page of Appeeky Desktop.
  • POST /v1/phones/agent, which streams each step. See below.
The phone agent uses 0 API credits. Your Mac must be sharing the phone. See Connect phones.

How a run works

  1. The agent takes an observation of the phone.
  2. It chooses one action: tap, type, swipe, scroll, press a key or open an app.
  3. The action runs on the phone. A tap on a button like Post, Send or Buy waits for your approval first.
  4. Steps 1 to 3 repeat until the agent reports that it is done, or it reaches the step limit.

Rules the agent follows

  • If you deny an approval, or it expires, the agent stops and explains. It does not look for another way to do the same thing.
  • It never enters passwords, codes or payment details that you didn’t include in the task.
  • It leaves text that a field already holds, such as a signature or a draft, unless the task says to remove it.
  • It reads the state of a switch or checkbox before tapping it, and leaves it alone when it is already right.
  • It reports the task as done only after the newest screen shows it.

Run a task with the API

The response has the content type application/x-ndjson. Each line is one JSON event:
The stream ends after a done or error event.

How runs end

To stop a run, close the connection. The agent stops before its next step.
A request with a missing or too long task returns a normal JSON error with status 400 and the code INVALID_REQUEST. After the stream has started, the HTTP status is 200 and problems arrive as error events.

Write good tasks

  • Name the app and the result. Open Instagram and post the newest photo in the gallery with the caption “Launch day” is better than post my photo.
  • Give the exact text. Captions, messages and search terms should be in the task word for word.
  • Prepare the phone. Unlock it, sign in to the app yourself, and put the media in the gallery before the run.
  • One goal per task. Thirty steps go fast. Split long jobs into several tasks.
  • Stay near the dashboard. A post or send needs your approval within 10 minutes.