Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

The control surface credential. Send Authorization: Bearer <token>.

Two kinds of token are accepted and they are told apart by shape, not by a separate header. A token beginning pbk_ or puk_ is an org scoped API key, whose public half and secret half are generated together and of which only a hash of the secret is ever stored; anything else is treated as an OAuth 2.1 access token and verified against the authorization server's keys.

Both resolve to the same context: an org, a principal and a set of scopes. Nothing downstream branches on which channel you used, with one deliberate exception, key management, which requires a signed-in person so that a key can never mint another key.

Scopes are enforced when MCP tools are REGISTERED rather than when they are called, so a tool your credential cannot use is absent from tools/list rather than refused mid gesture.

Headers

Idempotency-Key
string
required

The install request key, one per install request. It must have the form store.v2.<24 hex characters>., matching ^store.v2.[a-f0-9]{24}.[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ . The 24 hex characters bind the key to who is asking and to what they ask for. Work them out like this: (1) make a text value who = JSON.stringify([orgId, subject]), where subject is the signed-in person's userId, or the apiKeyId when an API key makes the call (apiKeyId is the id field of GET /v1/api-keys/current, not its keyId); (2) make a text value payload = JSON.stringify([who, deviceId, scopeId, appId, buildId]), where who is the text from step 1 (so it is quoted inside the list), deviceId, scopeId and appId and buildId are the values you send in the body, and scopeId is user_0; (3) take the sha256 of payload as lowercase hex and keep its first 24 characters; (4) join them as store.v2.<those 24 characters>.. Worked example: orgId org_example, apiKeyId key_example, deviceId device_example, scopeId user_0, appId telegram, buildId v12.10.1 and UUID 6f1c2a52-3b6e-4d0c-9a57-0d3c8f0b1e11 give store.v2.e22bfe7f226ee0e308ab9fe3.6f1c2a52-3b6e-4d0c-9a57-0d3c8f0b1e11 . A key built for another account, phone, app or build is refused with 400. Keep the key: if the answer is lost, send the same body with the same key to get the same installation back, or read it with GET /v1/app-store/installations/by-request/{requestKey}. A second key is a new request and is refused while the phone is held. [blocked]

Pattern: ^store\.v2\.[a-f0-9]{24}\.[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"store.v2.e22bfe7f226ee0e308ab9fe3.6f1c2a52-3b6e-4d0c-9a57-0d3c8f0b1e11"

Body

application/json

Trusted catalogue build and confirmed primary Android target, as for a direct install.

appId
string
required
Pattern: ^[a-z0-9._-]{1,36}$
buildId
string
required
Pattern: ^[a-z0-9._-]{1,36}$
deviceId
string
required
Required string length: 1 - 160
scopeId
string
required
Allowed value: "user_0"

Response

Accepted into the line, or started at once on a free phone.

entry
object
required