API Reference

What to expect when things go wrong

Our API responds to incorrect requests with an appropriate HTTP status code and JSON error message. All non-200 response status codes are considered errors. The error codes used are provided in the table below.

HTTP Status Codes

CodeDescription
400Bad RequestThe server could not process the request. Ensure that the request parameters and body are correct.
404Resource Not FoundThe endpoint that the request was made to does not exist. Ensure that the endpoint was spelled correctly.
408Request TimeoutThis error occurs when a request fails to complete within the maximum time limit. The maximum limit is 180 seconds.
429Too Many RequestsYour request has exceeded the maximum number of requests allowed for the specified time period. Try reducing the rate at which you are sending requests. For more information on our rate limits refer to the Rate Limits section.
500Internal Server ErrorAn unexpected server issue was encountered.

Example

{
    "error": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again."
}

The above error message is obtained by making the following request:

curl --location --request POST 'https://api.syve.ai/v1/typo' \
--data-raw ''

The request above will return a 408 because the endpoint typodoes not exist.