快速入門

orientx 透過一個相容 OpenAI 的端點提供多種模型。如果你已有呼叫 OpenAI API 的程式碼，只需修改 Base URL 和 API 金鑰，即可連線至 orientx。


Base URL	`https://api.orientx.ai/v1`
身分驗證	`Authorization: Bearer <ORIENTX_API_KEY>`
格式	OpenAI Chat Completions

本指南中的範例使用 <MODEL_ID> 作為佔位符。開啟模型價格頁面，查看可用模型並複製可直接執行的 API 範例。

送出第一個請求

建立 API 金鑰

開啟控制台並建立金鑰。

儲存為環境變數

不要將金鑰放入原始碼目錄，避免它進入版本控制。

export ORIENTX_API_KEY="sk-..."

呼叫 API

curl https://api.orientx.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ORIENTX_API_KEY" \
  -d '{
    "model": "<MODEL_ID>",
    "messages": [
      { "role": "user", "content": "In one sentence, what is an API gateway?" }
    ]
  }'

呼叫成功後，會回傳標準的 Chat Completions 格式：

{
  "id": "chatcmpl-...",
  "object": "chat.completion",
  "model": "<MODEL_ID>",
  "choices": [
    {
      "index": 0,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": "An API gateway is a single entry point that routes and manages requests to backend services."
      }
    }
  ],
  "usage": { "prompt_tokens": 18, "completion_tokens": 21, "total_tokens": 39 }
}

使用 OpenAI SDK

API 遵循 OpenAI 的資料結構，因此官方 SDK 無需修改即可使用。設定 base_url 和 api_key，其餘程式碼保持不變。詳細步驟參見 OpenAI SDK。

pip install openai

同樣修改這兩個欄位，也可連線至 Claude Code、Codex、Cursor、Gemini CLI、OpenCode 等 IDE 和應用程式：

整合

各個受支援 SDK 和應用程式的 Base URL 與金鑰設定。

串流回應

設定 stream: true，即可在 token 生成時逐步接收，而不用等待完整回應。流以伺服器傳送事件（SSE）的形式傳輸，並以 data: [DONE] 結束。

stream = client.chat.completions.create(
    model="<MODEL_ID>",
    messages=[{"role": "user", "content": "Write a haiku about latency."}],
    stream=True,
)

for chunk in stream:
    delta = chunk.choices[0].delta.content
    if delta:
        print(delta, end="", flush=True)

列出可用模型

GET /v1/models 回傳目前金鑰可存取的所有模型。請求中的 model 應使用回傳的 id 欄位。

curl https://api.orientx.ai/v1/models \
  -H "Authorization: Bearer $ORIENTX_API_KEY"