Plum / developers
REST APIAudio

List recording streams

List the account's recording streams, newest capture first: by captured_at, or registration time for a stream without one, then by id. Streams of deleted sources are omitted.

GET/audio/streams

Authorization

bearerAuth
AuthorizationBearer <token>

Send Authorization: Bearer <token> with one of: an app session access token from /auth/verify-otp or /auth/refresh; an OAuth access token from /oauth/token issued for the API origin (its scopes are its permissions); or a personal access token starting with optima_pat_ (see /docs/personal-access-tokens). Personal access tokens cannot create or list tokens, revoke other tokens, sign out, or delete or restore the account. Content routes need the permission of their layer: audio:read/audio:write for recordings, turns:read/turns:write for turns, contacts, source signals, and events, and insights:read/insights:write for suggestions and session summaries; search and recall need turns:read and insights:read. A request without the permission, or for an account whose layer is turned off, returns 403 FORBIDDEN. See /docs/authentication#scopes.

In: header

Query Parameters

source_id?string

Only this source's streams.

Formatuuid
external_ref?string

Only the stream with this external_ref (one per source).

Length1 <= length <= 200
cursor?string
Length1 <= length <= 1024
limit?integer
Range1 <= value <= 100
Default25

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"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/audio/streams" \  -H "X-API-Version: 1"
{  "success": true,  "data": {    "items": [      {        "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",        "source_stream_ref": "80c07f33-6153-4ead-a2bf-b1b810964c48",        "captured_at": "2019-08-24T14:15:22Z",        "clock_uncertainty_ms": 0,        "end_ms": 0,        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "title": "string",        "external_ref": "string",        "audio": {          "state": "string",          "removed_at": "2019-08-24T14:15:22Z"        }      }    ],    "cursor": "string"  }}

Create an audio upload intent POST

Declare an Ogg Opus or PCM16 WAV chunk. Codec and container must be a matching pair.

Create a recording stream POST

Register a recording stream. Repeating a registration returns the same stream with its recorded end and current title. Include end_ms when the stream is already finished (an import or file dump) to record its end with it. An optional title labels the recording; an optional external_ref is your own identifier for it, unique among the source's streams. A registration whose external_ref another stream of the source already uses, or a retry that changes captured_at, clock_uncertainty_ms, or external_ref, returns 409.