docs: front-load API contract on landing and api reference#31
Open
brunobuddy wants to merge 1 commit into
Open
docs: front-load API contract on landing and api reference#31brunobuddy wants to merge 1 commit into
brunobuddy wants to merge 1 commit into
Conversation
The cloud base URL, auth header, key prefix, and `manifest/auto` model identifier were spread across multiple pages — an LLM helping a user integrate had to chain through several files. Pull the contract up to the landing page and make the API reference cloud-first. - introduction.mdx: add a Quick reference table at the top with base URLs, auth, model identifier, and endpoints - reference/api.mdx: cloud curl first then self-hosted; add a Model identifier callout stating manifest/auto is the only accepted value; expand the Authentication section into explicit signup → create agent → pass mnfst_ steps with an M003 link
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.
Summary
The cloud base URL, auth header, key prefix, and
manifest/automodel identifier are spread across multiple pages. An LLM helping a user integrate has to chain through several files just to assemble a working request — and the most common hallucination ("can I passgpt-4o-minidirectly?") is never explicitly refuted.This is a surgical contract-clarity pass on two files. No marketing/positioning changes, no restructure.
introduction.mdx— add a Quick reference table at the top: cloud base URL, self-hosted base URL, auth header, key acquisition link, the only accepted request model, both endpoint paths, and a note that no client SDK is needed (useopenai/@anthropic-ai/sdkwithbaseURLset).reference/api.mdx—curlthe primary sample; self-hosted follows. The previous sample only showedhttp://localhost:2099, which silently breaks anyone integrating with the cloud.manifest/autois the only accepted value; provider-specific names likegpt-4o-miniorclaude-sonnet-4are rejected. This closes the highest-frequency hallucination.mnfst_<key>), with the M003 link surfaced.Test plan
/introductionabove the feature cardscurlblock on/reference/apiis the first sample under "Chat completions"/errors/M003/llms-full.txtnow contains the Quick reference (it's pulled fromintroduction.mdx)