Loading Shunya AI
Preparing the current workspace.
SHUNYA AI developer portal
Build against a clear API boundary.
Review the public contract, authentication model, and capability states before connecting a production workflow.
Private upstream
Public clients target the gateway contract. Internal Voice Engine details stay server-side.
Truthful readiness
Unavailable providers and planned operations remain explicit rather than simulated.
API host target
https://api.shunya-ai.space/v1 is a deployment target and is not claimed externally verified in this slice.
Developer guide
Usage reporting boundary
Usage is read from persisted events when the tenant has configured reporting. No chart or balance is fabricated.
- Usage is scoped to the authenticated tenant and project.
- Provider failures must not become successful usage events.
- Billing activation requires a configured rate plan.
Versioned contract
Public API route inventory
| Method | Route | State | Purpose |
|---|---|---|---|
| GET | /v1/health | Documented | Service health without internal infrastructure details. |
| GET | /v1/capabilities | Documented | Capability status for the authenticated integration. |
| GET | /v1/languages | Documented | Language metadata exposed by the runtime contract. |
| GET | /v1/voices | Documented | Voice metadata exposed by the runtime contract. |
| POST | /v1/stt | Documented | Speech-to-text where the selected runtime is ready. |
| POST | /v1/tts | Documented | Text-to-speech where the selected runtime is ready. |
| POST | /v1/text/transform | Documented | Text preparation and transformation where the runtime is ready. |
| POST | /v1/translate | Documented | Translation where the selected runtime is ready. |
| POST | /v1/transliterate | Documented | Transliteration where the selected runtime is ready. |
| GET | /v1/metrics | Documented | Authenticated request and usage metrics for the current period. |
| GET | /v1/status | Documented | Public API and speech service status for the authenticated integration. |
| POST | /v1/speech-to-speech | Planned | Planned speech-to-speech route; not executable. |
| WS | /v1/stt/stream | Planned | Planned streaming route; not executable. |
Current local integration routes remain governed by the existing application contract. The external subdomain is not declared operational until deployment, DNS, TLS, CORS, and health checks pass.
Request example
Use placeholders in documentation
curl -X GET https://api.shunya-ai.space/v1/health
-H "Authorization: Bearer <api-key>"Access boundary
Customer access is separate from demo access
The invitation-controlled demo remains available for evaluation. It does not create a paid entitlement, issue a production API key, or authorize the authenticated customer application.
Review access options