Freigabelink erstellen

Erstellen Sie über den API-Schlüssel des Agenten einen Freigabelink für diesen Agenten. Endbenutzer können den Link öffnen und direkt mit dem Agenten interagieren. Sie können die Gültigkeitsdauer des Links, die maximale Benutzerzahl, die maximale Anzahl der Nachrichten pro Benutzer, ein Zugriffspasswort sowie die Aktivierung von Feedback-Vorschlägen festlegen. Dies hat denselben Effekt wie das manuelle Erstellen eines Freigabelinks auf der Seite „Teilen“.

• Der erstellte Freigabelink wird synchron in der Freigabelink-Liste des Agenten angezeigt. Sie können die Benutzeranzahl und den Punktverbrauch in der Konsole einsehen und den Link weiterhin bearbeiten oder löschen. Mitglieder innerhalb der Organisation mit Berechtigung zum Bearbeiten/Löschen von Freigabelinks können über die API erstellte Links verwalten.
• Der Punktverbrauch durch Freigabelinks wird der Organisation des Agenten zugerechnet.
• Wenn die Organisation eine benutzerdefinierte Domain registriert hat, wird die zurückgegebene Freigabelink-Adresse die benutzerdefinierte Domain verwenden.
• Unterstützt nur Agenten; bei Verwendung des API-Schlüssels eines Workflows wird ein falscher Bot-Typ zurückgegeben.
• Wenn die aktuelle Plattform den Integrationskanal „Teilen“ nicht geöffnet hat, wird die Operation als nicht unterstützt zurückgegeben.

Anfragemethode

POST

Aufrufadresse

https://api-${endpoint}.gptbots.ai/v1/agent/share/create

Authentifizierung beim Aufruf

Details finden Sie in der API-Übersicht unter Angaben zur Authentifizierung. Bitte verwenden Sie den API-Schlüssel des Zielagenten als Token.

Anfrage

Anfragebeispiel

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/agent/share/create' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
        "name": "官网试用链接",
        "valid_days": 7,
        "user_limit": 10,
        "user_question_limit": 9999,
        "password": "Vc3h",
        "feedback_enabled": true
}'

                    

Alle Parameter sind optional. Wenn im Anfragekörper {} übermittelt wird, wird ein dauerhaft gültiger, passwortfreier Freigabelink erstellt, der maximal 10 Benutzer, jeweils höchstens 9999 Nachrichten und keine aktivierten Feedback-Vorschläge erlaubt. Wenn der Zugriff eingeschränkt werden soll, übermitteln Sie explizit valid_days und password.

Alle Feldnamen verwenden Unterstrich-Schreibweise (snake_case). Wenn im Anfragekörper nicht erkannte Felder auftauchen (z.B. in CamelCase wie validDays), gibt die Schnittstelle 40000 zurück und listet diese Felder in der Fehlermeldung auf, der Link wird nicht erstellt.

Anfrage-Header

Anfrageparameter

Antwort

Antwortbeispiel

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "share_id": "66f8c2a1e4b0a93c5d7f1a20",
    "link": "https://www.gptbots.ai/s/csAbC123",
    "expire_time": 1760112000000
  }
}

                    

Erfolgreiche Antwort

Fehlgeschlagene Antwort

Fehlercodes