Errors
The Neutron API uses conventional HTTP response codes to indicate the success or failure of an API request.
HTTP Status Codes
| Code | Status | Description |
|---|---|---|
| 200 | OK | Request succeeded |
| 201 | Created | Resource successfully created |
| 400 | Bad Request | Invalid request parameters or body |
| 401 | Unauthorized | Invalid or missing API key |
| 403 | Forbidden | API key not authorized for the requested app |
| 404 | Not Found | Resource doesn't exist |
| 429 | Too Many Requests | Rate limit exceeded |
| 500 | Internal Server Error | Something went wrong on our end |
| 503 | Service Unavailable | Service temporarily unavailable (e.g., queue not initialized) |
Error Response Format
Error responses include an error field and typically a message field
with more details:
{
"error": "Error type",
"message": "Human-readable error message"
}Common Errors
Invalid API Key
Verify your API key is correct and included in the Authorization header as a Bearer token.
401 UnauthorizedApp Not Authorized
Your API key is not authorized to access the specified appId. Check your API key permissions.
403 ForbiddenMissing Required Parameters
Ensure all required query parameters (appId, externalUserId) are included in your request.
400 Bad RequestResource Not Found
The requested seed, bundle, job, or user doesn't exist or you don't have access to it.
404 Not FoundRate Limit Exceeded
You've exceeded the rate limit. Wait for the specified time before retrying.
429 Too Many Requests