Errors

Error codes

The Sherpa.ai Workspace API attempts to return appropriate HTTP status codes for every request.

Code	Name	Description
200	OK	The request was successful.
201	Created	The request was fulfilled and resulted in a new resource being created.
202	Accepted	The request was accepted for processing, but the processing was not completed.
204	No Content	The server successfully processed the request, and is not returning any content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	The request requires user authentication.
403	Forbidden	The request was understood, but it has been refused or access is denied. An accompanying error message will explain further.
404	Not Found	The URI requested is invalid or the resource requested does not exist.
409	Conflict	The request could not be completed, due to a conflict with the current state of the resource.
429	Too Many Requests	Returned when a request cannot be served, due to the API’s rate limit having been exhausted for the client.
500	Internal Server Error	Something is broken.
503	Service Unavailable	The API servers are working, but overloaded. Try again later.

When the Sherpa.ai API returns error messages, it returns error details in JSON format.

{
    "code": "000262",
    "description": "Unknown user"
}```