所有方法¶
Gemini API 的所有 REST 方法,依參考頁面分組。
以下所有路徑皆相對於 https://generativelanguage.googleapis.com。
Gemini Interactions API¶
要求與回應的詳細資訊,請參閱 Gemini Interactions API 參考文件。
| 方法 | HTTP 要求 |
|---|---|
CreateInteraction |
POST /v1beta/interactions 建立新的互動。 |
cancelInteractionById |
POST /v1beta/interactions/{id}/cancel 依 id 取消互動。 |
getInteractionById |
GET /v1beta/interactions/{id} 依 Interaction.id 擷取單一互動的完整詳細資訊。 |
deleteInteraction |
DELETE /v1beta/interactions/{id} 依 id 刪除互動。 |
Gemini Agents API¶
要求與回應的詳細資訊,請參閱 Gemini Agents API 參考文件。
| 方法 | HTTP 要求 |
|---|---|
CreateAgent |
POST /v1beta/agents 建立新的代理(SDK 的具型別版本)。 |
ListAgents |
GET /v1beta/agents 列出所有代理。 |
GetAgent |
GET /v1beta/agents/{agentsId} 取得特定的代理。 |
DeleteAgent |
DELETE /v1beta/agents/{agentsId} 刪除代理。 |
Gemini Webhooks API¶
要求與回應的詳細資訊,請參閱 Gemini Webhooks API 參考文件。
| 方法 | HTTP 要求 |
|---|---|
CreateWebhook |
POST /v1beta/webhooks 建立新的 Webhook。 |
PingWebhook |
POST /v1beta/webhooks/{id}:ping 將 ping 事件傳送至 Webhook。 |
RotateSigningSecret |
POST /v1beta/webhooks/{id}:rotateSigningSecret 為 Webhook 產生新的簽署密鑰。 |
ListWebhooks |
GET /v1beta/webhooks 列出所有 Webhook。 |
GetWebhook |
GET /v1beta/webhooks/{id} 取得特定的 Webhook。 |
UpdateWebhook |
PATCH /v1beta/webhooks/{id} 更新現有的 Webhook。 |
DeleteWebhook |
DELETE /v1beta/webhooks/{id} 刪除 Webhook。 |
Gemini Triggers API¶
要求與回應的詳細資訊,請參閱 Gemini Triggers API 參考文件。
| 方法 | HTTP 要求 |
|---|---|
CreateTrigger |
POST /v1beta/triggers 建立新的觸發條件,依指定的 cron 排程叫用指定的代理。 |
RunTrigger |
POST /v1beta/triggers/{triggerId}/executions 立即執行觸發條件。 |
ListTriggers |
GET /v1beta/triggers 列出專案的觸發條件。 |
GetTrigger |
GET /v1beta/triggers/{id} 取得單一觸發條件的詳細資訊。 |
ListTriggerExecutions |
GET /v1beta/triggers/{triggerId}/executions 列出觸發條件的執行紀錄。 |
UpdateTrigger |
PATCH /v1beta/triggers/{id} 更新觸發條件。 |
DeleteTrigger |
DELETE /v1beta/triggers/{id} 刪除觸發條件。 |
Gemini Environments API¶
要求與回應的詳細資訊,請參閱 Gemini Environments API 參考文件。
| 方法 | HTTP 要求 |
|---|---|
CreateEnvironment |
POST /v1beta/environments 建立環境。 |
ListEnvironments |
GET /v1beta/environments 列出環境。 |
GetEnvironmentFiles |
GET /v1beta/environments/{environment}/files/{path} 從環境的快照擷取檔案中繼資料或目錄內容。 |
GetEnvironment |
GET /v1beta/environments/{id} 取得環境。 |
StartEnvironmentFileUpload |
PUT /upload/v1beta/environments/{environment}/files/{path} 為環境工作區中的檔案啟動可續傳的上傳工作階段。 |
DeleteEnvironment |
DELETE /v1beta/environments/{id} 刪除環境。 |
Gemini Voices API¶
要求與回應的詳細資訊,請參閱 Gemini Voices API 參考文件。
| 方法 | HTTP 要求 |
|---|---|
CreateVoice |
POST /v1beta/voices 從自然語言提示詞(VOICE_TYPE_PROMPTED)或參考與同意音訊錄音(VOICE_TYPE_REPLICATED)建立自訂語音。 |
ListVoices |
GET /v1beta/voices 列出呼叫者擁有的自訂已儲存語音(由新至舊排序),其後接著 Google 語音目錄中的預建系統語音。 |
GetVoice |
GET /v1beta/voices/{voicesId} 依資源名稱取得自訂已儲存語音(store = true)。 |
DeleteVoice |
DELETE /v1beta/voices/{voicesId} 依資源名稱刪除自訂已儲存語音(store = true)。 |
Gemini Credentials API¶
要求與回應的詳細資訊,請參閱 Gemini Credentials API 參考文件。
| 方法 | HTTP 要求 |
|---|---|
CreateCredential |
POST /v1beta/credentials 建立新的憑證。 |
ListCredentials |
GET /v1beta/credentials 列出憑證。 |
GetCredential |
GET /v1beta/credentials/{id} 依 ID 取得憑證。 |
UpdateCredential |
PATCH /v1beta/credentials/{id} 更新憑證。 |
DeleteCredential |
DELETE /v1beta/credentials/{id} 刪除憑證。 |
Gemini Decisions API¶
要求與回應的詳細資訊,請參閱 Gemini Decisions API 參考文件。
| 方法 | HTTP 要求 |
|---|---|
CreateDecision |
POST /v1beta/decisions 針對共用輸入評估一批結構化決策問題。 |
產生內容¶
要求與回應的詳細資訊,請參閱 產生內容參考文件。
| 方法 | HTTP 要求 |
|---|---|
GenerateContent |
POST /v1beta/models/{model}:generateContent 依輸入的 GenerateContentRequest 產生模型回應。 |
StreamGenerateContent |
POST /v1beta/models/{model}:streamGenerateContent 依輸入的 GenerateContentRequest 從模型產生串流回應。 |
CreateToken |
POST /v1beta/auth_tokens 建立可用於限制 BidiGenerateContent 工作階段行為的權杖。 |
模型¶
要求與回應的詳細資訊,請參閱 Models 參考文件。
| 方法 | HTTP 要求 |
|---|---|
GetModel |
GET /v1beta/models/{model} 取得特定 Model 的資訊,例如其版本號碼、權杖上限、參數 與其他中繼資料。 |
ListModels |
GET /v1beta/models 列出可透過 Gemini API 使用的 Model。 |
Batch API¶
要求與回應的詳細資訊,請參閱 Batch API 參考文件。
| 方法 | HTTP 要求 |
|---|---|
BatchGenerateContent |
POST /v1beta/models/{model}:batchGenerateContent 將一批 GenerateContent 要求排入佇列,進行批次處理。 |
AsyncBatchEmbedContent |
POST /v1beta/models/{model}:asyncBatchEmbedContent 將一批 EmbedContent 要求排入佇列,進行批次處理。 |
GetBatch |
GET /v1beta/batches/{generateContentBatch} 取得長時間執行作業的最新狀態。 |
ListBatches |
GET /v1beta/batches 列出符合要求中所指定篩選條件的作業。 |
CancelBatch |
POST /v1beta/batches/{generateContentBatch}:cancel 開始非同步取消長時間執行作業。 |
DeleteBatch |
DELETE /v1beta/batches/{generateContentBatch} 刪除長時間執行作業。 |
UpdateGenerateContentBatch |
PATCH /v1beta/batches/{generateContentBatch}:updateGenerateContentBatch 更新一批用於批次處理的 GenerateContent 要求。 |
UpdateEmbedContentBatch |
PATCH /v1beta/batches/{generateContentBatch}:updateEmbedContentBatch 更新一批用於批次處理的 EmbedContent 要求。 |
使用檔案¶
要求與回應的詳細資訊,請參閱 使用檔案參考文件。
| 方法 | HTTP 要求 |
|---|---|
GetFile |
GET /v1beta/files/{file} 取得指定 File 的中繼資料。 |
ListFiles |
GET /v1beta/files 列出提出要求的專案所擁有之 File 的中繼資料。 |
DeleteFile |
DELETE /v1beta/files/{file} 刪除 File。 |
RegisterFiles |
POST /v1beta/files:register 向 FileService 註冊 Google Cloud Storage 檔案。 |
CreateFile |
POST /v1beta/files 建立 File。 |
計算權杖數¶
要求與回應的詳細資訊,請參閱 計算權杖數參考文件。
| 方法 | HTTP 要求 |
|---|---|
CountTokens |
POST /v1beta/models/{model}:countTokens 對輸入的 Content 執行模型的 tokenizer,並傳回權杖數量。 |
Caching¶
要求與回應的詳細資訊,請參閱 Caching 參考文件。
| 方法 | HTTP 要求 |
|---|---|
CreateCachedContent |
POST /v1beta/cachedContents 建立 CachedContent 資源。 |
ListCachedContents |
GET /v1beta/cachedContents 列出 CachedContent。 |
GetCachedContent |
GET /v1beta/cachedContents/{id} 讀取 CachedContent 資源。 |
UpdateCachedContent |
PATCH /v1beta/cachedContents/{id} 更新 CachedContent 資源(僅到期時間可更新)。 |
DeleteCachedContent |
DELETE /v1beta/cachedContents/{id} 刪除 CachedContent 資源。 |
Embeddings¶
要求與回應的詳細資訊,請參閱 Embeddings 參考文件。
| 方法 | HTTP 要求 |
|---|---|
EmbedContent |
POST /v1beta/models/{model}:embedContent 使用指定的 Gemini Embedding 模型,從輸入的 Content 產生文字嵌入向量。 |
BatchEmbedContents |
POST /v1beta/models/{model}:batchEmbedContents 從輸入的 Content 產生多個嵌入向量;其內容由一批以 EmbedContentRequest 物件表示的字串組成。 |
AsyncBatchEmbedContent |
POST /v1beta/models/{model}:asyncBatchEmbedContent 將一批 EmbedContent 要求排入佇列,進行批次處理。 |
File Search Stores¶
要求與回應的詳細資訊,請參閱 File Search Stores 參考文件。
| 方法 | HTTP 要求 |
|---|---|
CreateFileSearchStore |
POST /v1beta/fileSearchStores 建立空的 FileSearchStore。 |
DeleteFileSearchStore |
DELETE /v1beta/fileSearchStores/{fileSearchStore} 刪除 FileSearchStore。 |
GetFileSearchStore |
GET /v1beta/fileSearchStores/{fileSearchStore} 取得特定 FileSearchStore 的資訊。 |
ListFileSearchStores |
GET /v1beta/fileSearchStores 列出使用者擁有的所有 FileSearchStores。 |
ImportFile |
POST /v1beta/fileSearchStores/{fileSearchStore}:importFile 將 File 從 File Service 匯入 FileSearchStore。 |
GetFileSearchStoreOperation |
GET /v1beta/fileSearchStores/{fileSearchStore}/operations/{operation} 取得長時間執行作業的最新狀態。 |
GetFileSearchStoreUploadOperation |
GET /v1beta/fileSearchStores/{fileSearchStoresId}/upload/operations/{operationsId} 取得長時間執行作業的最新狀態。 |
UploadToFileSearchStore |
POST /v1beta/fileSearchStores/{fileSearchStore}:uploadToFileSearchStore 將資料上傳至 FileSearchStore,預先處理並分塊後,儲存至 FileSearchStore Document。 |
文件¶
要求與回應的詳細資訊,請參閱 文件參考文件。
| 方法 | HTTP 要求 |
|---|---|
DeleteDocument |
DELETE /v1beta/fileSearchStores/{fileSearchStore}/documents/{document} 刪除 Document。 |
GetDocument |
GET /v1beta/fileSearchStores/{fileSearchStore}/documents/{document} 取得特定 Document 的資訊。 |
ListDocuments |
GET /v1beta/fileSearchStores/{fileSearchStore}/documents 列出所有 Document(位於 Corpus 中)。 |