Skip to main content
POST
/
v1
/
core
/
recordings
/
upload
Create a recording from uploaded audio
curl --request POST \
  --url https://api.siro.ai/v1/core/recordings/upload \
  --header 'Content-Type: application/json' \
  --header 'x-siro-auth-token: <api-key>' \
  --data '
{
  "fileUrl": "<string>",
  "fileType": "mp3",
  "title": "<string>",
  "userId": "<string>",
  "userEmail": "<string>",
  "userPhone": "<string>",
  "organizationId": "<string>",
  "conversationType": "<string>",
  "integrationConnectionId": "<string>",
  "crmObjects": [
    {
      "objectType": "Opportunity",
      "objectId": "<string>"
    }
  ],
  "contactPhone": "<string>",
  "contactName": "<string>",
  "dateCreated": "2023-11-07T05:31:56Z"
}
'
{
  "data": {
    "id": "<string>"
  }
}

Authorizations

​
x-siro-auth-token
string
header
required

Custom authentication token for user-scoped endpoints

Body

application/json

Validation rules: at least one of userId, userEmail, or userPhone must be a non-empty string. integrationConnectionId and crmObjects must both be provided or both omitted. Properties not listed here are rejected.

​
fileUrl
string<uri>
required

Download URL from the signed-urls response (the downloadUrl returned by POST /v1/core/recordings/signed-urls).

​
fileType
enum<string>
required
Available options:
mp3,
aac,
wav
​
title
string

Title of the recording.

​
userId
string

ID of the user who created the recording.

​
userEmail
string

Email of the user who created the recording

​
userPhone
string

Phone number of the user who created the recording

​
organizationId
string

ID of the organization associated with the recording.

​
conversationType
string

Conversation type for the recording to be analyzed against. Falls back to default conversation type

​
integrationConnectionId
string

Integration connection id. Retrieve via GET /v1/core/integrations/connections. Must be omitted unless crmObjects is also provided (and vice versa).

​
crmObjects
object[]

CRM objects to link to the recording. Must be omitted unless integrationConnectionId is also provided (and vice versa).

​
contactPhone
string

Contact phone number for purposes of linking to CRM objects. Ignored if CRM objects are passed.

​
contactName
string

Contact name for purposes of linking to CRM objects. Ignored if CRM objects are passed.

​
dateCreated
string<date-time>

When the recording was created.

Response

201 - application/json

Created

​
data
object