API 參考
驗證應用程序,生成文字同圖像,創建嵌入,並自動化提供者、設備同創作者嘅工作流程。
第一次 API 請求
創建一個 ShareAI API 密鑰,揀一個可用模型,並從你嘅伺服器用 Bearer 認證發送聊天請求。
選擇合適嘅 API 同憑證
搵到 ShareAI API 端點,用於應用程式認證、聊天、回應、嵌入、圖片、供應商、裝置同創作者,連埋正確嘅 URL 同憑證。
註冊你嘅應用程式
建立應用程式,揀佢嘅部署模式,並只啟用佢需要嘅 ShareAI 功能。
用 PKCE 授權一個賬戶
使用授權碼加 S256 PKCE 用於機密同公開應用程式。
選擇登入、付款同 AI 範圍
登錄、產品付款同推理附加費需要分開功能同客戶授權。
更新訪問權杖
旋轉刷新令牌而唔擴展客戶已授權嘅範圍。
閱讀身份同發現授權端點
使用 ShareAI Auth 發現、JWKS 同 UserInfo 驗證應用程式登錄,並讀取由 OAuth 訪問令牌允許嘅身份。
撤銷權杖同檢查伺服器端授權
撤銷未使用嘅訪問同刷新令牌。機密整合亦可以檢查令牌狀態。
了解接受嘅賬單協議
保持訂閱價格、間隔同 AI 附加費與每位客戶接受嘅條款掛鈎。
創建一個聊天完成
用 Bearer API 密鑰發送 ShareAI 聊天完成請求,並了解支持嘅模型、消息同流字段。
用 OAuth 發送聊天請求
使用經批准嘅 ShareAI OAuth 存取權杖嚟完成客戶資助嘅對話生成,並處理權杖過期、同意同賬戶界限。
串流聊天回應
閱讀 ShareAI 對話生成嘅服務端事件,追加內容增量一次,並處理完成、錯誤同中斷嘅流。
檢查密鑰訪問同帳戶身份
閱讀 ShareAI API 密鑰資訊,以檢查模型同供應商限制,以及與推理憑證相關聯嘅賬戶身份。
建立文字回應
使用 ShareAI 回應 API 嚟進行無狀態文本生成、明確嘅對話歷史同回應流事件。
建立文字嵌入
用 ShareAI 生成文字嵌入,用於語義搜索、檢索同相似性,支持嘅輸入格式同模型要求。
生成圖片
使用支援嘅模型、文字提示同驗證嘅圖像生成選項,通過 ShareAI 圖像 API 創建圖像。
驗證提供者 API
啟用供應商遠程訪問,並使用供應商 UUID 同範圍訪問令牌進行目錄同定價請求。
列出提供者同網絡模型
使用 provider_models:read 閱讀 ShareAI Provider API 網絡目錄、你嘅供應商目錄同埋準確嘅模型詳情。
更新提供者模型定價
使用範圍限定嘅提供者API令牌同準確嘅模型識別碼,設置 ShareAI 提供者模型嘅輸入、輸出同緩存定價層級。
驗證裝置 API
創建一個針對設備嘅遠程控制令牌,並了解 ShareAI 設備API請求嘅提供者、設備同啟用狀態檢查。
閱讀裝置會話同任務歷史
列出ShareAI裝置會話,並用裝置專屬嘅遠端控制權杖檢查會話嘅任務歷史。
開始同停止裝置共享
發送ShareAI裝置共享命令,區分接受嘅命令同觀察到嘅狀態,並喺Console入面驗證結果。
驗證創作者 API
使用 Creator 範圍嘅遠程訪問憑證,並了解 ShareAI Creator API 中可用嘅集合、模型同設置範圍。
閱讀同管理模型集合
使用所需範圍同清晰嘅擁有權同審核界限,列出、創建同更新 ShareAI Creator 模型集合。
創建模型包
一齊創建 ShareAI Creator 模型元數據、集合同模型標籤,並設置明確嘅訪問政策同範圍 API 憑證。
管理集合內嘅模型
列出、閱讀、創建同更新 ShareAI Creator 模型標籤,同時保留其集合所有權同有效嘅服務政策。
處理 API 錯誤同重試
診斷 ShareAI 認證、範圍、模型訪問同可用性錯誤,避免重複寫入或者不安全嘅刷新重試。
了解模型創作者、識別碼同標籤
揀一個準確嘅基於創作者嘅 ShareAI 模型識別碼,探索佢嘅系列,並比較可以運行佢嘅供應商。
為 API 請求揀選執行供應商
使用 ShareAI provider 物件,喺所有四個推理端點中,獨立於模型嘅 Creator 選擇執行 provider。
供應商政策參考
參考 ShareAI 供應商欄位、預設值、限制同錯誤,以揀選推理請求嘅執行供應商。
排序供應商同控制後備選項
了解 ShareAI 價格、延遲同吞吐量排名、排序供應商、無法測量嘅情況同安全後備界限。
了解客戶身份
每個 OAuth 客戶端會為同一個 ShareAI 客戶分配唔同嘅識別碼。
為產品同訂閱付款
建立一個錢包結算,讓客戶喺 ShareAI 確認,再驗證支付結果先執行。
處理賬單錯誤同客戶消費限額
區分信用不足同應用程式嘅消費限制,提供一條識別角色嘅恢復連結,並正確處理串流失敗。