// DEVELOPER DOCS

API 文檔

YOMP API 相容 OpenAI 格式。在 會員中心 建立 API Key 後，把現有程式的 base URL 改成 https://yomp.hk/v1 即可。

認證

所有請求在 Header 帶上 API Key：

Authorization: Bearer yk-你的Key

對話 POST /v1/chat/completions

curl https://yomp.hk/v1/chat/completions \
  -H "Authorization: Bearer $YOMP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "yomp-chat",
    "messages": [{"role": "user", "content": "用一句話介紹香港"}],
    "stream": false
  }'

支援 stream: true（Server-Sent Events）。回應會多一個 yomp 欄位，記錄本次扣除的點數及 request_id。

Python（OpenAI SDK）

from openai import OpenAI

client = OpenAI(base_url="https://yomp.hk/v1", api_key="yk-...")
stream = client.chat.completions.create(
    model="yomp-chat",
    messages=[{"role": "user", "content": "你好"}],
    stream=True,
)
for chunk in stream:
    print(chunk.choices[0].delta.content or "", end="")

圖像生成 POST /v1/images/generations

{"model": "yomp-image", "prompt": "賽博朋克風格的維港夜景", "size": "1024x1024"}

帳戶 GET /v1/me · GET /v1/models

/v1/me 返回方案、剩餘點數、今日用量及限制；/v1/models 返回可用模型。

可用模型與價格

model說明每次每千 tokens方案
yomp-chat通用對話模型，寫作、翻譯、程式1 點 2 點 全部用戶
yomp-chat-pro進階推理模型，長文及複雜任務2 點 8 點 Pro 或以上
yomp-image文字生成圖像30 點 — Basic 或以上

對話按「每次最少扣點 + 每千 tokens（輸入 + 輸出）加收」計算；失敗的請求不扣點。

錯誤碼

HTTPtype說明
400invalid_request請求格式錯誤
401invalid_api_keyKey 無效或已撤銷
402insufficient_credits點數不足
403plan_required模型需要更高的會員方案
404model_not_found模型不存在或未開放
429rate_limit_exceeded / daily_cap_reached超過每分鐘請求數或每日點數上限
502upstream_error上游 AI 服務錯誤（不扣點）