auramaxxgg-web/src/features/docs/apiArtifacts.ts
API Overview
How the prose docs, capability manifests, OpenAPI contract, and compact schema fit together.
API CONTRACT
Machine-Readable Contract
What To Use
For Humans
- Browse the human docs at https://auramaxx.gg/docs.
- Use https://auramaxx.gg/api for the API-first entry page.
For Tools And SDKs
- Use https://auramaxx.gg/agents/sdk/skill.md as the agent-first browser SDK playbook.
- Use https://auramaxx.gg/docs/sdk-api for the browser SDK method surface.
- Use https://auramaxx.gg/login-with-aura/sdk.manifest.json for a machine-readable hosted SDK manifest.
- Use https://auramaxx.gg/login-with-aura/sdk.d.ts for hosted SDK TypeScript declarations.
- Use https://auramaxx.gg/login-with-aura/diagnostics to inspect session, profile, and inventory payloads in a browser.
- Generate typed clients from https://auramaxx.gg/auramaxxgg-tempo-openapi-v1.json.
- Use https://auramaxx.gg/auramaxxgg-public-api-schema-v1.json for a smaller AI-friendly route manifest.
For Runtime Discovery
- Keep the runtime manifests in play with https://api.auramaxx.gg/api/tempo/capabilities.
- Use https://api.auramaxx.gg/api/tempo/developer/v1/capabilities for delegated-user feature discovery.
Complementary Artifacts
Capability manifests tell you what is enabled right now. OpenAPI and the compact public schema tell you how to call the routes.
Need Higher Rate Limits?
Register your app and use its browser-safe read token with the SDK. Unregistered calls fall back to dev-mode attribution.
Document Reference
auramaxxgg-web/src/features/docs/apiArtifacts.ts