Error codes
V‑Spark API endpoints return the errors below. Note that /transcribe
, /request
, and /config
use some endpoint-specific errors.
General
- Can not delete multiple items
A request to delete multiple objects was made to the
/config
API, but themulti=true
parameter was not specified- Can not delete non-empty object
A request to delete an object that contains other objects was made to the
/config
API, but thetree=true
parameter was not specified- Error parsing search results
The ElasticSearch server returned results based on your call to the
/search
API, but those results could not be converted into the output format used by the V‑Spark API for this call- Invalid JSON
Any V‑Spark API that accepts JSON content does a check to determine the validity of any JSON content that is POSTed, and returns this error if the JSON is not valid
- Invalid output option
The
/search
was called with an output option other thancount
,details
,summary
orzip
- Invalid template option: template-name
A request to upgrade an application was made, but the specified application is based on a template that no longer exists in V‑Spark. You will have to delete and recreate the application.
- Search Error
The command syntax used in a
/search
API call is incorrect, or the ElasticSearch server is not available.
/transcribe
- 400
The
/request
API returns a 400 in cases when the authentication token that is required to access V‑Spark is missing or invalid, or when S3 authentication information is invalid. The error text differs based on the cause of the error, and helps identify the cause of the problem:- Bad request
Content is being submitted via the S3 protocol and the S3 key information that is required to access a given bucket was invalid or was not provided.
- Missing "token" field
No authorization token was provided in your call to the
/request
API.- Invalid token was provided
The authorization token that was used in your call to the
/request
API is not correct.
- 402
The
/transcribe
API returns a 402 in response to attempts to exceed the usage models that are associated with the V‑Spark instance that you are running on:- Usage Limit is reached
You have reached the size limit of the amount of audio data that you are licensed to process. To increase that limit, contact your Voci sales representative or send email to Voci product support (support@vocitec.com).
- 404
The
/transcribe
API returns a 404 in response to multiple errors. The error text differs based on the cause of the error, and helps identify the cause of the problem:- Company not found
V‑Spark can look up the name of the company that you are using based on the value that you passed for the
ORG_SHORT
parameter. The value that you specified for this parameter is incorrect.- Folder folder-name not found
The folder that was passed as a parameter does not exist or cannot be accessed.
- Organization organization-name not found
The organization whose short name was passed as a parameter does not exist or cannot be accessed.
- 406
The
/transcribe
API returns a 406 in response to errors where the data that it is POSTing is not acceptable to its client, the V‑Spark server. The error text differs based on the cause of the error, and helps identify the cause of the problem:- File size is too large. File should be smaller than LIMIT
The size of the uploaded file is larger than the displayed LIMIT. This limit is configurable via the
transcribe_api_upload_limit
configuration variable, so the text of this error may vary.
- 500
The
/transcribe
API returns a 500 in response to serious internal errors that reflect a hardware, software, or configuration error on the system where V‑Spark is running. Contact Voci product support (support@vocitec.com) for assistance in identifying and resolving the problem.
/request
- 400
The
/request
API usually returns a 400 in cases when the authentication token that is required to access V‑Spark is missing or invalid. The error text differs based on the cause of the error, and helps identify the cause of the problem:- Auth token doesn't match
The authorization token that was used in your call to the
/request
API is not correct.- Request not finished
The results that you requested are not yet available.
- 404
The
/request
API returns a 404 in response to multiple errors. The error text differs based on the cause of the error, and helps identify the cause of the problem:- Company not found
V‑Spark can look up the name of the company that you are using based on the value that you passed for the
ORG_SHORT
parameter. This error means that the value that you specified for this parameter was incorrect.- No file types were specified
The default JSON output format was disabled in your call to the
/request
API, but you did not enable another format (mp3
ortext
)- Organization organization-name not found
The organization whose short name was passed as a parameter does not exist or cannot be accessed
- RequestFile not found
This message indicates a problem communicating with the database that is used by V‑Spark. Retrying the operation should succeed. If you continue to see this message, contact Voci product support (support@vocitec.com).
- RequestId not found
The request ID that was passed as a parameter does not exist. Check for typographical errors if testing the
/request
API call from the command line, or check your application code to ensure that you are storing and using a valid request ID.
/config/folders
- 400
The
/config/folders
API returns a 400 in cases when the configuration being set via the update is invalid. The error text differs based on the cause of the error, and helps identify the cause of the problem:- Folder [folder name] is disabled due to company-level policies
You are attempting to resume processing of a paused folder, but that folder cannot be resumed because it has been disabled. Usually, this is because the folder was paused due to company limit hours being met.