Knowledge Base

Errors

FilePreviews uses conventional HTTP response codes to indicate success or failure of an API request.

Description of usual server responses

  • 200 OK - the request was successful (some API calls may return 201 instead).
  • 201 Created - the request was successful and a resource was created.
  • 400 Bad Request - the request could not be understood or was missing required parameters.
  • 401 Unauthorized - authentication failed or user doesn't have permissions for requested operation.
  • 403 Forbidden - access denied.
  • 404 Not Found - resource was not found.
  • 405 Method Not Allowed - requested method is not supported for resource.
  • 429 Too Many Requests - exceeded API limits.
  • 503 Service Unavailable - service is temporary unavailable (e.g. scheduled Platform Maintenance).

Example error response: 400 Bad Request

{
  "error": {
    "type": "invalid_request_error",
    "param": "url",
    "message": "This field may not be blank."
  }
}