200 - OK

👍

The request was successful, and the file was uploaded and processed.

Response: JSON object containing the file Id, the File Name, and the File Size of file received.

Example:

{  
  "Id": "GUID",  
  "FileName": "filename.acxMedia",  
  "FileSizeKb": 1234  
}

400 - Bad Request

❗️

The request was malformed or did not meet the expected requirements.

Possible Responses:

🚧

"You must upload a file with one of the specified allowed extensions."

Please ensure the audio file you are uploading has one of these extensions: .wav, .mp3, .mp4, .ogg, .opus, .m4a

🚧

"You must upload metadata in the request form."

Include metadata in your upload request. Basic metadata is required for processing your file.

🚧

"Unable to properly parse metadata to chat or audio."

There was a problem processing the metadata provided. Check the format and content of your metadata and try again.

🚧

"You must upload valid data in your metadata request form payload."

The metadata appears to be invalid or incomplete. Verify the information in your metadata and resubmit.

🚧

"You must upload a valid file name with a valid file extension."

The file name in your metadata must end with a valid file extension such as .wav, .mp3, etc. Update the file name in your metadata accordingly.

🚧

"File extension in metadata file name and upload file must match!"

The file extension mentioned in your metadata does not match the extension of the file you uploaded. Ensure both extensions are the same.

🚧

Error Message: "An interaction with this file name already exists."

A file with the same name specified in your metadata already exists in the system. Please provide a unique file name.

🚧

"Unsupported locale id provided. Supported locale ids include: 1033, 2058."

The LocaleId provided in your metadata is not supported. Please use one of the supported locale IDs.

🚧

"Invalid Hierarchy Id/Code! You must either specify a valid hierarchy id/code from your organization or omit a hierarchy id/code entirely."

The hierarchy ID or code provided in your metadata is invalid or not recognized by the system. Please check the hierarchy details and try again.

🚧

"Invalid metadata form object. Please upload metadata in the expected form."

There was an unexpected error while processing your metadata. Please review your metadata and try again.

500 Internal Server Error

❗️

An unexpected server error occurred while processing the request.

A detailed error response will be provided.