Skip to main content
All endpoints return standard HTTP status codes:
  • 200 OK: Request successful
  • 400 Bad Request: Invalid request parameters or body
  • 401 Unauthorized: Missing or invalid API key
  • 404 Not Found: Resource not found
  • 500 Internal Server Error: Server error

​
Error Response Format

Error responses follow this format: 
{
  "error": [
    {
      "message": "Error message description",
      "path": "field.path"
    }
  ]
}

​
Common Error Scenarios

​
Missing API Key

{
  "error": "API key is required"
}

​
Invalid Parameters

{
  "error": [
    {
      "message": "At least 3 and at most 10 phrases are required",
      "path": "phrases"
    }
  ]
}

​
Invalid Callback URL

{
  "error": [
    {
      "message": "Callback URL must be a valid HTTPS URL",
      "path": "callbackUrl"
    }
  ]
}

​
Insufficient Credits

{
  "error": "Insufficient credits"
}
This error occurs when creating a job and you don’t have enough credits in the appropriate tier (Pro Tier for enriched searches, Free Tier for non-enriched searches).