Skip to main content
This reference documents customer contracts used by the official SDKs. It is not a mirror of the StackShift backend router.

​
Base URLs

  • Control plane SDKs: https://api.stackshift.cloud/api/v1
  • Mail SDKs: https://api.stackshift.cloud/v1
  • Mobile Observe: the application endpoint is supplied to the Flutter or React Native SDK; the verified route is /observe/{appKey}/events.

​
Authentication

Control-plane and Mail SDK operations send Authorization: Bearer <api-key>. Native video /playback routes use the API origin without /api/v1: public session creation is anonymous; renewal and events require an ephemeral playback credential. Picker search/select require a picker capability. Mobile Observe authenticates with the app key in the route and does not use the control-plane bearer token.

​
Static reference policy

These pages are static. No API playground is enabled, so credentials are never persisted or sent by Mintlify and mutations cannot be triggered from the docs site.

​
Product modules

  • Assets — 223 contract operations (165 with SDK evidence).
  • Projects — 1 contract operations (1 with SDK evidence).
  • StackShift Mail — 109 contract operations (108 with SDK evidence).
  • Mobile Observe — 1 contract operations (1 with SDK evidence).
  • AI Credits — 6 contract operations (6 with SDK evidence).
The generated SDK coverage report records the SDK method, request type, response type, route, and source file for every included operation.