REST API

Summary Templates

概述

摘要模板查詢 API。模板用於 transcribe / conversation / broadcast 類型錄音的 summary_template 參數，可指定不同的摘要格式（會議、訪談、醫療諮詢、法律諮詢等）。

端點總覽

方法	端點	說明
GET	`/api/v1/summary-templates`	列出模板（支援 `?category=` 篩選）
GET	`/api/v1/summary-templates/{slug}`	取得單一模板詳細內容（含三層 Prompt 原文）

GET /api/v1/summary-templates

功能說明

取得可用的摘要模板列表，依 category 篩選。在 WebSocket start action 或音檔匯入 API 中使用 summary_template 參數時，填入該模板的 slug 值。

認證方式

Header：X-API-Key（詳見認證機制）

請求參數

欄位	位置	類型	必填	預設	說明
`category`	query	string	否	`summary`	模板類別篩選，可用值：`summary` / `medical` / `legal` / `all`

預設 summary 為向後相容值，僅回傳一般摘要模板，不會包含醫療/法律類別。

請求範例

# 一般摘要（預設 / 向後相容）
curl -X GET "https://vas-poc.vurbo.ai/api/v1/summary-templates" \
  -H "X-API-Key: vas_aB3dE5fG7hI9jK1lM3nO5pQ7rS9tU1vW"

# 醫療類別
curl -X GET "https://vas-poc.vurbo.ai/api/v1/summary-templates?category=medical" \
  -H "X-API-Key: vas_aB3dE5fG7hI9jK1lM3nO5pQ7rS9tU1vW"

# 全部類別
curl -X GET "https://vas-poc.vurbo.ai/api/v1/summary-templates?category=all" \
  -H "X-API-Key: vas_aB3dE5fG7hI9jK1lM3nO5pQ7rS9tU1vW"

成功回應

HTTP 200（?category=all 範例：含所有類別模板）

{
  "data": [
    { "slug": "general",         "name": "通用摘要", "description": "適用於一般對話的摘要模板",   "category": "summary" },
    { "slug": "meeting",         "name": "會議記錄", "description": "會議摘要，包含重點、決議事項與待辦事項", "category": "summary" },
    { "slug": "meeting_minutes", "name": "會議紀要", "description": "詳細的會議紀要模板",         "category": "summary" },
    { "slug": "speech",          "name": "演講摘要", "description": "適用於演講內容的摘要模板",   "category": "summary" },
    { "slug": "interview",       "name": "訪談摘要", "description": "適用於訪談內容的摘要模板",   "category": "summary" },
    { "slug": "course",          "name": "課程摘要", "description": "適用於課程內容的摘要模板",   "category": "summary" },
    { "slug": "medical_consultation", "name": "看診諮詢", "description": "看診諮詢記錄模板，含 19 個醫療欄位", "category": "medical" }
  ]
}

不帶 ?category= 或帶 ?category=summary（預設）只會列出 summary 類別；帶 ?category=medical 只列出醫療類別；帶 ?category=all 列出全部類別。

回應欄位說明

欄位	類型	說明
`data`	array	摘要模板列表
`data[].slug`	string	模板識別碼（用於 API 參數）
`data[].name`	string	模板顯示名稱
`data[].description`	string	模板描述
`data[].category`	string	模板類別（`summary` / `medical` / `legal`）

特有錯誤碼

錯誤碼	HTTP	說明	處理建議
`invalid_category`	400	`category` 不在白名單內	改用 `summary` / `medical` / `legal` / `all`

GET /api/v1/summary-templates/{slug}

曝露 IPEVO 內建模板的三層 Prompt 完整原始文字，供企業客戶整合時參考。客戶若需自家 prompt 規則，請改用摘要 API 的 mode=custom + prompt 參數（完整取代三層），見 POST /api/v1/summary。

功能說明

取得指定 slug 的模板詳細內容。回應包含三層 Prompt：

System Prompt — 角色定義（Layer 1）
Template Prompt — 業務模板規則（Layer 2）
Output Format — 輸出結構（Layer 3）

客戶呼叫摘要 API（mode=builtin）時，內建模板的這三層會自動套用。若客戶想完全用自家規則（取代三層），請改用 mode=custom + prompt 路徑。

認證方式

Header：X-API-Key

使用條款：本端點曝露 IPEVO 內建模板原始文字。API Key 持有者已視為認可 IPEVO ToS — 不得轉售、複製、或於非 IPEVO 服務中重製此 Prompt 內容。

請求參數

欄位	位置	類型	必填	說明
`slug`	path	string	是	模板識別碼（從 `GET /api/v1/summary-templates` 列表中取得）

請求範例

curl -X GET "https://vas-poc.vurbo.ai/api/v1/summary-templates/medical_consultation" \
  -H "X-API-Key: vas_aB3dE5fG7hI9jK1lM3nO5pQ7rS9tU1vW"

成功回應

HTTP 200

{
  "data": {
    "slug": "medical_consultation",
    "name": "看診諮詢",
    "description": "看診諮詢記錄模板",
    "category": "medical",
    "system_prompt": "You are a professional medical records specialist...",
    "template_prompt": "[Task]\nGenerate a structured summary...",
    "output_format": "[Summary Template Begin]\n## Patient Information\n..."
  }
}

回應欄位說明

欄位	類型	說明
`data.slug`	string	模板識別碼
`data.name`	string	模板顯示名稱
`data.description`	string \| null	模板描述
`data.category`	string	模板類別
`data.system_prompt`	string	Layer 1：System Prompt 原文
`data.template_prompt`	string	Layer 2：Template Prompt 原文
`data.output_format`	string	Layer 3：Output Format 原文

特有錯誤碼

錯誤碼	HTTP	說明	處理建議
`template_not_found`	404	指定 slug 的模板不存在或已停用（`is_active=false`）	改用 `GET /api/v1/summary-templates` 列出可用模板