All systems normalDashboardGet an API key
API reference / Devices, signing & primitives / Provision device

Provision device

A dedicated mobile device context pinned to a city.

POSTapi.tikultra.com/v1/devices/provisionHeavy · 10 credits
Upstream
/service/2/device_register/
Access
Growth and up
Runs on
Primitive
Client
os, app_flavour, app_version selectable
Billing
Failed calls are free
Older path
/v1/contexts/provision

Authorization

x-api-keyheader · stringrequired

Your API key. Create one in API keys.

Body

Send JSON with content-type: application/json.

osstring

android or ios. One of android, ios.

app_flavourstring

Which app to run as. One of tiktok, lite, lite_coin, pro, studio, shop, tv, douyin.

app_versionstring

A release of that app. Defaults to the current default for (os, app_flavour). For example 47.6.3.

regionstringrequired

Two-letter country code for egress and storefront. For example US.

citystring

A city in that region. See the supported cities list. For example miami.

hardware_templatestring

One of 237 Android or 15 iOS hardware profiles. Omit for a random one.

Response

A 200 returns JSON with stable field names. Every response carries x-credits-cost, x-credits-tier and x-credits-remaining.

Errors

Errors return a JSON body with a stable code and cost 0 credits. See Errors and retries.