API Reference Overview
Complete reference for the Bitdeer AI inference APIs — endpoints, parameters, and response schemas.
Base URL
All API requests should be made to:
Authentication
All requests require a bearer token in the Authorization header:
Get your key from Bitdeer AI Console → API Keys. See Authentication for full details.
API groups
Basic APIs
| Endpoint | Description |
|---|---|
| Authentication | API key management and usage |
| Error Codes | Unified error response format and retry guidance |
LLM APIs
HTTP endpoints for self-deployed chat and vision models, plus optional embeddings and reranking APIs.
| Endpoint | Method | Path | Description |
|---|---|---|---|
| Create Chat Completion | POST | /v1/chat/completions | Generate text responses (supports streaming, tools, vision) |
| Create Embeddings | POST | /v1/embeddings | Convert text to vector representations |
| Create Rerank | POST | /v1/rerank | Reorder documents by relevance |
| List Models | GET | /v1/models | List all available models |
Quick start
1. Get your API key
Visit Bitdeer AI Console → API Keys to create and manage your keys.
2. Make your first request
3. Client libraries
- Python and JavaScript/TypeScript: configure the community
openaiclient withbase_url/baseURLset tohttps://api-inference.bitdeer.ai/v1. Request and response bodies match the HTTP API schemas.
Common use cases
| What you want to do | Go to |
|---|---|
| "How to get started?" | Get Started + Authentication |
| "API error, status 401" | Error Codes |
| "Generate text with LLM" | Create Chat Completion |
| "Understand images with a VLM" | Vision guide |
| "Build a RAG pipeline" | RAG example |
| "Use function calling" | Function Calling guide |
| "Stream responses" | Streaming guide |
| "See all models" | Model Catalog |
| "Connect to Cursor / LangChain" | Integrations |
| "How do chat requests work?" | LLM guide |
Error handling
All errors follow a consistent JSON format. See Error Codes for complete reference.
Last updated on