docs: Add comprehensive API error reference documentation#8848
Merged
mudler merged 1 commit intoMar 8, 2026
Merged
Conversation
✅ Deploy Preview for localai ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Document all error response formats (OpenAI, Anthropic, Open Responses), HTTP status codes, per-endpoint error scenarios, and client error handling examples based on actual error handling code in the codebase. Signed-off-by: localai-bot <localai-bot@noreply.github.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
localai-bot
force-pushed
the
feat/api-error-documentation-20260308044027
branch
from
26993bc to
b7bfe4c
Compare
mudler
approved these changes
Mar 8, 2026
localai-bot
added a commit
to localai-bot/LocalAI
that referenced
this pull request
Mar 25, 2026
docs: add comprehensive API error reference documentation Document all error response formats (OpenAI, Anthropic, Open Responses), HTTP status codes, per-endpoint error scenarios, and client error handling examples based on actual error handling code in the codebase. Signed-off-by: localai-bot <localai-bot@noreply.github.com> Co-authored-by: localai-bot <localai-bot@noreply.github.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
This PR adds comprehensive API error documentation to help users understand and handle error responses from the LocalAI API.
Changes
docs/content/reference/api-errors.mdVerification
All documented errors were verified against actual error handling code in the codebase.
Related
Addresses UX Review Issue H1 - Create Standardized API Error Response Documentation