Errors

This guide includes an overview of error codes you might see from both the API and our SDKs.

​

API Errors

Whatever the HTTP error code is, the response payload will contain the following object:

statusCode: number - HTTP error code.

error: object - Linkup error details containing:

• code: string - Error name
• message: string - Description of the error
• details: array - Details of the error. This array may be empty or include objects with the following properties:
  • field: string - The field that caused the error
  • message: string - A description of the field error

Here is an example:

{
	"statusCode": 400,
	"error": {
		"code": "VALIDATION_ERROR",
		"message": "Validation failed",
		"details": [
			{
				"field": "outputType",
				"message": "outputType must be one of the following values: sourcedAnswer, searchResults, structured"
			}
		]
	}
}

API Error Codes

​

SDK Errors

Python & JS SDK Error Types