Repository navigation
docs(api): align hand-written references with current contracts - #38
Merged
Merged
Conversation
…s contracts - Rate limits: document the per-organization RPM limit and its 'organization rate limit exceeded' 429 (the per-key/global limiter is not mounted); add the 'daily free API limit exceeded' 429. - Volcengine native tasks: remove list and delete, which the apiserver dropped (sandbase-monorepo 2f8deef1b2); only create and get remain. - Sessions: document inline Agents, per-Session agent overrides and stream=true creation (live in agents since 2026-10-12). - Concurrency: the check covers every model type on /v1/run and /v1/api/*, video only elsewhere. - Errors: nested insufficient_scope body; Agents request_too_large (413). - OpenAI Images accepts gpt-image-2, 2.5-flare and 2.5-sunburst. - Add tasks cost 'pricing' and upload 'duration_seconds' response fields; fix the balance example decimals. - Update validators for the removed Volcengine operations.
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.
Follow-up to #37. Fixes the hand-written API reference mismatches found in the docs audit. Every change was checked against sandbase-monorepo main (8610f216e0).
Changes
middleware/org_ratelimit.go), which returnsorganization rate limit exceeded. The documented per-key and global limits (middleware/ratelimit.go) are not mounted. Also documents thedaily free API limit exceeded429 (service/free_api_quota.go; per org, per UTC day). The numeric allowance is not published.GET /api/v3/contents/generations/tasks(list) andDELETE …/{task_id}. The apiserver removed both in 2f8deef1b2, and only create and get are routed. The validators now assert that the removed operations stay out.agentwithoutagent_id), per-Sessionagentoverrides, andstream: truecreation as a 201 SSE stream that requires an initial input. Both are live in sandbase-agents since the 2026-10-12 PROD deploy (0a41d8e811 includes 2e2b89ab38). The OpenAPISessionCreateRequestand the OpenAI compatibility table are updated to match./v1/runand/v1/api/*, and only to video on other endpoints (service/org_concurrency.go).insufficient_scopeuses a nested body; adds Agentsrequest_too_large(413).modelaccepts gpt-image-2, gpt-image-2.5-flare, and gpt-image-2.5-sunburst./v1/tasks/{id}/costpricingand/v1/uploadduration_seconds. The balance example now uses trimmed decimals.Tested
npm run validatepasses locally.Intentionally not changed
/events/webhooksauth and error format (X-API-Key,{code,message}). The validators keep that path out of published pages on purpose (api-reference/webhooks.mdis excluded from the build), so it needs a product decision first.concurrencyExcludedTier, marked temporary). The docs keep the published tier limits.