Skip to main content
POST
Create, renew or regenerate an SDK licence

Authorizations

Authorization
string
header
required

Organisation API key, sent as Authorization: Bearer chk_live_….

  • chk_live_… — production inference, live credits, livemode: true, is_staging: false.
  • chk_stg_… — real inference classified as staging, the same live credits, livemode: true, is_staging: true.
  • chk_test_… — identical pipeline against the fixture backend, test credits, livemode: false.

Keys are stored hashed; only the prefix (chk_live_a1b2…) is ever displayed again. A key may be scoped to a subset of endpoint families — calling outside its scopes is a 403.

Path Parameters

sdk
enum<string>
required
Available options:
player,
capture,
review,
report

Body

application/json
regenerate
boolean
default:false

Sign a current paid-period licence again without extending expiry or consuming a slot; otherwise returns sdk_license_not_current

Response

Licence and derived quota; Cache-Control no-store

sdk
enum<string>
required
Available options:
player,
capture,
review,
report
state
enum<string>
required
Available options:
unassigned,
active,
expired
max_sdks
integer
required
Required range: x >= 0
consumed
integer
required
Required range: x >= 0
available
integer
required
Required range: x >= 0
license
null | object
required