Base URL

OpenAI 兼容 API 的建議 Base URL:

https://miyang.cn/api/v1
舊地址 https://miyang.cn/v1 繼續兼容現有客戶端;新接入請使用 https://miyang.cn/api/v1
鑑權

除公開的模型列表接口外,推理接口均須在請求頭攜帶 API 密鑰。支援兩種請求頭:

  • 建議Authorization: Bearer miyang-xxxxx
  • 備用x-api-key: miyang-xxxxx

API 密鑰在控制台建立並加密保存,可在「API Keys」頁面再次查看和複製。

bash
# Bearer Token(推荐)
curl https://miyang.cn/api/v1/models \
  -H "Authorization: Bearer miyang-xxx"

# x-api-key(备用)
curl https://miyang.cn/api/v1/models \
  -H "x-api-key: miyang-xxx"
模型命名規範

模型 ID 通常採用 {provider_slug}/{model_name} 格式。建議使用 miyang/auto 自動選擇模型,也可通過模型列表接口或控制台複製其他可用的調用 ID。

  • miyang/auto — 自動選擇適合當前請求的模型
  • miyang/standard — 標準檔模型
  • miyang/premium — 高級檔模型

miyang/* 模型用於 Alice 客戶端;其他應用或腳本請從模型列表中選擇 usage_scopegeneral 的模型。

python
# 自动选择适合当前请求的模型
model = "miyang/auto"
限速

每個 API 密鑰獨立計數,默認 60 次/分鐘,可在控制台調整上限。超出限速返回 429 Too Many Requests

http
{
  "error": {
    "message": "Rate limit exceeded",
    "type": "rate_limit_error",
    "code": 1002
  }
}
計費

結算單位為米粒,按調用即時扣費。目前增值固定按 1 元人民幣 = 140 米粒 入賬,活動贈送另計。

  • 調用前檢查餘額 > 0,餘額不足返回 402
  • 按 prompt + completion token 用量計費
  • 支援 Prompt Cache:cache_read_tokens 按折扣價計算

可在控制台增值米粒,並在「用量詳情」中查看調用和消費記錄。

json
// 余额不足响应(402)
{
  "error": {
    "message": "Insufficient balance",
    "type": "insufficient_balance",
    "code": 1004
  }
}
Chat Completions
POST /api/v1/chat/completions

OpenAI 兼容的對話接口,支援串流和非串流輸出。可直接替換 OpenAI SDK 的 base_url

參數類型說明
model 必填string模型 ID,格式 provider_slug/model
messages 必填array對話訊息列表,每條含 rolecontent
streamboolean是否啟用串流輸出(SSE),默認 false
temperaturefloat取樣溫度,範圍 0–2
max_tokensinteger最大輸出 token 數
response_formatobject結構化輸出格式,見「結構化輸出」章節
bash
curl https://miyang.cn/api/v1/chat/completions \
  -H "Authorization: Bearer miyang-xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "miyang/auto",
    "messages": [
      {"role": "user", "content": "Hello!"}
    ],
    "stream": false
  }'
模型列表
GET /api/v1/models

公開接口,無需 API 密鑰。返回目前公開可用模型;攜帶 API 密鑰時還會按賬號權限返回內部或白名單模型。響應欄位在標準 OpenAI 格式基礎上擴展了 pricingcontext_length 和使用範圍資訊。

json
{
  "object": "list",
  "data": [
    {
      "id": "miyang/auto",
      "object": "model",
      "owned_by": "miyang",
      "name": "自动",
      "model_type": "text",
      "usage_scope": "alice",
      "usage_hint": "请在 Alice 客户端内使用",
      "pricing": {
        "prompt": "3.250000",
        "completion": "13.500000",
        "cache_read": "0.550000",
        "cache_write": "0.000000"
      },
      "context_length": 262144
    }
  ]
}
Embeddings
POST /api/v1/embeddings

OpenAI 兼容的向量接口。模型是否支援向量任務,請以模型列表和控制台標記為準。

參數類型說明
model 必填stringEmbedding 模型調用 ID
input 必填string / array需要向量化的文本或文本數組
encoding_formatstring向量編碼格式,常用值為 float
bash
curl https://miyang.cn/api/v1/embeddings \
  -H "Authorization: Bearer miyang-xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "provider/embedding-model",
    "input": "需要向量化的文本"
  }'
Structured Decisions(Jev)
POST /api/v1/decisions

miyang/jev-1.13 是提供給所有米羊 API 用戶的低成本結構化決策模型,底層固定為 typesafe/jev-1.13。它只回答明確問題,不生成對話文本;Alice 的長期記憶預篩是首個正式用途。

任何有效米羊 API 密鑰都可使用 Authorization: Bearer miyang-xxx 調用。它採用獨立 Decisions 協議,不兼容 /api/v1/chat/completions,因此不會混入 Chat 專用的 /api/v1/models 列表。
模型資訊
米羊模型 IDmiyang/jev-1.13
決策引擎typesafe/jev-1.13
上下文上限32768 tokens
問題類型noul / choice / score
價格 輸入 $0.042 / 1M tokens;輸出 $0.000 / 1M tokens。按上游返回的實際 token 用量結算。
開放範圍所有持有效米羊 API 密鑰的用戶

請求必須指定已登記的 Decisions 模型殼;Gateway 會按模型殼計費並固定真實上游。state 保存待判斷的結構化上下文,questions 定義要回答的問題。

參數類型說明
model 必填string公開調用固定填寫 miyang/jev-1.13;內部場景模型殼不可由普通 API 用戶調用。
state 必填object供決策使用的結構化狀態;調用方應在傳送前自行清理不必要的敏感資訊。
questions 必填object以問題名稱為鍵的物件,至少 1 項,最多 24 項。
questions.*.type 必填stringnoul(0–1 概率)、choice(選項)或 score(分數)。
questions.*.instructions 必填string清楚描述模型要判斷的問題。
questions.*.criteriaobject選填;說明各答案或分數分別代表甚麼,以減少歧義。

單次請求內容最大 64 KiB,最多 24 個問題。伺服器不記錄 state 正文或決策答案,只記錄問題數量、耗時與 token 用量。

bash
curl https://miyang.cn/api/v1/decisions \
  -H "Authorization: Bearer miyang-xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "miyang/jev-1.13",
    "state": {"dialog": "用戶問了一個普通技術問題"},
    "questions": {
      "remember": {
        "type": "noul",
        "instructions": "這段對話是否包含值得長期保存的資訊?",
        "criteria": {
          "true": "包含穩定身份、長期偏好或明確關係事件",
          "false": "一次性任務、普通問答或寒暄"
        }
      }
    }
  }'
json
{
  "model": "miyang/jev-1.13",
  "provider": "miyang",
  "answers": {
    "remember": {
      "type": "noul",
      "noul": 0.02
    }
  }
}
Images Generations(文生圖)
POST /api/v1/images/generations

OpenAI 兼容的圖像生成接口。根據文本 prompt 生成圖像,響應返回圖片 URL 或 Base64 數據,與 OpenAI Images API 完全兼容。

圖像生成耗時較長(通常 30–120 秒),請在 SDK 或 HTTP 客戶端中設定 至少 180 秒 的超時。
參數類型說明
model 必填string模型 ID,格式 provider/model,如 ts/gpt-image-2
prompt 必填string圖像描述文本
ninteger生成圖像數量,默認 1,支援多張
sizestring圖像尺寸。常用值:1024x1024(方圖)、1024x1536(豎圖)、1536x1024(橫圖)、auto(模型自動選擇)。最大邊長 3840px,兩邊須為 16 的倍數,長短邊比不超過 3:1
qualitystring渲染質素:low(快速草稿)、mediumhighauto(默認,模型自動選擇)
output_formatstring輸出格式:png(默認)、jpeg(更快)、webp
output_compressioninteger壓縮率 0–100,僅 JPEG / WebP 有效
backgroundstringopaque(默認)或 transparent(透明背景,適合 icon/貼紙)
moderationstring內容審核:auto(默認)或 low(寬鬆)

基礎示例 — 文生圖:

bash
curl https://miyang.cn/api/v1/images/generations \
  -H "Authorization: Bearer miyang-xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "ts/gpt-image-2",
    "prompt": "A children'\''s book drawing of a veterinarian listening to the heartbeat of a baby otter",
    "size": "1024x1024",
    "quality": "high"
  }'
python
from openai import OpenAI
import base64

client = OpenAI(
    api_key="miyang-xxx",
    base_url="https://miyang.cn/api/v1",
    timeout=180.0,  # 图像生成需要较长超时
)

result = client.images.generate(
    model="ts/gpt-image-2",
    prompt="A children's book drawing of a veterinarian listening to the heartbeat of a baby otter",
    size="1024x1024",
    quality="high",
)
print(result.data[0].url)

進階示例 — JPEG 輸出 + 壓縮 + 保存到本地:

python
import httpx, json, base64

resp = httpx.post(
    "https://miyang.cn/api/v1/images/generations",
    headers={"Authorization": "Bearer miyang-xxx"},
    json={
        "model": "ts/gpt-image-2",
        "prompt": "A serene Japanese garden with a koi pond",
        "size": "1536x1024",
        "quality": "medium",
        "output_format": "jpeg",       # jpeg 比 png 更快
        "output_compression": 80,     # 压缩率 0-100
    },
    timeout=180.0,
)
data = resp.json()
print(data["data"][0]["url"])
json
// 响应示例
{
  "created": 1779691963,
  "data": [
    {
      "url": "https://image.token-recyclebin.com/images/2026/05/25/xxx.png",
      "revised_prompt": "A serene Japanese garden with a koi pond..."
    }
  ]
}

尺寸與質素參考

參數可選值說明
size1024x1024(方)
1536x1024(橫)
1024x1536(豎)
2048x2048(2K)
3840x2160(4K 橫)
auto
最大邊長 ≤ 3840px,雙邊為 16 的倍數,比例 ≤ 3:1,總像素 655,360 – 8,294,400
qualitylow · medium · high · autolow 最快,適合草稿和快速迭代;high 最精細,適合最終出圖
output_formatpng · jpeg · webpjpegpng 更快,優先用於對延遲敏感的場景

GPT Image 2 參考定價(米粒 / 張)

Quality1024×10241024×1536 / 1536×1024
Low6 米粒5 米粒
Medium53 米粒41 米粒
High211 米粒165 米粒
Images Edits(墊圖 / 圖生圖)
POST /api/v1/images/edits

OpenAI 兼容的圖像編輯接口。上傳一張或多張參考圖,配合文本 prompt 生成新圖像。支援局部編輯(mask)和多圖合成。請求使用 multipart/form-data 格式。

典型場景:

  • 風格轉換 — 上傳照片 + "轉為油畫風格"
  • 多圖合成 — 上傳多張素材 + "生成包含這些物品的禮品籃"
  • 局部編輯 — 上傳原圖 + mask + "在遮罩區域添加一隻火烈鳥"
參數類型說明
model 必填string模型 ID,如 ts/gpt-image-2
image 必填file / file[]參考圖片。單張用 image,多張用 image[](支援多個 image[]=@file.png
prompt 必填string編輯指令描述
maskfile蒙版圖片(需含 alpha 通道),透明區域為需要編輯的部分。多圖時 mask 應用於第一張
ninteger生成數量,默認 1
sizestring輸出尺寸,默認 auto,支援與 Generations 相同的尺寸選項
qualitystringlow · medium · high · auto

單圖編輯 — 風格轉換:

bash
curl https://miyang.cn/api/v1/images/edits \
  -H "Authorization: Bearer miyang-xxx" \
  -F "model=ts/gpt-image-2" \
  -F "prompt=Turn this photo into a Studio Ghibli style illustration" \
  -F "image=@photo.png" \
  -F "size=1536x1024"
python
from openai import OpenAI

client = OpenAI(
    api_key="miyang-xxx",
    base_url="https://miyang.cn/api/v1",
    timeout=180.0,
)

result = client.images.edit(
    model="ts/gpt-image-2",
    image=open("photo.png", "rb"),
    prompt="Turn this photo into a Studio Ghibli style illustration",
)
print(result.data[0].url)

多圖合成 — 將多張素材合為一張:

bash
# 多图参考:用 image[] 传多张
curl https://miyang.cn/api/v1/images/edits \
  -H "Authorization: Bearer miyang-xxx" \
  -F "model=ts/gpt-image-2" \
  -F "image[]=@lotion.png" \
  -F "image[]=@soap.png" \
  -F "image[]=@candle.png" \
  -F 'prompt=A gift basket on a white background containing all these items'

局部編輯 — 使用 mask 遮罩:

python
# mask 需要有 alpha 通道,透明区域为编辑区
result = client.images.edit(
    model="ts/gpt-image-2",
    image=open("room.png", "rb"),
    mask=open("mask.png", "rb"),
    prompt="Add a flamingo in the pool area",
    quality="high",
)
print(result.data[0].url)
Mask 要求:mask 和原圖須相同尺寸和格式,均 < 50MB。mask 須含 alpha 通道(透明區域為編輯區)。GPT Image 的 mask 是基於 prompt 的引導,不保證精確貼合遮罩邊緣。
Videos Generations(影片生成)
POST /api/v1/videos/generations

異步影片生成接口。建立成功後返回 task_id,請透過查詢接口輪詢任務狀態;不要用同一個業務請求重複建立任務。

目前只對 Alice 與內部帳號開放,可用模型為 miyang/h3miyang/h3-max
參數類型說明
model 必填stringmiyang/h3 或 miyang/h3-max
content 必填array多模態內容陣列,必須包含且只能包含一項非空文字;可同時提供圖片、影片或音訊素材
duration 必填integer輸出時長(秒)。H3 支援 4–15 秒;H3 Max 支援 5–15 秒
resolutionstring預設 768P。H3 支援 768P / 2K;H3 Max 支援 480P / 768P
ratiostring畫面比例:21:9、16:9、4:3、1:1、3:4、9:16;參考素材可用 adaptive
aigc_watermarkboolean是否加入 AIGC 水印
extraobject只限 H3 Max,可設定 prompt_expansion_mode:disabled、balanced 或 quality

content 素材格式

typerole說明
text必填且只能一項,最長 7000 字元
image_urlfirst_frame / last_frame / reference_image首幀、尾幀或參考圖;單張未指定 role 時自動作為首幀
video_urlreference_video參考影片,最多 3 個,必須指定 role
audio_urlreference_audio參考音訊,最多 3 個,必須指定 role
bash
curl https://miyang.cn/api/v1/videos/generations \
  -H "Authorization: Bearer miyang-xxx" \
  -H "Idempotency-Key: alice-video-001" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "miyang/h3",
    "content": [
      {"type": "text", "text": "A lamb runs across a sunlit meadow"}
    ],
    "duration": 5,
    "resolution": "768P",
    "ratio": "16:9"
  }'
json
{
  "task_id": "443429054845209"
}

用戶計費

下表為精確人民幣計價;實際扣費米粒按 CNY price ÷ CNY-per-USD rate × 1000 換算。

模型計費項目用戶價格
miyang/h3輸出影片 · 768P¥1.25 / s
miyang/h3輸出影片 · 2K¥2.0 / s
miyang/h3輸入參考影片 · 768P¥1.25 / s
miyang/h3輸入參考影片 · 2K¥2.0 / s
miyang/h3輸入參考圖(前 5 張免費,超出部分)¥0.5 / 張
miyang/h3-max輸出影片 · 480P¥0.825 / s
miyang/h3-max輸出影片 · 768P¥1.25 / s
miyang/h3-max輸入參考影片 · 480P¥0.925 / s
miyang/h3-max輸入參考影片 · 768P¥2.425 / s
miyang/h3-max輸入參考圖(前 2 張免費,超出部分)¥1.25 / 張
輸入參考音訊免費
輸出影片、輸入參考影片和超額參考圖費用相加後結算。米粒換算使用任務結算時的即時匯率,最終以用量詳情中的實際扣費為準。
查詢影片任務
GET /api/v1/videos/generations/{task_id}

使用建立任務返回的 task_id 輪詢。狀態可能為 queued、running、succeeded、failed 或 cancelled。建議每 5–15 秒查詢一次。

成功影片會自動轉存到目前用戶的米羊盤並佔用雲端空間。空間不足時返回 quota_full,清理檔案或擴充空間後才能完成轉存與結算;播放 URL 為臨時簽名地址,請按需要重新查詢。
bash
curl https://miyang.cn/api/v1/videos/generations/443429054845209 \
  -H "Authorization: Bearer miyang-xxx"
json
{
  "task": {
    "status": "succeeded",
    "resolution": "768P",
    "duration": 5,
    "content": {
      "url": "https://signed.example/video.mp4",
      "drive_file_id": "drv-xxx",
      "size_bytes": 1757278,
      "expires_in": 3600
    }
  }
}
取消影片任務
DELETE /api/v1/videos/generations/{task_id}

取消仍在處理的任務並釋放計費預授權。若任務已有米羊盤檔案,取消時會一併移除;已完成且上游不允許取消時,以接口回應為準。

bash
curl -X DELETE https://miyang.cn/api/v1/videos/generations/443429054845209 \
  -H "Authorization: Bearer miyang-xxx"
網絡搜尋(總覽與計費)

為 Agent 和應用提供即時連網能力:網頁搜尋、新聞搜尋和網頁正文讀取。全部為 GET 接口,使用與推理接口相同的 API 密鑰鑑權(Authorization: Bearer miyang-xxx)。

計費:快速搜尋、網頁讀取、新聞搜尋每次 10 米粒;深度搜尋每次 50 米粒。請求失敗(上游異常、參數錯誤、新聞搜尋無結果)不扣費。
接口參數說明
/api/v1/websearch/searchq深度搜尋:結果附帶頁面正文抽取與重排序上下文,適合 RAG
/api/v1/websearch/simple-searchq快速搜尋:僅返回標題和摘要,響應更快
/api/v1/websearch/readerurl網頁讀取:抓取指定 URL 並轉成乾淨文本
/api/v1/websearch/search-newsq新聞搜尋:只搜近期新聞源,結果同樣附帶檢索上下文
快速搜尋
GET /api/v1/websearch/simple-search

只做搜尋、不做頁面抽取和重排序,通常 1 秒內返回。適合只需要標題 + 摘要 + 鏈接的場景。命中答案卡片時響應會額外包含 answerBox 欄位。

參數類型說明
q 必填string搜尋關鍵詞
bash
curl "https://miyang.cn/api/v1/websearch/simple-search?q=最新AI新闻" \
  -H "Authorization: Bearer miyang-xxx"
json
// 响应示例
{
  "code": 200,
  "message": "ok",
  "took_ms": 950,
  "data": {
    "answerBox": {
      "title": "Latest AI news",
      "snippet": "..."
    },
    "organic": [
      {
        "title": "AI News",
        "link": "https://example.com",
        "snippet": "Latest updates..."
      }
    ]
  }
}
網頁讀取
GET /api/v1/websearch/reader

已知目標網頁 URL 時,抓取頁面並轉換為乾淨的 Markdown 文本。注意此接口返回的是頂層 content 欄位,而不是 data

參數類型說明
url 必填string要讀取的網頁地址,必須以 http://https:// 開頭
bash
curl "https://miyang.cn/api/v1/websearch/reader?url=https://go.dev" \
  -H "Authorization: Bearer miyang-xxx"
json
// 响应示例(content 为页面正文)
{
  "code": 200,
  "message": "ok",
  "content": "# The Go Programming Language\n\nGo is an open source programming language..."
}
新聞搜尋
GET /api/v1/websearch/search-news

只搜尋近期新聞源,其餘鏈路與深度搜尋一致,結果同樣附帶 contexts 正文片段。

沒有匹配的新聞時返回 404(響應體為 {"code": 404, "message": "no search results"}),這屬於正常業務結果,不扣費
參數類型說明
q 必填string新聞搜尋關鍵詞
bash
curl "https://miyang.cn/api/v1/websearch/search-news?q=OpenAI" \
  -H "Authorization: Bearer miyang-xxx"
json
// 响应示例
{
  "code": 200,
  "message": "ok",
  "took_ms": 4200,
  "data": {
    "organic": [
      {
        "title": "Latest OpenAI news",
        "link": "https://example.com/news",
        "snippet": "Recent product and research updates...",
        "contexts": [
          { "idx": 0, "text": "..." }
        ]
      }
    ]
  }
}
串流輸出(SSE)

在請求體中設定 "stream": true 啟用串流輸出,響應格式與 OpenAI 的 SSE 規範完全兼容。串流結束標誌為 data: [DONE]

python
from openai import OpenAI

client = OpenAI(
    api_key="miyang-xxx",
    base_url="https://miyang.cn/api/v1",
)

stream = client.chat.completions.create(
    model="miyang/auto",
    messages=[{"role": "user", "content": "Hello!"}],
    stream=True,
)

for chunk in stream:
    print(chunk.choices[0].delta.content, end="")
結構化輸出

透傳 response_format 欄位,支援 JSON Schema。由上游模型保證輸出格式,平台不做額外處理。

json
{
  "model": "miyang/auto",
  "messages": [...],
  "response_format": {
    "type": "json_schema",
    "json_schema": {
      "name": "result",
      "schema": {
        "type": "object",
        "properties": {
          "answer": { "type": "string" }
        }
      }
    }
  }
}
Prompt Cache

對支援 Prompt Cache 的模型,上游返回的緩存命中 token 會按折扣價計費。平台完整透傳上游 usage 欄位,賬單中會顯示緩存命中量。

不同供應商的欄位名稱有差異:

  • cache_read_input_tokens — Anthropic
  • prompt_cache_hit_tokens — DeepSeek
  • cached_tokens — OpenAI
json
{
  "usage": {
    "prompt_tokens": 1000,
    "completion_tokens": 200,
    "cache_read_input_tokens": 800,   // Anthropic
    "prompt_cache_hit_tokens": 800,    // DeepSeek
    "cached_tokens": 800               // OpenAI
  }
}
Python SDK 示例

只需替換 base_urlapi_key,即可通過 OpenAI SDK 調用。

python
from openai import OpenAI

client = OpenAI(
    api_key="miyang-xxx",
    base_url="https://miyang.cn/api/v1",
)

resp = client.chat.completions.create(
    model="miyang/auto",
    messages=[{"role": "user", "content": "Hello!"}],
)
print(resp.choices[0].message.content)
cURL 示例
bash
# 非流式
curl https://miyang.cn/api/v1/chat/completions \
  -H "Authorization: Bearer miyang-xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "miyang/auto",
    "messages": [{"role": "user", "content": "Hello"}]
  }'

# 流式
curl https://miyang.cn/api/v1/chat/completions \
  -H "Authorization: Bearer miyang-xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "miyang/auto",
    "messages": [{"role": "user", "content": "Hello"}],
    "stream": true
  }'