logo
Development
検索
エージェント情報の取得

エージェント情報の取得

エージェントの基本情報を取得します。

リクエストメソッド

GET

リクエストURL

https://api-${endpoint}.gptbots.ai/v1/bot/detail

リクエスト認証

認証方法の説明についてはAPI Overviewをご参照ください。

リクエスト

リクエスト例

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/detail' \ -H 'Authorization: Bearer ${API Key}'
                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/detail' \
-H 'Authorization: Bearer ${API Key}' 

                    
このコードブロックをポップアップで表示

リクエストヘッダー

フィールド タイプ 説明
Authorization Bearer ${API Key} 認証には Authorization: Bearer ${API Key} を使用してください。APIキーはAPIキーページから取得できます。

リクエストボディ

なし

レスポンス

レスポンス例

{ "bot_id": "645dd86606931c4a9e0ffb1e", "name": "Conversational App", "logo": "https://res.gptbots.ai/ailab/images/default_avatar.png", "bot_type": "QuestionAnswer", "welcome_message": "Welcome message when user first uses the bot", "introduction": "Introduction of the agent", "tags": "Tags of the agent", "identity_prompt": "Identity prompt of the agent", "ai_model": "ChatGPT", "ai_model_version": "3.5", "creativity_level": 0.3, "doc_correlation": 0.2, "irrelevant_questions": true, "question_limit": 100, "long_term_memory": true }
                      
                      {
  "bot_id": "645dd86606931c4a9e0ffb1e",
  "name": "Conversational App",
  "logo": "https://res.gptbots.ai/ailab/images/default_avatar.png",
  "bot_type": "QuestionAnswer",
  "welcome_message": "Welcome message when user first uses the bot",
  "introduction": "Introduction of the agent",
  "tags": "Tags of the agent",
  "identity_prompt": "Identity prompt of the agent",
  "ai_model": "ChatGPT",
  "ai_model_version": "3.5", 
  "creativity_level": 0.3,
  "doc_correlation": 0.2,
  "irrelevant_questions": true,
  "question_limit": 100,
  "long_term_memory": true
}

                    
このコードブロックをポップアップで表示

成功時のレスポンス

フィールド タイプ 説明
bot_id String エージェントID
name String エージェント名
logo String エージェントのアバター(URL)
bot_type String エージェント種別。値:QuestionAnswer(Q&A 型)、Flow(フロー型)
welcome_message String ユーザーが初回利用時に受け取るウェルカムメッセージ
introduction String エージェントの紹介文
tags Array エージェントに付与されたタグ(文字列配列)
identity_prompt String エージェントのアイデンティティプロンプト
ai_model String AIモデルの指定(例:ChatGPT)
ai_model_version String AI モデルのバージョン
creativity_level Float 創造性レベル(0〜1)
doc_correlation Float ドキュメント関連度(0〜1)
irrelevant_questions Boolean 関連性のない質問への回答許可(true=許可する、false=許可しない)
question_limit Int ユーザー質問のトークン長上限
long_term_memory Boolean 長期メモリ機能の許可(true=有効、false=無効)

エラー時のレスポンス

フィールド タイプ 説明
code Int エラーコード
message String エラーメッセージ

エラーコード

コード メッセージ
40127 認証に失敗しました
20059 指定のエージェントは削除されています