Skip to main content
POST
Register an application desktop identity

Authorizations

Authorization
string
header
required

Use Authorization: Bearer pyai_live_... (or pyai_test_...).

Body

application/json
number_id
string
required
user_id
string
required
Required string length: 1 - 200
client_reference
string
required
Required string length: 1 - 200
label
string
required
Required string length: 1 - 120

Response

Original stable registration

object
any
required
id
string
required
Pattern: ^dsk_[a-f0-9]{32}$
project_id
string
required
user_id
string
required

Application-defined actor in this project; not a global PyAI user ID.

actor_type
any
required
label
string
required
registered
boolean
required
available
boolean
required

Fresh app readiness lease; not proof a future call will connect.

number_id
string
required
status
enum<string>
required
Available options:
active,
revoked