If an API call is unsuccessful, it returns an HTTP error code. If the error is known, you receive a message in the response body.
Known errors are returned in the response body in this format.
{
"message": "Invalid authentication scheme"
}
All
HTTP Code | HTTP Message | API Message | Resource | Possible Causes |
---|---|---|---|---|
401 | Unauthorized | Invalid access token | Any | The access token is expired. |
401 | Unauthorized | Invalid authentication scheme | Any | An |
5XX |
| None | Any | Our systems encountered and logged an unexpected error. Please contact us if you continue to see the error. |
Datasets
Error codes that can occur when you access datasets, labels, or examples.
HTTP Code | HTTP Message | API Message | Resource | Possible Causes |
---|---|---|---|---|
400 | Bad Request | None | Any dataset, label, or example resources. | The request couldn’t be fulfilled because the HTTP request was malformed, the Content Type was incorrect, there were missing parameters, or a parameter was provided with an invalid value. |
400 | Bad Request | The 'name' parameter is required to create a dataset. | POST | The |
400 | Bad Request | Uploading a dataset requires either the 'data' field or the 'path' field. | POST | The path to the local .zip file or the URL to the .zip file in the cloud wasn’t specified. |
400 | Bad Request | The 'data' parameter cannot be duplicated, nor sent along with the 'path' parameter. | POST | Both the |
400 | Bad Request | The dataset is not yet available for update, try again once the dataset is ready. | PUT | You’re adding examples to a dataset that’s currently being created. You must wait for dataset to become available before you can add examples to it. |
400 | Bad Request | Failed to download the dataset from the public URL. | POST | The API can't access the dataset file via the URL provided. When specifying the URL for a .zip file in a cloud drive service like Dropbox, be sure it's a link to the file and not a link to the interactive download page. For example, the URL should look like |
400 | Bad Request | Supported dataset types: [image, image-detection, image-multi-label] | POST | The |
400 | Bad Request | Example max size supported is 1024000 | POST | The image file being added as an example exceeds the maximum file size of 1 MB. |
404 | Not Found | None | Any dataset, label, or example resources. | The requested REST resource doesn’t exist or you don't have permission to access the resource. |
404 | Not Found | Unable to find dataset. | GET |
|
404 | Not Found | Unable to find dataset. | DELETE |
|
404 | Bad Request | Example file already exists for the label <NAME_OF_EXAMPLE> | POST | An example with the same name already exists in the dataset. Example names must be unique within a dataset. |
404 | Bad Request | Duplicate labels are not allowed. | POST | The call is trying to create a label with a name that exists in the dataset. Label names must be unique within a dataset. |
503 | Service Unavailable | Operation timed out! | GET | The call has timed out due to large data size. By default, this call returns 25 datasets. If the datasets contain a lot of examples, this call may time out. Use the |
Training
Error codes that can occur when you train a dataset to create a model or access a model.
HTTP Code | HTTP Message | API Message | Resource | Possible Causes |
---|---|---|---|---|
400 | Bad Request |
| POST | The |
400 | Bad Request | The 'name', and 'datasetId' parameters are required to train. | POST | The |
400 | Bad Request | Invalid id <MODEL_ID> | GET | There’s no model with an ID that matches the |
400 | Bad Request | Invalid id <MODEL_ID> | GET | There’s no model with an ID that matches the |
400 | Bad Request |
| GET | The model for which you are getting metrics hasn’t completed training. |
404 | Not Found | None | GET | The |
405 | Method Not Allowed | None | GET | The |
Prediction
Error codes that can occur when you make a prediction.
HTTP Code | HTTP Message | API Message | Resource | Possible Causes |
---|---|---|---|---|
400 | Bad Request | None | POST | The prediction request couldn’t be fulfilled because the HTTP request was malformed, the Content Type was incorrect, there were missing parameters, or a parameter was provided with an invalid value. |
400 | Bad Request | Bad Request: Bad sampleLocation | POST | The URL passed in the |
400 | Bad Request | The modelId parameter is required. | POST | The |
400 | Bad Request | Bad Request: Missing sampleLocation, sampleBase64Content, and sampleContent | POST | The parameter that specifies the image to predict is missing. |
400 | Bad Request | File size limit exceeded | POST | The file you passed in for prediction exceeds the maximum file size limit of 5 MB. |
400 | Bad Request | Bad Request: Unsupported sample file format | POST | The file you passed in for prediction isn’t one of the supported file types. |
403 | Forbidden | Forbidden! | POST |
|
429 | Too Many Requests | You've reached the maximum number of predictions. | POST | You have exceeded the number of prediction requests for your current plan. Contact your AE to update your plan. See Rate Limits. |