Skip to main content

API Reference


When the API endpoint returns a status other than 200 (OK) a JSON object will be returned containing the errors.

fieldstringThe body property that caused this error
codestringThe error code associated with this error
messagestringThe error message

Below is an example of a response that can be returned:

	"errors": [
			"field": "name",
			"code": "FILE_NOT_FOUND",
			"message": "A file with the provided name does not exist"


Some routes require an API key in the Authentication header. To get an API key, head over to the /dashboard/settings page on your paperplane dashboard and create a key.