Shobdo Logo

Error Codes

The Shobdo API uses standard HTTP status codes to indicate the success or failure of a request. All error responses include a JSON body with an error message.

Error Response Format

{
  "ok": false,
  "error": "A human-readable description of the error."
}

Status Codes

CodeNameDescriptionResolution
400Bad RequestThe request is missing a required parameter or contains invalid values.Check the request parameters. Ensure required fields like q are provided.
401UnauthorizedAuthentication failed. The API key is missing, malformed, or invalid.Include a valid Authorization: Bearer header. Verify your key in the Console.
403ForbiddenThe API key is valid, but the associated account has been suspended or deleted.Contact support to resolve account issues.
404Not FoundThe requested resource does not exist. This can mean the dictionary ID is wrong or the entry ID does not exist.Verify the source and id parameters match values from a search response.
429Too Many RequestsYou have exceeded your monthly API request limit.Wait until your quota resets next month, or upgrade your plan.
500Internal Server ErrorAn unexpected error occurred on our side. These are rare and typically transient.Retry the request after a brief delay. If the error persists, contact support.

Common Mistakes

Avoid these common pitfalls

  • Forgetting the Bearer prefix: The header must be Authorization: Bearer YOUR_KEY, not just Authorization: YOUR_KEY.
  • Using an entry ID from the wrong dictionary: Entry IDs are scoped to their dictionary. An ID from one dictionary will not work with a different source.
  • Not URL-encoding non-Latin characters: When using the word lookup endpoint with non-ASCII characters, ensure the word is properly URL-encoded.

Assistant

Hi! I'm the Shobdo Assistant.
Ask me anything about the documentation.