Repository navigation
docs: add a usage-level Agents API guide and an examples chapter - #226
Merged
Merged
Conversation
- README: what the project is, a four-step install, the two APIs and a documentation table by goal (English and Chinese). - Installation: the default path first (prerequisites, install, reachability, sign-in, next steps); version, sandbox backend, modes, split deployment and directory layout move to "Advanced installation". - Quickstart: three steps from a Project API key to a finished Session. - User guide: task-oriented, and now the single owner of Environment kinds, harness and model choice, and model provider precedence. - Remove repeated explanations and link to one owner instead: namespaces and credentials (API index), Projects and keys and administrator authority and isolation (design principles), key rotation steps (operations), backend and size changes (configuration), executor credential rotation (self-hosted).
- docs/api/public-agent-api.md becomes the Agents API guide: every public resource with official OpenAI SDK and plain HTTP examples, plus pagination, idempotency, errors, x_agents_core, streaming events, function tools, the three kinds of file, Skills, templates, Vaults and the differences from OpenAI. SDK calls were checked against SDK 3.13.0 for method, path and headers. - API index: runnable Core API commands for common administrator tasks. - docs/examples.md: the cases chapter, mapping each feature of the Parsar example to its API and guide section; example READMEs link to it. - Register the examples page and retitle the API guide on the docs site, and regenerate the site.
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
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.
Part 2 of 3. Stacked on the new-user-path PR; its first commit is that PR.
Agents API guide (
docs/api/public-agent-api.md)Every public resource is documented with both an official OpenAI SDK example and a plain HTTP example.
Conventions:
x_agents_core(harness,model_provider,harness_config,installation)Resources:
requires_action,tool_result, thesessions.streamhelper)The guide ends with a table of limits and differences from OpenAI.
Verified: every SDK call in the guide was run against a mock server with SDK 3.13.0 to confirm its method, path,
OpenAI-Betaheader andIdempotency-Key(23 calls). The template network shape and the Vault credential shape were checked against the SDK types.Also in this PR
model-configurationroute.docs/examples.md): maps each Parsar example feature to the API used, the guide section and the source file. Example READMEs link to it.Validation
make check-docspasses.check-namespasses.core-distribution-manifesttests pass.Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.