Plum / developers
REST APIDevice

End a session from the recorder

End a shared recorder's session after its upload backlog has drained; the recorder becomes idle and the recordings stay with the host. Once ended, or once the 15-minute drain window after the scheduled end passes, this and every bound-device route return 403 DEVICE_UNBOUND, which a repeated end treats as success. A personal device returns 409 CONFLICT. Set Content-Type to application/json or application/cbor for the request body. Requires a provisioned, verified mTLS device client certificate and an account binding. Set Accept to application/json or application/cbor for the response; omitted or wildcard Accept selects JSON. See [Devices](/docs/devices).

POST/device/session/end

Header Parameters

X-API-Version?"1"

Send 1 to pin the documented API contract. If omitted, the latest version is selected.

Default"1"

Value in

  • "1"

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/device/session/end" \  -H "X-API-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "binding_epoch": "f92bd0f6-ad82-48f7-b45e-7b07b52b3f71"  }'
Empty

Check the device's account GET

Read the device's binding. Every 200 and 403 DEVICE_UNBOUND reply carries `X-A5-Binding-State`, an opaque token that changes whenever the binding the device must act on changes. Send it back as `known` with `wait` to long-poll: while the state still equals `known`, the reply is held until the state changes or `wait` seconds pass, and then carries `X-A5-Held: 1`. Ask again at once after a held reply or a changed state; after an immediate reply with an unchanged state and no `X-A5-Held`, wait before asking again. Other errors are never held. Requires a provisioned, verified mTLS device client certificate and an account binding. Set Accept to application/json or application/cbor for the response; omitted or wildcard Accept selects JSON. See [Devices](/docs/devices).

Create a device stream POST

Register a stream for a bound device. Repeating a registration returns the same stream with its recorded end; include end_ms when the stream is already finished. Set Content-Type to application/json or application/cbor for the request body. Requires a provisioned, verified mTLS device client certificate and an account binding. Set Accept to application/json or application/cbor for the response; omitted or wildcard Accept selects JSON. See [Devices](/docs/devices).