Skip to main content
POST
Create a recording to represent captured audio. After creation, use the upload endpoints to upload the audio file.

Authentication

This endpoint accepts either an API key or a device token. Device tokens automatically bind the recording to the token’s device and end user.

Request Body

string
ID of the device that captured the recording. Device tokens set this automatically.
string
ID of the end user associated with the recording. Device tokens set this automatically.
string
Optional human-readable name.
string
ISO 8601 timestamp for when the audio was recorded.
object
Arbitrary key-value metadata.
boolean
Set to true for chunked streaming uploads.
string
Upload method. Supported values include ble, wifi_direct, 4g_direct, import, and unknown.
string
Audio source. Supported values are device, app_import, and api_upload.
integer
Optional storage encryption audit version.

Response

Returns the created recording object.

Recording Status

Next Steps

  1. Get an upload URL, or use chunk URLs for streaming uploads
  2. Upload audio to S3
  3. Mark upload complete or finalize streaming
  4. Create a transcription