Plum / developers
REST APIAudio

End a recording stream

Record where a stream ended, in the stream's own capture timeline. Set once: repeating the same end returns the stream; a different end, an end before a registered chunk, or an unknown stream is rejected. Chunks that extend past a recorded end are rejected.

POST/audio/streams/{id}/end

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

Path Parameters

id*string
Formatuuid

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

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/audio/streams/497f6eca-6276-4993-bfeb-53cbbbba6f08/end" \  -H "X-API-Version: 1" \  -H "Content-Type: application/json" \  -d '{    "end_ms": 0  }'
{  "success": true,  "data": {    "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"    }  }}

Rename a recording stream PATCH

Set or clear a stream's title. The title is the only editable field; the capture fields and external_ref are fixed at registration.

GET /audio/streams/{id}/signals GET

List a stream's signals by start time, then id. Filter by exact type and by an inclusive stream-time range: from_ms keeps signals that end at or after it (a moment ends where it starts) and to_ms keeps signals that start at or before it. Payloads are stored as sent; chat text is user content.