API Overview¶
stdapi.ai provides an OpenAI-compatible API backed by AWS Bedrock and AWS AI services. Any application that works with OpenAI works with stdapi.ai by simply changing the API endpoint.
Interactive Documentation¶
stdapi.ai provides multiple interfaces for exploring and testing the API—choose the one that fits your workflow:
📚 Documentation Resources¶
- Complete API Reference – In-depth guides for every endpoint with parameter details
- OpenAPI Specification – Full machine-readable schema for integration and tooling
🎮 Live API Playground¶
When running the server, access these interactive interfaces (can be enabled via configuration options):
| Interface | URL | Best For |
|---|---|---|
| Swagger UI | http://localhost/docs |
Testing endpoints directly in your browser with live request/response examples |
| ReDoc | http://localhost/redoc |
Reading and searching through clean, organized documentation |
| OpenAPI Schema | http://localhost/openapi.json |
Generating client code or importing into API tools like Postman |
Supported Endpoints¶
| Category | Endpoint | Capability | Documentation |
|---|---|---|---|
| 💬 Chat | POST /v1/chat/completions |
Multi-modal conversations with text, images, video, documents | Chat Completions → |
| 🎨 Images | POST /v1/images/generations |
Text-to-image generation | Generations → |
POST /v1/images/edits |
Image editing and transformations | Edits → | |
POST /v1/images/variations |
Generate image variations | Variations → | |
| 🔊 Audio | POST /v1/audio/speech |
Text-to-speech synthesis | Text to Speech → |
POST /v1/audio/transcriptions |
Speech-to-text transcription | Transcriptions → | |
POST /v1/audio/translations |
Speech-to-English translation | Translations → | |
| 🧠Embeddings | POST /v1/embeddings |
Vector embeddings for semantic search | Embeddings → |
| 📋 Models | GET /v1/models |
List available models | Models → |
Using stdapi.ai¶
stdapi.ai is a drop-in replacement for the OpenAI API. Any application that works with OpenAI—chatbots, coding assistants, automation tools, custom scripts—works with stdapi.ai by simply changing the API base URL.
To connect your application:
- Replace the OpenAI API URL with your stdapi.ai deployment URL
- Use the same authentication mechanism (Bearer token in the
Authorizationheader) - Use AWS Bedrock model IDs instead of OpenAI model names (e.g.,
amazon.nova-micro-v1:0)
That's it. Your application continues to work without any code changes—just point it to stdapi.ai instead of OpenAI.
Next Steps¶
Explore the API:
- Chat Completions - Conversational AI with multi-modal support
- Images - Generation, edits, and variations
- Audio - Text-to-speech, transcription, and translation
- Embeddings - Vector embeddings for search and RAG
- Models - List and discover available models
Learn more:
- Features - Full capabilities and AWS integrations
- Getting Started - Deploy to AWS with Terraform
- Use Cases - Integration examples with popular tools