Skip to main content
POST
/
v1
/
phones
/
{phone_id}
/
read-clipboard
Read Clipboard
curl --request POST \
  --url https://api.example.com/v1/phones/{phone_id}/read-clipboard

Documentation Index

Fetch the complete documentation index at: https://docs.tapkit.ai/llms.txt

Use this file to discover all available pages before exploring further.

Read the current text value from a phone’s clipboard using the installed TapKit iOS Shortcut.

​
Request

curl -X POST https://api.tapkit.ai/v1/phones/{phone_id}/read-clipboard \
  -H "X-API-Key: joot_your_api_key"
No request body required.

​
Path Parameters

ParameterTypeDescription
phone_idstringThe phone identifier

​
Query Parameters

ParameterTypeDefaultDescription
asyncbooleanfalseReturn immediately with job ID

​
Synchronous Response

Returns the clipboard text directly when async=false or omitted: 
{
  "text": "https://www.instagram.com/p/example/",
  "empty": false,
  "job_id": "job_abc123"
}
FieldTypeDescription
textstringClipboard text returned by the phone
emptybooleanWhether the returned text is empty
job_idstringJob that tracked the clipboard read

​
Asynchronous Response

When ?async=true: 
{
  "job_id": "job_abc123"
}
Poll GET /v1/jobs/{job_id} for completion. The completed job result contains text and empty.

​
Notes

  • Reads text clipboard content only.
  • Requires the TapKit iOS Shortcut to be installed and updated.
  • The returned clipboard text is stored in the job result.