Gemini 4 Argon ist jetzt verfügbar. Jetzt ausprobieren.

Google verwendet KI-Technologie, um Inhalte in Ihre bevorzugte Sprache zu übersetzen. KI-Übersetzungen können Fehler enthalten.

Gemini Webhooks API

Mit Webhooks kann die Gemini API Echtzeitbenachrichtigungen an Ihren Server senden, wenn asynchrone Vorgänge oder Vorgänge mit langer Ausführungszeit abgeschlossen sind. Dadurch ist es nicht mehr erforderlich, die API nach Statusaktualisierungen abzufragen, was die Latenz und den Overhead reduziert.

Als Markdown ansehen OpenAPI-Spezifikation ansehen

CreateWebhook

post https://generativelanguage.googleapis.com/v1beta/webhooks

Erstellt einen neuen Webhook.

Anfragetext
Antwort

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

name String (optional)

Optional. Der vom Nutzer angegebene Name des Webhooks.

subscribed_events array (enum (string)) (erforderlich)

Erforderlich. Die Ereignisse, für die der Webhook abonniert ist. Verfügbare Ereignisse: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Mögliche Werte:

batch.succeeded
Die Batchverarbeitung wurde abgeschlossen.
batch.expired
Der Batch wurde nicht innerhalb von 48 Stunden verarbeitet.
batch.failed
Batchjob fehlgeschlagen.
interaction.requires_action
Für die Interaktion ist eine Aktion erforderlich (z.B. ein Funktionsaufruf).
interaction.completed
Die Interaktion wurde erfolgreich abgeschlossen.
interaction.failed
Interaktion fehlgeschlagen.
video.generated
Die Videogenerierung ist abgeschlossen.

uri string (erforderlich)

Erforderlich. Der URI, an den Webhook-Ereignisse gesendet werden.

Antwort

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

create_time string (optional)

Nur Ausgabe. Der Zeitstempel für die Erstellung des Webhooks.

id String (optional)

Nur Ausgabe. Die ID des Webhooks.

name String (optional)

Optional. Der vom Nutzer angegebene Name des Webhooks.

new_signing_secret String (optional)

Nur Ausgabe. Das neue Signatur-Secret für den Webhook. Wird nur bei der Erstellung ausgefüllt.

signing_secrets array (SigningSecret) (optional)

Nur Ausgabe. Die mit diesem Webhook verknüpften Signatur-Secrets.

Felder

expire_time string (optional)

Nur Ausgabe. Das Ablaufdatum des Signatur-Secrets.

truncated_secret string (optional)

Nur Ausgabe. Die gekürzte Version des Signatur-Secrets.

state enum (string) (optional)

Nur Ausgabe. Der Status des Webhooks.

Mögliche Werte:

enabled
Der Webhook ist aktiviert.
disabled
Der Webhook wurde vom Nutzer deaktiviert.
disabled_due_to_failed_deliveries
Der Webhook ist aufgrund fehlgeschlagener Zustellungen deaktiviert.

subscribed_events array (enum (string)) (optional)

Mögliche Werte:

batch.succeeded
Die Batchverarbeitung wurde abgeschlossen.
batch.expired
Der Batch wurde nicht innerhalb von 48 Stunden verarbeitet.
batch.failed
Batchjob fehlgeschlagen.
interaction.requires_action
Für die Interaktion ist eine Aktion erforderlich (z.B. ein Funktionsaufruf).
interaction.completed
Die Interaktion wurde erfolgreich abgeschlossen.
interaction.failed
Interaktion fehlgeschlagen.
video.generated
Die Videogenerierung ist abgeschlossen.

update_time string (optional)

Nur Ausgabe. Der Zeitstempel, der angibt, wann der Webhook zuletzt aktualisiert wurde.

uri string (optional)

Erforderlich. Der URI, an den Webhook-Ereignisse gesendet werden.

Beispiel

Beispielantwort

{
  "create_time": "string",
  "id": "string",
  "name": "string",
  "new_signing_secret": "string",
  "signing_secrets": [
    {
      "expire_time": "string",
      "truncated_secret": "string"
    }
  ],
  "state": "enabled",
  "subscribed_events": [
    "batch.succeeded"
  ],
  "update_time": "string",
  "uri": "string"
}

PingWebhook

post https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:ping

Sendet ein Ping-Ereignis an einen Webhook.

Pfad-/Suchparameter
Anfragetext
Antwort

Pfad-/Suchparameter

id String (erforderlich)

Erforderlich. Die ID des zu pingenden Webhooks. Format: `{webhook_id}`

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

Antwort

Bei Erfolg ist die Antwort leer.

Beispiel

RotateSigningSecret

post https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:rotateSigningSecret

Generiert ein neues Signierungs-Secret für einen Webhook.

Pfad-/Suchparameter
Anfragetext
Antwort

Pfad-/Suchparameter

id String (erforderlich)

Erforderlich. Die ID des Webhooks, für den ein Signatur-Secret generiert werden soll. Format: `{webhook_id}`

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

revocation_behavior enum (string) (optional)

Optional. Das Widerrufsverhalten für frühere Signatur-Secrets.

Mögliche Werte:

revoke_previous_secrets_after_h24
Generieren Sie ein neues Signierungs-Secret und widerrufen Sie alle vorherigen Secrets nach 24 Stunden. Standard- und sicherste Option für Migrationen.
revoke_previous_secrets_immediately
Widerrufen Sie sofort alle vorherigen Secrets. Verwenden Sie diese Option mit Vorsicht, da laufende Benachrichtigungen dadurch unterbrochen werden können.

Antwort

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

secret string (optional)

Nur Ausgabe. Das neu generierte Signatur-Secret.

Beispiel

Beispielantwort

{
  "secret": "string"
}

ListWebhooks

get https://generativelanguage.googleapis.com/v1beta/webhooks

Listet alle Webhooks auf.

Pfad-/Suchparameter
Antwort

Pfad-/Suchparameter

page_size integer (optional)

Optional. Die maximale Anzahl der zurückzugebenden Webhooks. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 50 Webhooks zurückgegeben. Der Höchstwert ist 1.000.

page_token string (optional)

Optional. Ein Seitentoken, das von einem vorherigen `ListWebhooks`-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Antwort

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

next_page_token string (optional)

Ein Token, das als „page_token“ gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

webhooks array (Webhook) (optional)

Die Webhooks.

Beispiel

Beispielantwort

{
  "next_page_token": "string",
  "webhooks": [
    {
      "create_time": "string",
      "id": "string",
      "name": "string",
      "new_signing_secret": "string",
      "signing_secrets": [
        {
          "expire_time": "string",
          "truncated_secret": "string"
        }
      ],
      "state": "enabled",
      "subscribed_events": [
        "batch.succeeded"
      ],
      "update_time": "string",
      "uri": "string"
    }
  ]
}

GetWebhook

get https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Ruft einen bestimmten Webhook ab.

Pfad-/Suchparameter
Antwort

Pfad-/Suchparameter

id String (erforderlich)

Erforderlich. Die ID des abzurufenden Webhooks.

Antwort

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

create_time string (optional)

Nur Ausgabe. Der Zeitstempel für die Erstellung des Webhooks.

id String (optional)

Nur Ausgabe. Die ID des Webhooks.

name String (optional)

Optional. Der vom Nutzer angegebene Name des Webhooks.

new_signing_secret String (optional)

Nur Ausgabe. Das neue Signatur-Secret für den Webhook. Wird nur bei der Erstellung ausgefüllt.

signing_secrets array (SigningSecret) (optional)

Nur Ausgabe. Die mit diesem Webhook verknüpften Signatur-Secrets.

Felder

expire_time string (optional)

Nur Ausgabe. Das Ablaufdatum des Signatur-Secrets.

truncated_secret string (optional)

Nur Ausgabe. Die gekürzte Version des Signatur-Secrets.

state enum (string) (optional)

Nur Ausgabe. Der Status des Webhooks.

Mögliche Werte:

enabled
Der Webhook ist aktiviert.
disabled
Der Webhook wurde vom Nutzer deaktiviert.
disabled_due_to_failed_deliveries
Der Webhook ist aufgrund fehlgeschlagener Zustellungen deaktiviert.

subscribed_events array (enum (string)) (optional)

Mögliche Werte:

batch.succeeded
Die Batchverarbeitung wurde abgeschlossen.
batch.expired
Der Batch wurde nicht innerhalb von 48 Stunden verarbeitet.
batch.failed
Batchjob fehlgeschlagen.
interaction.requires_action
Für die Interaktion ist eine Aktion erforderlich (z.B. ein Funktionsaufruf).
interaction.completed
Die Interaktion wurde erfolgreich abgeschlossen.
interaction.failed
Interaktion fehlgeschlagen.
video.generated
Die Videogenerierung ist abgeschlossen.

update_time string (optional)

Nur Ausgabe. Der Zeitstempel, der angibt, wann der Webhook zuletzt aktualisiert wurde.

uri string (optional)

Erforderlich. Der URI, an den Webhook-Ereignisse gesendet werden.

Beispiel

Beispielantwort

{
  "create_time": "string",
  "id": "string",
  "name": "string",
  "new_signing_secret": "string",
  "signing_secrets": [
    {
      "expire_time": "string",
      "truncated_secret": "string"
    }
  ],
  "state": "enabled",
  "subscribed_events": [
    "batch.succeeded"
  ],
  "update_time": "string",
  "uri": "string"
}

UpdateWebhook

patch https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Aktualisiert einen vorhandenen Webhook.

Pfad-/Suchparameter
Anfragetext
Antwort

Pfad-/Suchparameter

id String (erforderlich)

Erforderlich. Die ID des zu aktualisierenden Webhooks.

update_mask string (optional)

Optional. Die Liste der zu aktualisierenden Felder.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

name String (optional)

Optional. Der vom Nutzer angegebene Name des Webhooks.

state enum (string) (optional)

Optional. Der Status des Webhooks.

Mögliche Werte:

enabled
Der Webhook ist aktiviert.
disabled
Der Webhook wurde vom Nutzer deaktiviert.
disabled_due_to_failed_deliveries
Der Webhook ist aufgrund fehlgeschlagener Zustellungen deaktiviert.

subscribed_events array (enum (string)) (optional)

Optional. Die Ereignisse, für die der Webhook abonniert ist. Verfügbare Ereignisse: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Mögliche Werte:

batch.succeeded
Die Batchverarbeitung wurde abgeschlossen.
batch.expired
Der Batch wurde nicht innerhalb von 48 Stunden verarbeitet.
batch.failed
Batchjob fehlgeschlagen.
interaction.requires_action
Für die Interaktion ist eine Aktion erforderlich (z.B. ein Funktionsaufruf).
interaction.completed
Die Interaktion wurde erfolgreich abgeschlossen.
interaction.failed
Interaktion fehlgeschlagen.
video.generated
Die Videogenerierung ist abgeschlossen.

uri string (optional)

Optional. Der URI, an den Webhook-Ereignisse gesendet werden.

Antwort

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

create_time string (optional)

Nur Ausgabe. Der Zeitstempel für die Erstellung des Webhooks.

id String (optional)

Nur Ausgabe. Die ID des Webhooks.

name String (optional)

Optional. Der vom Nutzer angegebene Name des Webhooks.

new_signing_secret String (optional)

Nur Ausgabe. Das neue Signatur-Secret für den Webhook. Wird nur bei der Erstellung ausgefüllt.

signing_secrets array (SigningSecret) (optional)

Nur Ausgabe. Die mit diesem Webhook verknüpften Signatur-Secrets.

Felder

expire_time string (optional)

Nur Ausgabe. Das Ablaufdatum des Signatur-Secrets.

truncated_secret string (optional)

Nur Ausgabe. Die gekürzte Version des Signatur-Secrets.

state enum (string) (optional)

Nur Ausgabe. Der Status des Webhooks.

Mögliche Werte:

enabled
Der Webhook ist aktiviert.
disabled
Der Webhook wurde vom Nutzer deaktiviert.
disabled_due_to_failed_deliveries
Der Webhook ist aufgrund fehlgeschlagener Zustellungen deaktiviert.

subscribed_events array (enum (string)) (optional)

Mögliche Werte:

batch.succeeded
Die Batchverarbeitung wurde abgeschlossen.
batch.expired
Der Batch wurde nicht innerhalb von 48 Stunden verarbeitet.
batch.failed
Batchjob fehlgeschlagen.
interaction.requires_action
Für die Interaktion ist eine Aktion erforderlich (z.B. ein Funktionsaufruf).
interaction.completed
Die Interaktion wurde erfolgreich abgeschlossen.
interaction.failed
Interaktion fehlgeschlagen.
video.generated
Die Videogenerierung ist abgeschlossen.

update_time string (optional)

Nur Ausgabe. Der Zeitstempel, der angibt, wann der Webhook zuletzt aktualisiert wurde.

uri string (optional)

Erforderlich. Der URI, an den Webhook-Ereignisse gesendet werden.

Beispiel

Beispielantwort

{
  "create_time": "string",
  "id": "string",
  "name": "string",
  "new_signing_secret": "string",
  "signing_secrets": [
    {
      "expire_time": "string",
      "truncated_secret": "string"
    }
  ],
  "state": "enabled",
  "subscribed_events": [
    "batch.succeeded"
  ],
  "update_time": "string",
  "uri": "string"
}

DeleteWebhook

delete https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Löscht einen Webhook.

Pfad-/Suchparameter
Antwort

Pfad-/Suchparameter

id String (erforderlich)

Erforderlich. Die ID des zu löschenden Webhooks. Format: `{webhook_id}`

Antwort

Bei Erfolg ist die Antwort leer.

Beispiel

Ressourcen

Webhook

Eine Webhook-Ressource.

Felder

create_time string (optional)

Nur Ausgabe. Der Zeitstempel für die Erstellung des Webhooks.

id String (optional)

Nur Ausgabe. Die ID des Webhooks.

name String (optional)

Optional. Der vom Nutzer angegebene Name des Webhooks.

new_signing_secret String (optional)

Nur Ausgabe. Das neue Signatur-Secret für den Webhook. Wird nur bei der Erstellung ausgefüllt.

signing_secrets array (SigningSecret) (optional)

Nur Ausgabe. Die mit diesem Webhook verknüpften Signatur-Secrets.

Felder

expire_time string (optional)

Nur Ausgabe. Das Ablaufdatum des Signatur-Secrets.

truncated_secret string (optional)

Nur Ausgabe. Die gekürzte Version des Signatur-Secrets.

state enum (string) (optional)

Nur Ausgabe. Der Status des Webhooks.

Mögliche Werte:

enabled
Der Webhook ist aktiviert.
disabled
Der Webhook wurde vom Nutzer deaktiviert.
disabled_due_to_failed_deliveries
Der Webhook ist aufgrund fehlgeschlagener Zustellungen deaktiviert.

subscribed_events array (enum (string)) (optional)

Mögliche Werte:

batch.succeeded
Die Batchverarbeitung wurde abgeschlossen.
batch.expired
Der Batch wurde nicht innerhalb von 48 Stunden verarbeitet.
batch.failed
Batchjob fehlgeschlagen.
interaction.requires_action
Für die Interaktion ist eine Aktion erforderlich (z.B. ein Funktionsaufruf).
interaction.completed
Die Interaktion wurde erfolgreich abgeschlossen.
interaction.failed
Interaktion fehlgeschlagen.
video.generated
Die Videogenerierung ist abgeschlossen.

update_time string (optional)

Nur Ausgabe. Der Zeitstempel, der angibt, wann der Webhook zuletzt aktualisiert wurde.

uri string (optional)

Erforderlich. Der URI, an den Webhook-Ereignisse gesendet werden.