Description
The error documentation should reflect the actual error response format returned by Artemis/LiteLLM, not just theoretical OpenAI-compatible errors.
Current State
src/content/docs/api/errors.md (if it exists) likely documents generic OpenAI error format.
Required Content
-
Actual Error Responses
- Verify the exact JSON structure returned by Artemis
- Document all error types actually used in production
-
Error Categories
-
Error Handling Examples
try:
response = client.chat.completions.create(...)
except AuthenticationError as e:
# Handle invalid API key
except RateLimitError as e:
# Handle rate limit
-
Failover Behavior
- Document that chat completions fail over to Claude Haiku when vLLM is down
- Users should be aware of potential model changes during outages
Acceptance Criteria
Priority
MEDIUM - Important for production robustness.
Description
The error documentation should reflect the actual error response format returned by Artemis/LiteLLM, not just theoretical OpenAI-compatible errors.
Current State
src/content/docs/api/errors.md(if it exists) likely documents generic OpenAI error format.Required Content
Actual Error Responses
Error Categories
Authentication Errors (401)
Validation Errors (400)
Rate Limit Errors (429)
Server Errors (500)
Error Handling Examples
Failover Behavior
Acceptance Criteria
Priority
MEDIUM - Important for production robustness.