Skip to main content
Upload audio recording
curl --request POST \
  --url https://{tenantId}.api.nestmed.com/api/v1/visits/{visitId}/audio \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form recordingType=ambient \
  --form startTime=2023-11-07T05:31:56Z \
  --form endTime=2023-11-07T05:31:56Z \
  --form 'metadata={}'
{
  "audioId": "<string>",
  "taskId": "<string>",
  "status": "queued"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string<uuid>

A unique key (e.g., UUID) to ensure a POST request is processed only once. If a request with the same key is received again within 24 hours, the original response will be returned without creating a new resource.

Path Parameters

​
visitId
string
required

Body

multipart/form-data
​
file
file
required
​
recordingType
enum<string>
required
Available options:
ambient,
dictation,
phone
​
startTime
string<date-time>
​
endTime
string<date-time>
​
metadata
object

Response

202 - application/json

Audio accepted for processing.

​
audioId
string
required

The unique identifier for the uploaded audio.

​
taskId
string
required

Task ID to poll for processing status (transcription, analysis).

​
status
enum<string>
required

Initial processing status.

Available options:
queued,
processing