Errors

Benchling uses standard REST HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicates an error on the user's end, and 5xx indicates an error on Benchling's end.

In general, error responses will be a JSON dictionary with the following fields:

type

This is an error code:

  • invalid_request_error means that one or more parameters of the request were invalid and should be adjusted
  • authentication_error means that the user calling the API did not have access or was not correctly authenticated
  • api_error means something went wrong on our end

message

This is a human-readable message, which is useful for debugging and for showing a message in downstream applications.

errorId

This is an ID of the error if it was recorded in our logging system. This ID should be presented to Benchling support to help troubleshoot issues.