Skip to content

docs(errors): the debug field is redacted, not raw upstream text #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VickyXAI merged 1 commit into from
Sep 10, 2026
Merged

docs(errors): the debug field is redacted, not raw upstream text #96

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/api-reference/errors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ BlockRun uses standard HTTP status codes and returns detailed error information.

## Error Response Format

Gateway errors use the OpenAI envelope, with `message` and `code` mirrored at the top level for older clients. `debug` carries the raw upstream text when there is one.
Gateway errors use the OpenAI envelope, with `message` and `code` mirrored at the top level for older clients. `debug` carries the upstream text when there is one, **redacted**: credentials, URLs and any routing infrastructure we do not sell under its own name are removed before the response is sent. The status code and the upstream's own description of the fault survive, so `debug` stays useful for a bug report — it is just not a verbatim copy.

```json
{
Expand All @@ -33,7 +33,7 @@ Gateway errors use the OpenAI envelope, with `message` and `code` mirrored at th
},
"message": "Message @bc1max on Telegram for help.",
"code": "INVALID_PARAMETER",
"debug": "<upstream error text>"
"debug": "<upstream error text, redacted>"
}
```

Expand Down
Loading