Skills Development Debugging OpenEvidence API Errors

Debugging OpenEvidence API Errors

v20260423
openevidence-common-errors
This guide provides comprehensive error handling and debugging steps for the OpenEvidence API. It covers common failure points—including authentication issues (401, 403), query validation errors (422), rate limiting (429), and service timeouts (408). Users can learn how to diagnose the root cause of connection failures and refine their clinical queries to maximize data retrieval accuracy.
Get Skill
205 downloads
Overview

OpenEvidence Common Errors

Overview

OpenEvidence provides AI-powered clinical decision support through evidence-based query answering with citation tracking. API integrations involve submitting clinical questions, retrieving evidence summaries, and managing citation references. Common errors include overly broad queries that exceed processing limits, citation-not-found errors when referenced studies are retracted, and timeouts on complex multi-condition queries that trigger deep literature analysis. The DeepConsult mode provides more thorough analysis but consumes 5x the rate limit quota and has a 90-second timeout. This reference covers authentication, query validation, and clinical-specific error patterns.

Error Reference

CodeMessageCauseFix
401Authentication failedInvalid or expired API keyRegenerate at OpenEvidence developer portal
403Organization access deniedAPI key not authorized for orgVerify org ID matches the key's assigned organization
404Citation not foundReferenced study retracted or removedQuery for updated evidence; citation database refreshes weekly
408Query timeoutComplex multi-condition query exceeded 90s limitSimplify query to single clinical question; avoid compound conditions
422Query too broadQuestion not specific enough for clinical analysisAdd condition, population, or intervention to narrow scope
422Non-medical queryQuestion not recognized as clinicalRephrase using medical terminology and clinical context
429Rate limitedExceeded API request quotaImplement backoff; check Retry-After header
503Service unavailableDeepConsult queue at capacityRetry after 60s; consider standard query mode instead

Error Handler

interface OpenEvidenceError {
  code: number;
  message: string;
  category: "auth" | "rate_limit" | "query" | "availability";
}

function classifyOpenEvidenceError(status: number, body: string): OpenEvidenceError {
  if (status === 401 || status === 403) {
    return { code: status, message: body, category: "auth" };
  }
  if (status === 429) {
    return { code: 429, message: "Rate limited", category: "rate_limit" };
  }
  if (status === 503) {
    return { code: 503, message: body, category: "availability" };
  }
  return { code: status, message: body, category: "query" };
}

Debugging Guide

Authentication Errors

OpenEvidence API keys are scoped per organization. A 401 means the key itself is invalid; a 403 means the key is valid but not authorized for the specified org ID. Verify both the OPENEVIDENCE_API_KEY and the org_id parameter match. Keys are rotated quarterly for compliance -- check expiration date.

Rate Limit Errors

Rate limits vary by plan tier. Standard plans allow 100 queries/hour; enterprise plans have higher limits. DeepConsult queries (longer analysis) consume 5x the rate limit quota of standard queries. Use Retry-After header and implement exponential backoff.

Validation Errors

Queries must be clinically relevant and specific. "What causes headaches?" is too broad -- narrow to "What is the first-line treatment for migraine with aura in adults?" Add population, intervention, or comparison to improve query specificity. Non-medical queries are rejected with 422. Citation references use DOI-based identifiers; retracted studies return 404 and should be re-queried for updated evidence.

Error Handling

ScenarioPatternRecovery
Query too broad422 with specificity warningAdd condition + population + intervention details
Citation not found404 on citation lookupRe-query for updated evidence; citations refresh weekly
DeepConsult queue full503 on complex queriesFall back to standard query mode; retry deep after delay
Timeout on compound query408 after 90sSplit into individual clinical questions
Org access mismatch403 despite valid keyVerify org_id parameter matches key's assigned organization

Quick Diagnostic

# Verify API connectivity and key validity
curl -s -o /dev/null -w "%{http_code}" \
  -H "Authorization: Bearer $OPENEVIDENCE_API_KEY" \
  https://api.openevidence.com/v1/health

Resources

Next Steps

See openevidence-debug-bundle.

Info
Category Development
Name openevidence-common-errors
Version v20260423
Size 4.79KB
Updated At 2026-04-28
Language