Plum / developers
REST APIDevice

Create a device upload intent

Create a chunk upload intent for a bound device. 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/chunks/intents

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/chunks/intents" \  -H "X-API-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "source_chunk_ref": "a4154243-2c96-461b-a3b4-7197e9cf1034",    "source_stream_ref": "80c07f33-6153-4ead-a2bf-b1b810964c48",    "sequence": 0,    "source_start_ms": 0,    "publication_start_ms": 0,    "source_end_ms": 1,    "codec": "string",    "container": "string",    "size_bytes": 1,    "sha256": "string",    "binding_epoch": "f92bd0f6-ad82-48f7-b45e-7b07b52b3f71"  }'
{  "success": true,  "data": {    "source_chunk_ref": "a4154243-2c96-461b-a3b4-7197e9cf1034",    "chunk_id": "55e808e1-8ddc-49f1-92c9-6bbdcdff1c83",    "upload_path": "string"  }}

Get device chunk status GET

Read processing status for a bound device's chunk. 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).

Redeem a device claim POST

Redeem a claim using a provisioned, verified mTLS device client certificate. A personal device redeems an owner claim to establish its account binding; a shared recorder redeems a session claim to start that session. When redeeming a session claim, include the recorder's own `ble_address` (12 uppercase hex digits, no colons) so phones can find the session from its tag; owner claims ignore it. A BLE address already reported by another open session returns 409 CONFLICT. Set Content-Type to application/json or application/cbor for the request body. Set Accept to application/json or application/cbor for the response; omitted or wildcard Accept selects JSON. See [Devices](/docs/devices).