API Error Codes
The HelioNote API uses standard HTTP status codes to indicate success or failure. When an error occurs, the API returns a JSON response with details to help you debug.
How Errors Are Returned
All errors include an HTTP status code and a JSON body with the following format:
{
"error_code": "401",
"message": "Invalid API key. Please provide a valid key."
}
Error Codes and Troubleshooting
| Status Code | Meaning | Possible Causes | Resolution |
|---|---|---|---|
| 400 Bad Request | Invalid request syntax or missing parameters. | Required fields not included (e.g., title for notes). | Verify the request body matches the API specification. |
| 401 Unauthorized | Authentication failed. | API key missing or invalid. | Provide a valid API key in the request header. |
| 403 Forbidden | Access denied. | API key does not have permission for the requested operation. | Check API key scopes and permissions. |
| 404 Not Found | Resource not found. | Invalid endpoint URL or non-existent note ID. | Verify the endpoint path and resource ID. |
| 409 Conflict | Request could not be completed due to a conflict | Attempt to create a note with an existing ID. | Use unique identifiers when creating resources. |
| 429 Too Many Requests | Rate limit exceeded. | Sending too many requests within a short time. | Implement retry logic with exponential backoff. |
| 500 Internal Server Error | Generic server-side failure. | Unexpected server condition. | Retry later or contact support if persistent. |
Error Response
Request:
GET /api/v1/notes/9999
Authorization: Bearer [your_api_key]
Response:
{
"error_code": "404",
"message": "Note not found. Please verify the note ID."
}