Skip to main content
The Decipher API lets you retrieve test results, run details, failure analysis, and screenshots programmatically. Use it to integrate Decipher into your CI/CD pipelines, build custom dashboards, or trigger alerts in external systems. Base URL: https://api.getdecipher.com

Authentication

All API requests require an API key. You can create and manage API keys from your Decipher settings page. Include your key in the Authorization header:
curl https://api.getdecipher.com/api/v1/tests/456 \
  -H "Authorization: Bearer dcp_live_your_api_key_here"
Alternatively, you can use the X-API-Key header:
curl https://api.getdecipher.com/api/v1/tests/456 \
  -H "X-API-Key: dcp_live_your_api_key_here"
API keys are scoped to your organization. Any test or run belonging to your organization is accessible with your key.

Errors

The API uses standard HTTP status codes and returns a consistent error object:
{
  "error": {
    "type": "not_found_error",
    "code": "not_found",
    "message": "The requested test was not found."
  }
}
StatusTypeMeaning
401authentication_errorMissing or invalid API key
403authorization_errorKey doesn’t have access to this resource
404not_found_errorResource doesn’t exist or isn’t accessible
422validation_errorInvalid request parameters
429rate_limit_errorToo many requests
500api_errorInternal server error

Pagination

List endpoints use cursor-based pagination. The response includes:
  • hasMore — whether more results exist
  • nextCursor — pass this as the cursor query parameter to fetch the next page
# First page
curl "https://api.getdecipher.com/api/v1/tests/456/runs?limit=10" \
  -H "Authorization: Bearer dcp_live_..."

# Next page
curl "https://api.getdecipher.com/api/v1/tests/456/runs?limit=10&cursor=eyJpZCI6..." \
  -H "Authorization: Bearer dcp_live_..."