SPB Git forge

spb/doc-api

Public
2commits 1branches 0releases
15.7 MBsize
maindefault branch
13 days agolast push
Python 88.3% TypeScript 7.6% Shell 4.1%
5.7 KB · 76 lines markdown
Rendered Raw Blame History
1# API Atlas — OpenAI + Anthropic + xAI + Gemini23Exhaustive, experimentally verified reference of **everything you can do with the OpenAI, Anthropic, xAI (Grok) and4Google Gemini public APIs** as of **2026-09-18/19**: models, endpoints, parameters, objects, streaming events, tools, agents, realtime, media,5files, batch, fine-tuning, evals, admin, pricing, rate limits, errors, headers, SDKs, security, and a6multi-provider abstraction. Machine-readable first (`generated/`), human docs second (`docs/`), runnable7examples (`examples/`) and smoke tests (`tests/`) third.89Every fact carries a **status** (`DOCUMENTED`, `LIVE_VERIFIED`, `LIVE_DISCOVERED`, `BETA`, `PREVIEW`, `LEGACY`,10`DEPRECATED`, `RETIRED`, `ACCOUNT_RESTRICTED`, `UNVERIFIED`, `FAILED_VERIFICATION`) and its **sources**11(official URL + retrieval date). Nothing is claimed "tested" unless it was actually called with a real key12(see `reports/live-requests.jsonl`).1314## Start here1516| Need | Go to |17|---|---|18| Overview & navigation | [`docs/index.md`](docs/index.md) |19| Which model supports what | [`docs/models/openai-models.md`](docs/models/openai-models.md) · [`docs/models/anthropic-models.md`](docs/models/anthropic-models.md) · [`docs/models/xai-models.md`](docs/models/xai-models.md) · [`docs/models/gemini-models.md`](docs/models/gemini-models.md) · `generated/compatibility/model-capability-matrix.csv` |20| Every endpoint | `generated/endpoints.csv` · [`docs/endpoints/`](docs/endpoints/) |21| Every parameter | `generated/parameters.csv` (`generated/parameters.json` for nested detail) |22| Every tool (exact `type` strings) | [`docs/tools/openai/index.md`](docs/tools/openai/index.md) · [`docs/tools/anthropic/index.md`](docs/tools/anthropic/index.md) · [`docs/tools/xai/index.md`](docs/tools/xai/index.md) · [`docs/tools/gemini/index.md`](docs/tools/gemini/index.md) · `generated/tools.json` |23| Streaming events (SSE / WebSocket) | `generated/streaming-events.json` · [`docs/openai/streaming-events.md`](docs/openai/streaming-events.md) · [`docs/openai/realtime-events.md`](docs/openai/realtime-events.md) · [`docs/anthropic/streaming.md`](docs/anthropic/streaming.md) |24| Agents platforms | [`docs/openai/agents-api.md`](docs/openai/agents-api.md) · [`docs/anthropic/managed-agents.md`](docs/anthropic/managed-agents.md) · [`docs/gemini/interactions-api.md`](docs/gemini/interactions-api.md) · [`docs/xai/responses.md`](docs/xai/responses.md) |25| Pricing | [`docs/openai/pricing.md`](docs/openai/pricing.md) · [`docs/anthropic/pricing.md`](docs/anthropic/pricing.md) · [`docs/xai/pricing.md`](docs/xai/pricing.md) · [`docs/gemini/pricing.md`](docs/gemini/pricing.md) · `generated/pricing.csv` |26| Errors & retries | [`docs/errors/openai.md`](docs/errors/openai.md) · [`docs/errors/anthropic.md`](docs/errors/anthropic.md) · [`docs/errors/gemini.md`](docs/errors/gemini.md) · [`docs/xai/authentication-headers-errors.md`](docs/xai/authentication-headers-errors.md) · [`docs/architecture/resilience.md`](docs/architecture/resilience.md) |27| Cross-provider comparisons (4 providers) | [`docs/comparisons/`](docs/comparisons/) |28| Security | [`docs/security/README.md`](docs/security/README.md) |29| Multi-provider code | [`docs/architecture/multi-provider-abstraction.md`](docs/architecture/multi-provider-abstraction.md) · `examples/shared/` |30| What was verified, what is missing | [`reports/final-report.md`](reports/final-report.md) |3132## Setup3334```bash35cp .env.example .env && chmod 600 .env   # add OPENAI_API_KEY / ANTHROPIC_API_KEY / XAI_API_KEY / GEMINI_API_KEY36uv venv .venv && uv pip install --python .venv/bin/python openai anthropic xai-sdk google-genai pytest pyyaml jsonschema websockets37pnpm install                              # openai + @anthropic-ai/sdk + @google/genai for the TypeScript examples38```3940Run an example: `bash examples/anthropic/messages/minimal.sh`, `.venv/bin/python examples/openai/responses/minimal.py`,41`node --env-file=.env --experimental-strip-types examples/openai/responses/minimal.ts`.4243Run the smoke tests (cheap by default; expensive suites are gated by `RUN_*_TESTS=true`, see `.env.example`):4445```bash46.venv/bin/python -m pytest -q47```4849## Re-running the atlas (change detection)5051```bash52python3 scripts/update_atlas.py          # refresh indexes + crawl docs + /v1/models + rebuild + reports/changes.md53python3 scripts/build_generated.py       # rebuild generated/ from generated/fragments/54.venv/bin/python scripts/validate_fragments.py55python3 scripts/verify_links.py          # external + internal link check → reports/link-check.json56```5758`reports/changes.md` lists NEW/REMOVED MODELS, ENDPOINTS, TOOLS, PRICING CHANGES, CONTEXT WINDOW CHANGES,59NEW BETA FEATURES, DEPRECATIONS and the official pages whose content changed since the last run.6061## Layout6263```64docs/          human documentation (openai/, anthropic/, xai/, gemini/, models/, tools/, endpoints/, errors/, comparisons/, architecture/, security/)65generated/     merged machine-readable outputs (+ fragments/ = curated inputs, + compatibility/ matrices, + capability graph)66examples/      runnable cURL / Python / TypeScript examples with verification status in each file header67tests/         pytest smoke tests (openai/, anthropic/, shared/)68scripts/       crawl, discover, build, validate, verify, update69sources/       downloaded official documentation (OpenAI 551, Anthropic 696, xAI 182, Gemini 291 pages), OpenAPI/discovery specs, SDK surfaces, sanitized live discovery70schemas/       JSON Schemas for every record type71reports/       live request log, coverage, changes, final report72```7374Security rules: keys only in `.env` (600, gitignored), never in files or logs; admin endpoints are probed read-only;75all live tests use minimal payloads. See `CLAUDE.md` for the full conventions.76