Skip to main content
GET
/
v1
/
phones
/
{phone_id}
/
settings
Get Settings
curl --request GET \
  --url https://api.example.com/v1/phones/{phone_id}/settings

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.

Retrieve the current settings for a phone, including typing method and speed configuration.

​
Request

curl https://api.tapkit.ai/v1/phones/{phone_id}/settings \
  -H "X-API-Key: joot_your_api_key"

​
Path Parameters

ParameterTypeDescription
phone_idstringThe phone identifier

​
Response

{
  "typing_method": "shortcut",
  "speed": 30
}

​
Response Fields

FieldTypeDescription
typing_methodstringDefault typing method: "shortcut" or "keys"
speednumberSwitch control scanning speed: 30 (slow) or 90 (fast)

​
Examples

​
Python

import requests

response = requests.get(
    "https://api.tapkit.ai/v1/phones/{phone_id}/settings",
    headers={"X-API-Key": "joot_..."}
)
settings = response.json()

print(f"Typing method: {settings['typing_method']}")
print(f"Speed: {settings['speed']}")

​
SDK

from tapkit import TapKitClient

client = TapKitClient(api_key="joot_...")
phone = client.get_phone("phone_id")

settings = phone.get_settings()
print(f"Typing method: {settings.typing_method}")
print(f"Speed: {settings.speed}")

​
Notes

  • See Phone Settings for detailed explanations of each setting
  • See Typing for information about typing methods