Skip to content

API Reference

Work in Progress

This page is under construction. Stay tuned!

Basic Information

ItemValue
Base URLhttps://api.mindrouter.ai/v1
AuthenticationBearer Token
ProtocolOpenAI API Compatible

Chat Completions

Request

bash
POST /v1/chat/completions

Request Body

json
{
  "model": "auto",
  "messages": [
    {"role": "system", "content": "You are a helpful assistant."},
    {"role": "user", "content": "Hello!"}
  ],
  "temperature": 0.7,
  "max_tokens": 1000,
  "stream": false
}

Parameters

ParameterTypeRequiredDescription
modelstringYesModel identifier. Supports auto, auto:cost, auto:quality, or specific model names
messagesarrayYesArray of conversation messages
temperaturenumberNoSampling temperature, 0-2, default 1
max_tokensintegerNoMaximum tokens to generate
streambooleanNoEnable streaming output, default false

Response

json
{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1699000000,
  "model": "gpt-4o-mini",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! How can I help you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 20,
    "completion_tokens": 10,
    "total_tokens": 30
  },
  "mindrouter": {
    "requested_model": "auto",
    "routed_model": "gpt-4o-mini",
    "route_reason": "simple_query",
    "estimated_cost": "$0.000018",
    "latency_ms": 320
  }
}

Error Codes

Status CodeDescription
400Bad request parameters
401Authentication failed, check API Key
429Rate limited or budget exceeded
500Internal server error
503Upstream model service unavailable