Welcome to the QuickSilver API! This guide will help you quickly set up your API key and choose the best integration method for your needs.

​
OpenAI-Compatible Interface

QuickSilver API is fully compatible with OpenAI’s Chat Completions API.If you’re already using OpenAI’s API, you can switch to QuickSilver with minimal or no changes to your existing integration.

​
API Key Setup

Before you can use the Quicksilver API, you must create and manage your API key. 👉 View #api-key-setup Your API key is required for all requests and should be included in the Authorization header: 
Authorization: Bearer your-api-key
Keep this key secure and never expose it publicly.

​
Integration Methods

QuickSilver supports multiple integration paths to suit your environment:
MethodDescription
Python SDKUse the OpenAI-compatible Python client
JavaScript (async)Ideal for browser-based or Node.js applications
HTTP (cURL)Direct HTTP requests using tools like curl
CLI InterfaceTest and automate with our command-line tool
MCP ProtocolIntegrate via Model Context Protocol clients
Widget EmbedAdd a chat widget directly to your website
Cherry StudioUse QuickSilver in the desktop client

​
API Endpoints

​
Base URL

https://api-quicksilver.iotex.ai/v1

​
Chat Completions

Use this to send chat messages and receive assistant replies (OpenAI-compatible). 
POST /chat/completions

​
Streaming Endpoint

Use this endpoint for streaming responses in real time. 
GET /sse?authorization=your-api-key

​
Error Handling

The API returns standard HTTP status codes and JSON-formatted errors (compatible with OpenAI’s error structure). Example error response: 
{
  "error": {
    "message": "Invalid API key provided",
    "type": "invalid_request_error",
    "code": "invalid_api_key"
  }
}

​
Usage Tips

  • The API is fully compatible with OpenAI’s Chat Completions interface
  • Secure your API key — never share it publicly
  • For multi-turn conversations, pass previous messages in the messages array
  • Use the SSE endpoint for streaming responses in real time
  • All communication is encrypted via HTTPS

​
Need help?