API 說明文件

此文件定義了與 AI 進行資料交互的所有端點規格。


GET

/api/chat/models

獲取所有可以利用的 GPT 模型(僅作為 聊天 生成文字使用),包括各模型詳細資訊,最終回傳 JSON 格式。

程式碼

                
回應 (Response)

                
GET

/api/chat/history/{chat_id}

提供有 {chat_id} 的路徑,對應傳回該指定 {chat_id} 所有的聊天紀錄,最終回傳 JSON 格式。

程式碼範例

                
回應範例 (Response)

                
POST

/api/chat/completion

傳入邀請碼、模型、文圖等至 AI 聊天服務,產生回覆資訊,最終回傳 JSON 格式。

參數名稱 類型 必填 描述
invite_code String 有正確的邀請碼才能使用 AI 服務
model String 傳入 OpenAI 模型(查看所有可用模型 /api/chat/models
prompt String 向 AI 詢問 文字,若有提供圖片可詢問圖片資訊
image_url String 提供 AI 參考 圖片 網址
id String 指定 Chat ID 可根據舊有的上下文繼續詢問,最多 10 輪
未提供或給不存在的 ID,則產生一個新的 4-code 聊天 ID
程式碼範例

                
回應範例 (Response)

                
POST

/api/image/generation

給定邀請碼、Prompt即可生成圖片,最終回傳 JSON 格式。

欄位名稱 類型 必填 描述
invite_code String 有正確的邀請碼才能使用 AI 服務
prompt String 生成的圖片根據此描述
quality String 圖片品質 hd or standard,預設為 standard
程式碼範例

                
回應範例 (Response)