API Reference
API Reference

Upload Insights Upload Folder

POST/api/v1/insights/folders/{folder_id}/upload-file

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

folder_id integer path required

Query parameters

call_id string query required

A unique identifier for the call

agent_number string | null query optional

The phone number or ID of the agent involved.

customer_number string | null query optional

The phone number or ID of the customer.

start_time string (date-time) | null query optional

The timestamp of the call's beginning

end_time string (date-time) | null query optional

The timestamp of the call's end.

duration number | null query optional

The call duration in seconds.

metadata string | null query optional

Request body

multipart/form-data

body Body_insights_folder_upload_file optional
1 field
filestring (binary)optional
Request example
{
  "file": "string"
}

Responses

200Successful Response

application/json

response InsightsUploadFile required
13 fields
idintegerrequired

System-assigned ID for the upload file

folder_idintegerrequired

System-assigned ID for the folder to which the file belongs

filenamestringrequired

Name of the uploaded file

object_keystringrequired

Object-store key of the uploaded file

call_idstring | nulloptional

Unique identifier for the call associated with the uploaded file

agent_numberstring | nulloptional

Agent number associated with the uploaded file

customer_numberstring | nulloptional

Customer number associated with the uploaded file

durationnumber | nulloptional

Length in seconds of the uploaded recording

start_timestring (date-time) | nulloptional

Start time of the uploaded file

end_timestring (date-time) | nulloptional

End time of the uploaded file

error_messagestring | nulloptional

Error message associated with the uploaded file

metadataobject | nulloptional

Meta-data associated with the uploaded file

1 options
{key}string | integer | numberoptional
3 options
Option 1stringoptional
Option 2integeroptional
Option 3numberoptional
created_atstring (date-time)optional

Timestamp at which insight upload file was created

Response example
{
  "id": 0,
  "folder_id": 0,
  "filename": "string",
  "object_key": "string",
  "call_id": "string",
  "agent_number": "string",
  "customer_number": "string",
  "duration": "string",
  "start_time": "string",
  "end_time": "string",
  "error_message": "string",
  "metadata": "string",
  "created_at": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}