共有リンクを作成

Agent の API キーを使用して、その Agent の共有リンクを作成できます。エンドユーザーはリンクを開くだけで直接 Agent と対話できます。リンクの有効期限、最大ユーザー数、各ユーザーの最大送信メッセージ数、アクセスパスワード、フィードバック機能の有無を設定可能で、「共有」ページで手動でリンクを作成した場合と同じ効果があります。

• 作成された共有リンクは Agent の共有リンク一覧に同期され、コンソールでユーザー数やクレジット消費を確認でき、引き続き編集や削除が可能です。組織内で共有リンクの編集/削除権限を持つメンバーは、API で作成されたリンクも操作できます。
• 共有リンクの利用によるクレジット消費は、Agent が所属する組織に計上されます。
• 組織がカスタムドメインを設定している場合、返される共有リンクのアドレスはカスタムドメインが使用されます。
• 対応するのは Agent のみで、Workflow の API キーを使用すると Bot 種類が正しくないというエラーが返されます。
• 現在のサイトで「共有」統合チャネルが開放されていない場合、操作はサポートされません。

リクエスト方法

POST

呼び出し URL

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

認証

詳細は API 概要 の認証方式の説明を参照してください。対象 Agent の API キーを token として使用してください。

リクエスト

リクエスト例

                      
                      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
}'

                    

すべてのパラメータは任意です。リクエストボディで {} を送信すると、永久に有効で、パスワード不要、最大 10 人のユーザー、ユーザーごとに最大 9999 件のメッセージ、フィードバック機能を有効にしていない共有リンクが作成されます。アクセスを制限する場合は、明示的に valid_days と password を送信してください。

フィールド名はすべてスネークケース(snake_case)で記述してください。リクエストボディに認識できないフィールド（例えばキャメルケースの validDays）が含まれる場合、API は 40000 を返し、エラーメッセージ内にこれらのフィールドを列挙します。リンクは作成されません。

リクエストヘッダ

リクエストパラメータ

レスポンス

レスポンス例

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

                    

成功レスポンス

失敗レスポンス

エラーコード