Skip to content

Errors

All errors use a consistent envelope:

{
"error": {
"code": "document_not_found",
"message": "No document matched id '01INVALID000000000000000000'. Use browseRegulatoryLibrary with the user's original phrasing to find the correct id."
}
}
  • code is stable and machine-readable
  • message is written for an agent deciding what to do next
HTTPCodeWhenWhat to do
400validation_errorQuery or path parameter failed validationFix the named parameter and retry
400invalid_cursorCursor is malformed, expired, or belongs to a different query/filter setDrop the cursor and restart from the first page
404document_not_foundID does not resolve to a document in v1Search again using the original phrasing
409document_not_readyDocument is in the catalog but full text is not yet availableRetry later or use another search result
500internal_errorUnexpected server failureRetry later; do not expose internals