HelpAPI ReferenceError Codes & Responses

Error Codes & Responses

HTTP status codes, error shapes, and how to handle them.

All API errors return a JSON body with an error field:

{
  "error": "Description of what went wrong."
}

Status Codes

CodeMeaningCommon Causes
400Bad RequestInvalid JSON body, missing required fields
401UnauthorizedMissing, invalid, expired, or revoked API key
402Payment RequiredInsufficient credits to start the run
403ForbiddenInsufficient scope (read key used for write action) or feature not available on your plan
404Not FoundSuite or run ID doesn't exist in your workspace
422UnprocessableValidation error (e.g., suite_id is required)
500Server ErrorUnexpected error — contact support

Authentication Errors

  • "Missing API key" — no key in headers. Use X-API-Key or Authorization: Bearer.
  • "Invalid API key format" — key doesn't start with plm_live_.
  • "Invalid or revoked API key" — key not found or was revoked.
  • "API key has expired" — create a new key.

Rate Limiting

The API does not currently enforce rate limits, but this may change. Design your integration to handle 429 responses with exponential backoff.