It may occur that we have issues understanding or processing your request. Under these circumstances, the response will resolve with an error object providing insight into what went wrong.
Copilot follows conventional HTTP response codes to indicate the success or failure of an API request and uses the following codes:
|200||OK -- Everything worked as expected.|
|400||Bad Request -- The request was unacceptable, typically due to missing a required parameter.|
|401||Unauthorized -- No valid API key provided.|
|404||Not Found -- The requested resource doesn't exist.|
|429||Too Many Requests -- Too many requests hit the API too quickly.|
|500||Internal Server Error -- There was an error with Copilot's servers. Try again later or contact Copilot support.|
Some errors that could be handled programmatically (e.g., a parameter is invalid) include an error response object that explains the error reported.
Specialized identifier for this type of error in our API. Mostly returned with
4xx errors and briefly explains the error reported.
Human readable error message describing the issue.
string or object
Additional information provided about an error for
5xx response status.