docs: document public API errors - #92
Merged
Merged
Conversation
Co-authored-by: william <william@linkup.so>
cjumel
marked this pull request as ready for review
September 15, 2026 08:09
cjumel
self-requested a review
September 15, 2026 08:09
cjumel
approved these changes
Sep 15, 2026
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.
Description
The Python client docstrings did not fully describe the stable public errors exposed by the search, fetch, research, and task gateway controllers. This synchronizes the sync and async method documentation with the API's authentication, IP allowlist, x402 payment, credit/budget, queue-limit, rate-limit, and invalid-UUID errors. Runtime request and response handling was already aligned and is unchanged.
Validation:
make lint typecheck test(lint passed, Pyright reported 0 errors, and 108 tests passed).Checklist
prekon this project (for instance with themake install-devcommand) before creating any commit, or I have run successfully themake lintcommand on my changes.make typecheck testcommand on my changes.README.mdif my changes affected it (not affected).