API Reference Overview
GhostMind’s Product API is an OpenAI-compatible API for supported GhostMind capabilities. The base URL is:
https://ghostmind.optdmsa.com/v1API Surfaces
| Surface | Path | Auth | Purpose |
|---|---|---|---|
| Product API | /v1/* | API Key (Bearer) | For applications and developers |
| User App API | /me/v1/* | Cookie (session) | For the web app (not for developers) |
| Admin API | /admin/v1/* | JWT (admin) | Platform administration (private) |
Developer documentation focuses on the Product API (/v1/*).
Authentication
All Product API requests require a Bearer token:
Authorization: Bearer sk-gm-...See Authentication for details.
Available Endpoints
| Endpoint | Method | Description |
|---|---|---|
/v1/chat/completions | POST | Chat completions (streaming and non-streaming) |
/v1/models | GET | List available models |
/v1/audio/generations | POST | Create async TTS job |
/v1/audio/generations/{id} | GET | Get TTS job status |
/v1/audio/generations/{id}/content | GET | Download generated audio |
/v1/audio/generations/{id}/cancel | POST | Cancel a TTS job |
/v1/audio/generations/{id}/retry | POST | Retry a failed TTS job |
/v1/audio/generations | GET | List TTS jobs |
/v1/audio/speech | POST | Sync TTS (bounded wait) |
/v1/audio/transcriptions | POST | Transcribe audio to text |
/v1/audio/providers | GET | List TTS providers |
/v1/audio/providers/{provider}/voices | GET | List voices for a provider |
OpenAPI Specification
The full OpenAPI specification is available at:
https://ghostmind.optdmsa.com/openapi.jsonYou can also view interactive docs at /docs (Swagger UI) or /redoc (ReDoc).
Next Steps
- Chat Completions — Core chat endpoint
- Audio Generation — TTS API
- Audio Transcription — Speech-to-text API
- Errors — Error reference