Skip to main content
POST
/
recordings
/
upload
Upload a recording
curl --request POST \
  --url https://api.alpharun.com/api/v1/recordings/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form audio='@example-file' \
  --form [email protected] \
  --form recorded_at=2023-11-07T05:31:56Z \
  --form 'contacts={
  "email": "[email protected]",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone_number": "<string>",
  "ext_id": "<string>",
  "custom_fields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ]
}' \
  --form playbook_id=3c90c3cc-0d44-4b50-8888-8dd25736052a
{
  "data": {
    "recording": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

multipart/form-data
​
audio
file
required
​
teammate_email
string<email>
required
​
recorded_at
string<date-time>
required

The date and time when the recording was made. Accepts ISO 8601 format with optional timezone specification (e.g., '2024-01-15T14:30:00Z' or '2024-01-15T14:30:00-05:00'). We encourage you to specify the TZ if available.

​
contacts
object[]
required

At least one of email, phone number and ext id must be not null on the contact. Contacts are unique per email, phone number, or ext_id. No two contacts can have the same email, phone number, or ext_id.

Minimum array length: 1
​
playbook_id
string<uuid>

The ID of the playbook to use for the assessment. If omitted, the playbook will be determined by the routing rules defined in https://app.alpharun.com/settings/playbooks (based on the teammate group the teammate belongs to). If no matching routing rules is found, the request will be rejected.

Response

Recording already exists

​
data
object