AI アシスタント

新しい AI アシスタントの作成

POST /api/v1/chatbots/

リクエスト内容

リクエストパラメータ

フィールド	型	必須	説明
name	string	はい	Chatbot name. In Agent mode it carries semantic meaning; in other modes it only distinguishes chatbots.
largeLanguageModel	string (uuid)	はい	チャットボットが回答生成に使用する大規模言語モデルです（組織が独自に作成した AI Gateway モデルを含みます）。
embeddingModel	string (uuid)	いいえ	テキストのベクトル化に使用する埋め込みモデルです。指定は任意です。
rerankerModel	string (uuid)	いいえ	リランキングに使用するモデルです。指定は任意です。
instructions	string	いいえ	Role instructions describing the chatbot's role and behavior.
knowledgeBases	array[IdName]	いいえ	チャットボットがアクセスできるナレッジベースの一覧です。
databases	array[IdName]	いいえ	チャットボットがアクセスできる SQL データベースの一覧です（Text-to-SQL 機能で使用します）。
organization	string (uuid)	いいえ	チャットボットが所属する組織です。空の場合は個人用チャットボットになります。
replyMode	object	いいえ	応答モード：通常応答またはストリーミング応答 normal: 通常 ; template: テンプレート ; hybrid: ハイブリッド ; agent: エージェント;
template	string	いいえ	Template used by Template and Hybrid modes.
unanswerableTemplate	string	いいえ	Template used by Template and Hybrid modes when the question cannot be answered.
totalWordsCount	integer (int64)	いいえ	Accumulated total word count used.
outputMode	object	いいえ	出力モード：テキスト、表、またはカスタム形式 text: テキスト ; json_schema: JSON Schema;
rawOutputFormat	object	いいえ	カスタム出力形式の JSON 構造定義です。
groups	array[IdName]	いいえ	チャットボットがアクセスできるグループの一覧です。
tools	array[ToolSummary]	いいえ	チャットボットが使用できるツールの一覧です。
skills	array[SkillSummary]	いいえ	チャットボットに関連付けられたスキルの一覧です。
connectors	array[IdName]	いいえ	Connectors associated with this chatbot, gating per-contact OAuth authorization
agentMode	object	いいえ	エージェントモード：通常、SQL、またはワークフローモード normal: 通常 ; canvas: キャンバス ; team: チーム;
numberOfRetrievedChunks	integer	いいえ	取得する参照チャンク数です。デフォルトは 12、最小値は 1 です。
defaultLabelRelations	object	いいえ	アシスタント単位のデフォルトのナレッジベースラベルフィルタです。形式は query_metadata.label_relations と同じで、null はフィルタなしを意味します。呼び出し元が query_metadata を指定しない場合にのみ、優先度が最も低いフォールバックとして適用されます。
useFullRetrievalRange	boolean	いいえ	有効にすると、LLM の top_k による切り詰めを無視し、リランカーの結果をすべて返します。
enableEvaluation	boolean	いいえ
enableInlineCitations	boolean	いいえ	Enables inline citations, inserting citation markers such as [1][2] into responses.
enableCodeInterpreter	boolean	いいえ	When enabled, provides the Code Interpreter tool to run code in an isolated container.
enableBrowserTool	boolean	いいえ	Enable browser automation tool for web tasks
enableImageSearch	boolean	いいえ	Provide the image_search tool when any attached knowledge base uses a multimodal embedding model. Disable to remove the tool entirely.
enableClaudeStreamRetry	boolean	いいえ	When a Claude streaming call stalls (first-chunk or mid-stream), abort and re-issue the call once in non-streaming mode. Mid-stream retries send a reset signal so the client discards any partial outpu...
customMaxLlmOutputTokens	integer	いいえ	LLM の最大出力トークン数をカスタマイズします。最小値は 512 です。
voiceConfig	object	いいえ
voiceConfig.enabled	boolean	いいえ	Whether this chatbot can be used as a voice agent. Checked by every conversation platform (WebChat, SIP phone, admin/marketplace voice test) instead of a per-platform toggle.
voiceConfig.voiceAgentType	string (uuid)	いいえ	Voice agent mode type.
voiceConfig.sttProvider	string (uuid)	いいえ	Speech-to-Text service provider.
voiceConfig.sttConfig	object	いいえ	STT configuration parameters (JSON).
voiceConfig.ttsProvider	string (uuid)	いいえ	Text-to-Speech service provider.
voiceConfig.ttsConfig	object	いいえ	TTS configuration parameters (JSON).
voiceConfig.realtimeProvider	string (uuid)	いいえ	Realtime end-to-end voice model provider.
voiceConfig.realtimeConfig	object	いいえ	Realtime configuration parameters (JSON).
voiceConfig.realtimeInstructions	string	いいえ	Prompt dedicated to the realtime voice session; falls back to chatbot instructions when empty
voiceConfig.turnHandling	object	いいえ	Turn-taking and interruption settings for the voice agent.
voiceConfig.enableVoiceReply	boolean	いいえ	When disabled, the voice agent replies in text only and does not speak
thinkingConfig	object	いいえ	推論レベル：null（モデルのデフォルト）または {"reasoning_effort": "off
enableToolSearching	boolean	いいえ	動的ツール検索を有効にし、エージェントが tool_searching_tool を通じてツールを動的に検出して読み込めるようにします。
maxAgentIterations	integer	いいえ	Maximum number of iterations for AgentWorkflow (1-100, default: 20)
agentTimeoutSeconds	integer	いいえ	Timeout in seconds for AgentWorkflow execution (30-1200, default: 600)
agentTimeoutMessage	string	いいえ	Custom user-facing message shown when AgentWorkflow times out (max 500 chars). Leave empty to use the system default.
requireTextWithFlexCards	boolean	いいえ	When enabled, a turn that would end with only Flex Message cards and no text for the user is re-issued to the LLM once, asking it to write the text first and then send the card. Each retry incurs a se...
enableSizeBasedToolResultTruncation	boolean	いいえ	When enabled, tool results exceeding the character threshold are truncated using head+tail strategy instead of the legacy SYSTEM_TOOLS whitelist approach. Reduces memory bloat from large tool outputs ...
toolResultMaxChars	integer	いいえ	Character threshold for size-based tool result truncation (500-50000). Only effective when enable_size_based_tool_result_truncation is True.
enableVectorMemory	boolean	いいえ	When enabled, archived messages are vectorized and processed by fact extraction for semantic retrieval (existing behavior). When disabled, archived messages are discarded and only the active chat hist...
longTermMemoryTopK	integer	いいえ	長期メモリの検索ごとに取得するメモリノード数です（ベクトル検索の similarity_top_k）。デフォルトは 10、範囲は 1–50 です。
enableCrossConversationSearch	boolean	いいえ	When enabled, the conversation history tools also reach this contact's other conversations in the same inbox, within the lookback window. When disabled, they only reach the current conversation.
crossConversationLookbackDays	integer	いいえ	How far back cross-conversation search may reach, measured from each conversation's last message (1-365 days). Leave empty to fall back to 90 days. Only effective when enable_cross_conversation_search...
useGatewayFallback	boolean	いいえ	When enabled, use the fallback group instead of the single LLM
gatewayFallbackGroup	string (uuid)	いいえ
enableSearchMessagesTool	boolean	いいえ	Allow the AI to search past messages in the current conversation.
enableGetMessageContextTool	boolean	いいえ	Allow the AI to retrieve messages surrounding a specific message for context.
enableReadAttachmentFullTextTool	boolean	いいえ	Allow the AI to read the full text of plain-text attachments. AGENT mode only.
enableParseAttachmentContentTool	boolean	いいえ	Allow the AI to parse PDF, Office, audio, and other attachments. AGENT mode only.
enableListAvailableParsersTool	boolean	いいえ	Allow the AI to list available parsers and their capabilities. AGENT mode only.
enableGetDownloadLinkTool	boolean	いいえ	Allow the AI to generate shareable download links for produced content. AGENT mode only.

リクエスト構造の例

{
  "name": string // Chatbot name. In Agent mode it carries semantic meaning; in other modes it only distinguishes chatbots.
  "largeLanguageModel": string (uuid) // チャットボットが回答生成に使用する大規模言語モデルです（組織が独自に作成した AI Gateway モデルを含みます）。
  "embeddingModel"?: string (uuid) // テキストのベクトル化に使用する埋め込みモデルです。指定は任意です。 (任意)
  "rerankerModel"?: string (uuid) // リランキングに使用するモデルです。指定は任意です。 (任意)
  "instructions"?: string // Role instructions describing the chatbot's role and behavior. (任意)
  "knowledgeBases"?: [ // チャットボットがアクセスできるナレッジベースの一覧です。 (任意)
    {
      "id": string (uuid)
    }
  ]
  "databases"?: [ // チャットボットがアクセスできる SQL データベースの一覧です（Text-to-SQL 機能で使用します）。 (任意)
    {
      "id": string (uuid)
    }
  ]
  "organization"?: string (uuid) // チャットボットが所属する組織です。空の場合は個人用チャットボットになります。 (任意)
  "replyMode"?:  // 応答モード：通常応答またはストリーミング応答

* `normal` - 通常
* `template` - テンプレート
* `hybrid` - ハイブリッド
* `agent` - エージェント (任意)
  {
  }
  "template"?: string // Template used by Template and Hybrid modes. (任意)
  "unanswerableTemplate"?: string // Template used by Template and Hybrid modes when the question cannot be answered. (任意)
  "totalWordsCount"?: integer (int64) // Accumulated total word count used. (任意)
  "outputMode"?:  // 出力モード：テキスト、表、またはカスタム形式

* `text` - テキスト
* `json_schema` - JSON Schema (任意)
  {
  }
  "rawOutputFormat"?: object // カスタム出力形式の JSON 構造定義です。 (任意)
  "groups"?: [ // チャットボットがアクセスできるグループの一覧です。 (任意)
    {
      "id": string (uuid)
    }
  ]
  "tools"?: [ // チャットボットが使用できるツールの一覧です。 (任意)
    {
      "id": string (uuid)
    }
  ]
  "skills"?: [ // チャットボットに関連付けられたスキルの一覧です。 (任意)
    {
      "id": string (uuid)
    }
  ]
  "connectors"?: [ // Connectors associated with this chatbot, gating per-contact OAuth authorization (任意)
    {
      "id": string (uuid)
    }
  ]
  "agentMode"?:  // エージェントモード：通常、SQL、またはワークフローモード

* `normal` - 通常
* `canvas` - キャンバス
* `team` - チーム (任意)
  {
  }
  "numberOfRetrievedChunks"?: integer // 取得する参照チャンク数です。デフォルトは 12、最小値は 1 です。 (任意)
  "defaultLabelRelations"?: object // アシスタント単位のデフォルトのナレッジベースラベルフィルタです。形式は query_metadata.label_relations と同じで、null はフィルタなしを意味します。呼び出し元が query_metadata を指定しない場合にのみ、優先度が最も低いフォールバックとして適用されます。 (任意)
  "useFullRetrievalRange"?: boolean // 有効にすると、LLM の top_k による切り詰めを無視し、リランカーの結果をすべて返します。 (任意)
  "enableEvaluation"?: boolean // 任意
  "enableInlineCitations"?: boolean // Enables inline citations, inserting citation markers such as [1][2] into responses. (任意)
  "enableCodeInterpreter"?: boolean // When enabled, provides the Code Interpreter tool to run code in an isolated container. (任意)
  "enableBrowserTool"?: boolean // Enable browser automation tool for web tasks (任意)
  "enableImageSearch"?: boolean // Provide the image_search tool when any attached knowledge base uses a multimodal embedding model. Disable to remove the tool entirely. (任意)
  "enableClaudeStreamRetry"?: boolean // When a Claude streaming call stalls (first-chunk or mid-stream), abort and re-issue the call once in non-streaming mode. Mid-stream retries send a reset signal so the client discards any partial output already rendered. Each retry incurs a second billing for the same prompt. (任意)
  "customMaxLlmOutputTokens"?: integer // LLM の最大出力トークン数をカスタマイズします。最小値は 512 です。 (任意)
  "voiceConfig"?: { // 任意
  {
    "enabled"?: boolean // Whether this chatbot can be used as a voice agent. Checked by every conversation platform (WebChat, SIP phone, admin/marketplace voice test) instead of a per-platform toggle. (任意)
    "voiceAgentType"?: string (uuid) // Voice agent mode type. (任意)
    "sttProvider"?: string (uuid) // Speech-to-Text service provider. (任意)
    "sttConfig"?: object // STT configuration parameters (JSON). (任意)
    "ttsProvider"?: string (uuid) // Text-to-Speech service provider. (任意)
    "ttsConfig"?: object // TTS configuration parameters (JSON). (任意)
    "realtimeProvider"?: string (uuid) // Realtime end-to-end voice model provider. (任意)
    "realtimeConfig"?: object // Realtime configuration parameters (JSON). (任意)
    "realtimeInstructions"?: string // Prompt dedicated to the realtime voice session; falls back to chatbot instructions when empty (任意)
    "turnHandling"?: object // Turn-taking and interruption settings for the voice agent. (任意)
    "enableVoiceReply"?: boolean // When disabled, the voice agent replies in text only and does not speak (任意)
  }
  }
  "thinkingConfig"?: object // 推論レベル：null（モデルのデフォルト）または {"reasoning_effort": "off|minimal|low|medium|high|xhigh|max"} (任意)
  "enableToolSearching"?: boolean // 動的ツール検索を有効にし、エージェントが tool_searching_tool を通じてツールを動的に検出して読み込めるようにします。 (任意)
  "maxAgentIterations"?: integer // Maximum number of iterations for AgentWorkflow (1-100, default: 20) (任意)
  "agentTimeoutSeconds"?: integer // Timeout in seconds for AgentWorkflow execution (30-1200, default: 600) (任意)
  "agentTimeoutMessage"?: string // Custom user-facing message shown when AgentWorkflow times out (max 500 chars). Leave empty to use the system default. (任意)
  "requireTextWithFlexCards"?: boolean // When enabled, a turn that would end with only Flex Message cards and no text for the user is re-issued to the LLM once, asking it to write the text first and then send the card. Each retry incurs a second billing for the same prompt. (任意)
  "enableSizeBasedToolResultTruncation"?: boolean // When enabled, tool results exceeding the character threshold are truncated using head+tail strategy instead of the legacy SYSTEM_TOOLS whitelist approach. Reduces memory bloat from large tool outputs (code interpreter bash stdout, web search results, etc.). (任意)
  "toolResultMaxChars"?: integer // Character threshold for size-based tool result truncation (500-50000). Only effective when enable_size_based_tool_result_truncation is True. (任意)
  "enableVectorMemory"?: boolean // When enabled, archived messages are vectorized and processed by fact extraction for semantic retrieval (existing behavior). When disabled, archived messages are discarded and only the active chat history window is used for multi-turn context. (任意)
  "longTermMemoryTopK"?: integer // 長期メモリの検索ごとに取得するメモリノード数です（ベクトル検索の similarity_top_k）。デフォルトは 10、範囲は 1–50 です。 (任意)
  "enableCrossConversationSearch"?: boolean // When enabled, the conversation history tools also reach this contact's other conversations in the same inbox, within the lookback window. When disabled, they only reach the current conversation. (任意)
  "crossConversationLookbackDays"?: integer // How far back cross-conversation search may reach, measured from each conversation's last message (1-365 days). Leave empty to fall back to 90 days. Only effective when enable_cross_conversation_search is True. (任意)
  "useGatewayFallback"?: boolean // When enabled, use the fallback group instead of the single LLM (任意)
  "gatewayFallbackGroup"?: string (uuid) // 任意
  "enableSearchMessagesTool"?: boolean // Allow the AI to search past messages in the current conversation. (任意)
  "enableGetMessageContextTool"?: boolean // Allow the AI to retrieve messages surrounding a specific message for context. (任意)
  "enableReadAttachmentFullTextTool"?: boolean // Allow the AI to read the full text of plain-text attachments. AGENT mode only. (任意)
  "enableParseAttachmentContentTool"?: boolean // Allow the AI to parse PDF, Office, audio, and other attachments. AGENT mode only. (任意)
  "enableListAvailableParsersTool"?: boolean // Allow the AI to list available parsers and their capabilities. AGENT mode only. (任意)
  "enableGetDownloadLinkTool"?: boolean // Allow the AI to generate shareable download links for produced content. AGENT mode only. (任意)
}

リクエスト値の例

{
  "name": "名前の例",
  "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "instructions": "テキスト列の例",
  "knowledgeBases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "databases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "replyMode": {},
  "template": "テキスト列の例",
  "unanswerableTemplate": "テキスト列の例",
  "totalWordsCount": 123,
  "outputMode": {},
  "rawOutputFormat": null,
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "tools": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "skills": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "connectors": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "agentMode": {},
  "numberOfRetrievedChunks": 123,
  "defaultLabelRelations": null,
  "useFullRetrievalRange": true,
  "enableEvaluation": true,
  "enableInlineCitations": true,
  "enableCodeInterpreter": true,
  "enableBrowserTool": true,
  "enableImageSearch": true,
  "enableClaudeStreamRetry": true,
  "customMaxLlmOutputTokens": 123,
  "voiceConfig": {
    "enabled": true,
    "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
    "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
    "sttConfig": null,
    "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
    "ttsConfig": null,
    "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
    "realtimeConfig": null,
    "realtimeInstructions": "テキスト列の例",
    "turnHandling": null,
    "enableVoiceReply": true
  },
  "thinkingConfig": null,
  "enableToolSearching": true,
  "maxAgentIterations": 123,
  "agentTimeoutSeconds": 123,
  "agentTimeoutMessage": "テキスト列の例",
  "requireTextWithFlexCards": true,
  "enableSizeBasedToolResultTruncation": true,
  "toolResultMaxChars": 123,
  "enableVectorMemory": true,
  "longTermMemoryTopK": 123,
  "enableCrossConversationSearch": true,
  "crossConversationLookbackDays": 123,
  "useGatewayFallback": true,
  "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
  "enableSearchMessagesTool": true,
  "enableGetMessageContextTool": true,
  "enableReadAttachmentFullTextTool": true,
  "enableParseAttachmentContentTool": true,
  "enableListAvailableParsersTool": true,
  "enableGetDownloadLinkTool": true
}

コード例

Shell/Bash

# API 呼び出し例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/chatbots/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "名前の例",
    "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
    "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
    "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
    "instructions": "テキスト列の例",
    "knowledgeBases": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "databases": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "organization": "550e8400-e29b-41d4-a716-446655440000",
    "replyMode": {},
    "template": "テキスト列の例",
    "unanswerableTemplate": "テキスト列の例",
    "totalWordsCount": 123,
    "outputMode": {},
    "rawOutputFormat": null,
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "tools": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "skills": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "connectors": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "agentMode": {},
    "numberOfRetrievedChunks": 123,
    "defaultLabelRelations": null,
    "useFullRetrievalRange": true,
    "enableEvaluation": true,
    "enableInlineCitations": true,
    "enableCodeInterpreter": true,
    "enableBrowserTool": true,
    "enableImageSearch": true,
    "enableClaudeStreamRetry": true,
    "customMaxLlmOutputTokens": 123,
    "voiceConfig": {
      "enabled": true,
      "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
      "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
      "sttConfig": null,
      "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
      "ttsConfig": null,
      "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
      "realtimeConfig": null,
      "realtimeInstructions": "テキスト列の例",
      "turnHandling": null,
      "enableVoiceReply": true
    },
    "thinkingConfig": null,
    "enableToolSearching": true,
    "maxAgentIterations": 123,
    "agentTimeoutSeconds": 123,
    "agentTimeoutMessage": "テキスト列の例",
    "requireTextWithFlexCards": true,
    "enableSizeBasedToolResultTruncation": true,
    "toolResultMaxChars": 123,
    "enableVectorMemory": true,
    "longTermMemoryTopK": 123,
    "enableCrossConversationSearch": true,
    "crossConversationLookbackDays": 123,
    "useGatewayFallback": true,
    "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
    "enableSearchMessagesTool": true,
    "enableGetMessageContextTool": true,
    "enableReadAttachmentFullTextTool": true,
    "enableParseAttachmentContentTool": true,
    "enableListAvailableParsersTool": true,
    "enableGetDownloadLinkTool": true
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

const axios = require('axios');

// リクエストヘッダーを設定します
const config = {
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
};

// リクエスト内容 (payload)
const data = {
    "name": "名前の例",
    "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
    "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
    "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
    "instructions": "文字列の例",
    "knowledgeBases": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "databases": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "organization": "550e8400-e29b-41d4-a716-446655440000",
    "replyMode": {},
    "template": "文字列の例",
    "unanswerableTemplate": "文字列の例",
    "totalWordsCount": 123,
    "outputMode": {},
    "rawOutputFormat": null,
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "tools": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "skills": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "connectors": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "agentMode": {},
    "numberOfRetrievedChunks": 123,
    "defaultLabelRelations": null,
    "useFullRetrievalRange": true,
    "enableEvaluation": true,
    "enableInlineCitations": true,
    "enableCodeInterpreter": true,
    "enableBrowserTool": true,
    "enableImageSearch": true,
    "enableClaudeStreamRetry": true,
    "customMaxLlmOutputTokens": 123,
    "voiceConfig": {
      "enabled": true,
      "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
      "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
      "sttConfig": null,
      "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
      "ttsConfig": null,
      "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
      "realtimeConfig": null,
      "realtimeInstructions": "文字列の例",
      "turnHandling": null,
      "enableVoiceReply": true
    },
    "thinkingConfig": null,
    "enableToolSearching": true,
    "maxAgentIterations": 123,
    "agentTimeoutSeconds": 123,
    "agentTimeoutMessage": "文字列の例",
    "requireTextWithFlexCards": true,
    "enableSizeBasedToolResultTruncation": true,
    "toolResultMaxChars": 123,
    "enableVectorMemory": true,
    "longTermMemoryTopK": 123,
    "enableCrossConversationSearch": true,
    "crossConversationLookbackDays": 123,
    "useGatewayFallback": true,
    "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
    "enableSearchMessagesTool": true,
    "enableGetMessageContextTool": true,
    "enableReadAttachmentFullTextTool": true,
    "enableParseAttachmentContentTool": true,
    "enableListAvailableParsersTool": true,
    "enableGetDownloadLinkTool": true
  };

axios.post("https://api.maiagent.ai/api/v1/chatbots/", data, config)
  .then(response => {
    console.log('レスポンスを正常に取得しました:');
    console.log(response.data);
  })
  .catch(error => {
    console.error('リクエストでエラーが発生しました:');
    console.error(error.response?.data || error.message);
  });

Python

import requests

url = "https://api.maiagent.ai/api/v1/chatbots/"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY",
    "Content-Type": "application/json"
}

# リクエスト内容 (payload)
data = {
      "name": "名前の例",
      "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
      "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
      "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
      "instructions": "文字列の例",
      "knowledgeBases": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "databases": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "organization": "550e8400-e29b-41d4-a716-446655440000",
      "replyMode": {},
      "template": "文字列の例",
      "unanswerableTemplate": "文字列の例",
      "totalWordsCount": 123,
      "outputMode": {},
      "rawOutputFormat": null,
      "groups": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "tools": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "skills": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "connectors": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "agentMode": {},
      "numberOfRetrievedChunks": 123,
      "defaultLabelRelations": null,
      "useFullRetrievalRange": true,
      "enableEvaluation": true,
      "enableInlineCitations": true,
      "enableCodeInterpreter": true,
      "enableBrowserTool": true,
      "enableImageSearch": true,
      "enableClaudeStreamRetry": true,
      "customMaxLlmOutputTokens": 123,
      "voiceConfig": {
        "enabled": true,
        "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
        "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
        "sttConfig": null,
        "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
        "ttsConfig": null,
        "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
        "realtimeConfig": null,
        "realtimeInstructions": "文字列の例",
        "turnHandling": null,
        "enableVoiceReply": true
      },
      "thinkingConfig": null,
      "enableToolSearching": true,
      "maxAgentIterations": 123,
      "agentTimeoutSeconds": 123,
      "agentTimeoutMessage": "文字列の例",
      "requireTextWithFlexCards": true,
      "enableSizeBasedToolResultTruncation": true,
      "toolResultMaxChars": 123,
      "enableVectorMemory": true,
      "longTermMemoryTopK": 123,
      "enableCrossConversationSearch": true,
      "crossConversationLookbackDays": 123,
      "useGatewayFallback": true,
      "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
      "enableSearchMessagesTool": true,
      "enableGetMessageContextTool": true,
      "enableReadAttachmentFullTextTool": true,
      "enableParseAttachmentContentTool": true,
      "enableListAvailableParsersTool": true,
      "enableGetDownloadLinkTool": true
    }

response = requests.post(url, json=data, headers=headers)
try:
    print("レスポンスを正常に取得しました:")
    print(response.json())
except Exception as e:
    print("リクエストでエラーが発生しました:", e)

PHP

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

try {
    $response = $client->post("https://api.maiagent.ai/api/v1/chatbots/", [
        'headers' => [
            'Authorization' => 'Api-Key YOUR_API_KEY',
            'Content-Type' => 'application/json'
        ],
        'json' => {
            "name": "名前の例",
            "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
            "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
            "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
            "instructions": "文字列の例",
            "knowledgeBases": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "databases": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "organization": "550e8400-e29b-41d4-a716-446655440000",
            "replyMode": {},
            "template": "文字列の例",
            "unanswerableTemplate": "文字列の例",
            "totalWordsCount": 123,
            "outputMode": {},
            "rawOutputFormat": null,
            "groups": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "tools": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "skills": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "connectors": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "agentMode": {},
            "numberOfRetrievedChunks": 123,
            "defaultLabelRelations": null,
            "useFullRetrievalRange": true,
            "enableEvaluation": true,
            "enableInlineCitations": true,
            "enableCodeInterpreter": true,
            "enableBrowserTool": true,
            "enableImageSearch": true,
            "enableClaudeStreamRetry": true,
            "customMaxLlmOutputTokens": 123,
            "voiceConfig": {
                "enabled": true,
                "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
                "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
                "sttConfig": null,
                "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
                "ttsConfig": null,
                "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
                "realtimeConfig": null,
                "realtimeInstructions": "文字列の例",
                "turnHandling": null,
                "enableVoiceReply": true
            },
            "thinkingConfig": null,
            "enableToolSearching": true,
            "maxAgentIterations": 123,
            "agentTimeoutSeconds": 123,
            "agentTimeoutMessage": "文字列の例",
            "requireTextWithFlexCards": true,
            "enableSizeBasedToolResultTruncation": true,
            "toolResultMaxChars": 123,
            "enableVectorMemory": true,
            "longTermMemoryTopK": 123,
            "enableCrossConversationSearch": true,
            "crossConversationLookbackDays": 123,
            "useGatewayFallback": true,
            "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
            "enableSearchMessagesTool": true,
            "enableGetMessageContextTool": true,
            "enableReadAttachmentFullTextTool": true,
            "enableParseAttachmentContentTool": true,
            "enableListAvailableParsersTool": true,
            "enableGetDownloadLinkTool": true
        }
    ]);
    
    $data = json_decode($response->getBody(), true);
    echo "レスポンスを正常に取得しました:\n";
    print_r($data);
} catch (Exception $e) {
    echo 'リクエストでエラーが発生しました: ' . $e->getMessage();
}
?>

レスポンス内容

ステータスコード: 201

レスポンス構造の例

{
  "id": string (uuid)
  "name": string // Chatbot name. In Agent mode it carries semantic meaning; in other modes it only distinguishes chatbots.
  "largeLanguageModel": string (uuid) // チャットボットが回答の生成に使用する大規模言語モデルです（組織が独自に作成した AI Gateway モデルも含みます）。
  "llm":  // 紐付けられたモデルの id、name、提供終了情報です。FK から直接読み取るため、組織がモデルを無効にしていても返されます。
  {
    "id": string (uuid)
    "name": string
    "retiresAt": string (date) // プロバイダーによる提供終了日です。この日以降、毎日の定期処理でアシスタントを replacement に切り替え、このモデルを無効にします。null は提供終了が予定されていないことを示します。
    "replacement":  // 提供終了後に引き継ぐモデル（id と name）です。null は未指定を示し、提供終了日に自動移行は行われません。
    {
      "id": string (uuid)
      "name": string
    }
  }
  "embeddingModel"?: string (uuid) // テキストのベクトル化に使用する埋め込みモデルです。省略可能です。 (省略可能)
  "rerankerModel"?: string (uuid) // リランキングに使用するモデルです。省略可能です。 (省略可能)
  "instructions"?: string // Role instructions describing the chatbot's role and behavior. (省略可能)
  "knowledgeBases"?: [ // チャットボットがアクセスできるナレッジベースの一覧です。 (省略可能)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "databases"?: [ // チャットボットがアクセスできる SQL データベースの一覧です（Text-to-SQL 機能で使用します）。 (省略可能)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "updatedAt": string (timestamp)
  "organization"?: string (uuid) // チャットボットが所属する組織です。空の場合は個人用チャットボットです。 (省略可能)
  "replyMode"?:  // 返信モードです。通常の返信またはストリーミング返信を指定します。

* `normal` - 通常
* `template` - テンプレート
* `hybrid` - ハイブリッド
* `agent` - エージェント (省略可能)
  {
  }
  "template"?: string // Template used by Template and Hybrid modes. (省略可能)
  "unanswerableTemplate"?: string // Template used by Template and Hybrid modes when the question cannot be answered. (省略可能)
  "totalWordsCount"?: integer (int64) // Accumulated total word count used. (省略可能)
  "outputMode"?:  // 出力モードです。テキスト、表、またはカスタム形式を指定します。

* `text` - テキスト
* `json_schema` - JSON Schema (省略可能)
  {
  }
  "rawOutputFormat"?: object // カスタム出力形式の JSON 構造定義です。 (省略可能)
  "groups"?: [ // チャットボットがアクセスできるグループの一覧です。 (省略可能)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "tools"?: [ // チャットボットが使用できるツールの一覧です。 (省略可能)
    {
      "id": string (uuid)
      "name": string
      "description": string
      "displayName": string
      "toolType": string
    }
  ]
  "skills"?: [ // チャットボットに関連付けられたスキルの一覧です。 (省略可能)
    {
      "id": string (uuid)
      "name": string
      "description": string
    }
  ]
  "connectors"?: [ // Connectors associated with this chatbot, gating per-contact OAuth authorization (省略可能)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "agentMode"?:  // エージェントモードです。通常、SQL、またはワークフローモードを指定します。

* `normal` - 通常
* `canvas` - キャンバス
* `team` - チーム (省略可能)
  {
  }
  "numberOfRetrievedChunks"?: integer // 取得する参照チャンクの数です。デフォルトは 12、最小値は 1 です。 (省略可能)
  "defaultLabelRelations"?: object // アシスタント単位のデフォルトのナレッジベースラベルフィルターです。形式は query_metadata.label_relations と同じで、null はフィルターなしを示します。呼び出し元が query_metadata を指定していない場合にのみ、最も優先度の低いフォールバックとして適用されます。 (省略可能)
  "useFullRetrievalRange"?: boolean // 有効にすると、LLM の top_k による切り詰めを無視し、リランカーの結果をすべて返します。 (省略可能)
  "enableEvaluation"?: boolean // 省略可能
  "enableInlineCitations"?: boolean // Enables inline citations, inserting citation markers such as [1][2] into responses. (省略可能)
  "enableCodeInterpreter"?: boolean // When enabled, provides the Code Interpreter tool to run code in an isolated container. (省略可能)
  "enableBrowserTool"?: boolean // Enable browser automation tool for web tasks (省略可能)
  "enableImageSearch"?: boolean // Provide the image_search tool when any attached knowledge base uses a multimodal embedding model. Disable to remove the tool entirely. (省略可能)
  "enableClaudeStreamRetry"?: boolean // When a Claude streaming call stalls (first-chunk or mid-stream), abort and re-issue the call once in non-streaming mode. Mid-stream retries send a reset signal so the client discards any partial output already rendered. Each retry incurs a second billing for the same prompt. (省略可能)
  "customMaxLlmOutputTokens"?: integer // LLM の最大出力トークン数を指定します。最小値は 512 です。 (省略可能)
  "voiceConfig"?: { // 省略可能
  {
    "enabled"?: boolean // Whether this chatbot can be used as a voice agent. Checked by every conversation platform (WebChat, SIP phone, admin/marketplace voice test) instead of a per-platform toggle. (省略可能)
    "voiceAgentType"?: string (uuid) // Voice agent mode type. (省略可能)
    "sttProvider"?: string (uuid) // Speech-to-Text service provider. (省略可能)
    "sttConfig"?: object // STT configuration parameters (JSON). (省略可能)
    "ttsProvider"?: string (uuid) // Text-to-Speech service provider. (省略可能)
    "ttsConfig"?: object // TTS configuration parameters (JSON). (省略可能)
    "realtimeProvider"?: string (uuid) // Realtime end-to-end voice model provider. (省略可能)
    "realtimeConfig"?: object // Realtime configuration parameters (JSON). (省略可能)
    "realtimeInstructions"?: string // Prompt dedicated to the realtime voice session; falls back to chatbot instructions when empty (省略可能)
    "turnHandling"?: object // Turn-taking and interruption settings for the voice agent. (省略可能)
    "enableVoiceReply"?: boolean // When disabled, the voice agent replies in text only and does not speak (省略可能)
  }
  }
  "thinkingConfig"?: object // 推論レベルです。null（モデルのデフォルト）または {"reasoning_effort": "off|minimal|low|medium|high|xhigh|max"} (省略可能)
  "enableToolSearching"?: boolean // 動的ツール検索を有効にし、エージェントが tool_searching_tool を通じてツールを動的に検出して読み込めるようにします。 (省略可能)
  "maxAgentIterations"?: integer // Maximum number of iterations for AgentWorkflow (1-100, default: 20) (省略可能)
  "agentTimeoutSeconds"?: integer // Timeout in seconds for AgentWorkflow execution (30-1200, default: 600) (省略可能)
  "agentTimeoutMessage"?: string // Custom user-facing message shown when AgentWorkflow times out (max 500 chars). Leave empty to use the system default. (省略可能)
  "requireTextWithFlexCards"?: boolean // When enabled, a turn that would end with only Flex Message cards and no text for the user is re-issued to the LLM once, asking it to write the text first and then send the card. Each retry incurs a second billing for the same prompt. (省略可能)
  "isMultimodalLlm": boolean // Whether the chatbot LLM supports multimodal (read-only)
  "enableSizeBasedToolResultTruncation"?: boolean // When enabled, tool results exceeding the character threshold are truncated using head+tail strategy instead of the legacy SYSTEM_TOOLS whitelist approach. Reduces memory bloat from large tool outputs (code interpreter bash stdout, web search results, etc.). (省略可能)
  "toolResultMaxChars"?: integer // Character threshold for size-based tool result truncation (500-50000). Only effective when enable_size_based_tool_result_truncation is True. (省略可能)
  "enableVectorMemory"?: boolean // When enabled, archived messages are vectorized and processed by fact extraction for semantic retrieval (existing behavior). When disabled, archived messages are discarded and only the active chat history window is used for multi-turn context. (省略可能)
  "longTermMemoryTopK"?: integer // 長期メモリの検索ごとに取得するメモリノード数です（ベクトル検索の similarity_top_k）。デフォルトは 10、範囲は 1–50 です。 (省略可能)
  "enableCrossConversationSearch"?: boolean // When enabled, the conversation history tools also reach this contact's other conversations in the same inbox, within the lookback window. When disabled, they only reach the current conversation. (省略可能)
  "crossConversationLookbackDays"?: integer // How far back cross-conversation search may reach, measured from each conversation's last message (1-365 days). Leave empty to fall back to 90 days. Only effective when enable_cross_conversation_search is True. (省略可能)
  "useGatewayFallback"?: boolean // When enabled, use the fallback group instead of the single LLM (省略可能)
  "gatewayFallbackGroup"?: string (uuid) // 省略可能
  "enableSearchMessagesTool"?: boolean // Allow the AI to search past messages in the current conversation. (省略可能)
  "enableGetMessageContextTool"?: boolean // Allow the AI to retrieve messages surrounding a specific message for context. (省略可能)
  "enableReadAttachmentFullTextTool"?: boolean // Allow the AI to read the full text of plain-text attachments. AGENT mode only. (省略可能)
  "enableParseAttachmentContentTool"?: boolean // Allow the AI to parse PDF, Office, audio, and other attachments. AGENT mode only. (省略可能)
  "enableListAvailableParsersTool"?: boolean // Allow the AI to list available parsers and their capabilities. AGENT mode only. (省略可能)
  "enableGetDownloadLinkTool"?: boolean // Allow the AI to generate shareable download links for produced content. AGENT mode only. (省略可能)
  "isLocked": boolean // Locked instance: config follows the official version; only the dedicated KB can be modified
  "sourceBuildInAgent": string (uuid) // Points to the official Build-in Agent blueprint when instantiated by a rental
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
}

レスポンス値の例

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列",
  "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
  "llm": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列",
    "retiresAt": "レスポンス文字列",
    "replacement": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  },
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "instructions": "レスポンス文字列",
  "knowledgeBases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "databases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "updatedAt": "レスポンス文字列",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "replyMode": {},
  "template": "レスポンス文字列",
  "unanswerableTemplate": "レスポンス文字列",
  "totalWordsCount": 456,
  "outputMode": {},
  "rawOutputFormat": null,
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "tools": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列",
      "description": "レスポンス文字列",
      "displayName": "レスポンス文字列",
      "toolType": "レスポンス文字列"
    }
  ],
  "skills": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列",
      "description": "レスポンス文字列"
    }
  ],
  "connectors": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "agentMode": {},
  "numberOfRetrievedChunks": 456,
  "defaultLabelRelations": null,
  "useFullRetrievalRange": false,
  "enableEvaluation": false,
  "enableInlineCitations": false,
  "enableCodeInterpreter": false,
  "enableBrowserTool": false,
  "enableImageSearch": false,
  "enableClaudeStreamRetry": false,
  "customMaxLlmOutputTokens": 456,
  "voiceConfig": {
    "enabled": false,
    "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
    "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
    "sttConfig": null,
    "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
    "ttsConfig": null,
    "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
    "realtimeConfig": null,
    "realtimeInstructions": "レスポンス文字列",
    "turnHandling": null,
    "enableVoiceReply": false
  },
  "thinkingConfig": null,
  "enableToolSearching": false,
  "maxAgentIterations": 456,
  "agentTimeoutSeconds": 456,
  "agentTimeoutMessage": "レスポンス文字列",
  "requireTextWithFlexCards": false,
  "isMultimodalLlm": false,
  "enableSizeBasedToolResultTruncation": false,
  "toolResultMaxChars": 456,
  "enableVectorMemory": false,
  "longTermMemoryTopK": 456,
  "enableCrossConversationSearch": false,
  "crossConversationLookbackDays": 456,
  "useGatewayFallback": false,
  "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
  "enableSearchMessagesTool": false,
  "enableGetMessageContextTool": false,
  "enableReadAttachmentFullTextTool": false,
  "enableParseAttachmentContentTool": false,
  "enableListAvailableParsersTool": false,
  "enableGetDownloadLinkTool": false,
  "isLocked": false,
  "sourceBuildInAgent": "550e8400-e29b-41d4-a716-446655440000",
  "canUpdate": false,
  "canDelete": false
}

---

Embedding Model の一覧取得

GET /api/v1/embedding-models/

コード例

Shell/Bash

# API 呼び出し例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/embedding-models/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

const axios = require('axios');

// リクエストヘッダーを設定します
const config = {
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY'
  }
};

axios.get("https://api.maiagent.ai/api/v1/embedding-models/", config)
  .then(response => {
    console.log('レスポンスを通常に取得しました:');
    console.log(response.data);
  })
  .catch(error => {
    console.error('リクエストエラーが発生しました:');
    console.error(error.response?.data || error.message);
  });

Python

import requests

url = "https://api.maiagent.ai/api/v1/embedding-models/"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY"
}


response = requests.get(url, headers=headers)
try:
    print("レスポンスを通常に取得しました:")
    print(response.json())
except Exception as e:
    print("リクエストエラーが発生しました:", e)

PHP

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

try {
    $response = $client->get("https://api.maiagent.ai/api/v1/embedding-models/", [
        'headers' => [
            'Authorization' => 'Api-Key YOUR_API_KEY'
        ]
    ]);
    
    $data = json_decode($response->getBody(), true);
    echo "レスポンスを通常に取得しました:\n";
    print_r($data);
} catch (Exception $e) {
    echo 'リクエストエラーが発生しました: ' . $e->getMessage();
}
?>

レスポンス内容

ステータスコード: 200

レスポンス構造の例

[
  {
    "id": string (uuid)
    "name": string
    "isDefault"?: boolean // 任意
    "isMultimodal"?: boolean // Whether this embedding model supports multimodal (text + image) embeddings (任意)
    "icon": 
    {
      "id": string (uuid)
      "name": string
      "image": string (uri)
    }
  }
]

レスポンス値の例

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列",
    "isDefault": false,
    "isMultimodal": false,
    "icon": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列",
      "image": "https://example.com/file.jpg"
    }
  }
]

---

Reranker Model の一覧を取得します

GET /api/v1/reranker-models/

コード例

Shell/Bash

# API 呼び出し例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/reranker-models/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

const axios = require('axios');

// リクエストヘッダーを設定します
const config = {
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY'
  }
};

axios.get("https://api.maiagent.ai/api/v1/reranker-models/", config)
  .then(response => {
    console.log('レスポンスを通常に取得しました:');
    console.log(response.data);
  })
  .catch(error => {
    console.error('リクエストエラーが発生しました:');
    console.error(error.response?.data || error.message);
  });

Python

import requests

url = "https://api.maiagent.ai/api/v1/reranker-models/"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY"
}


response = requests.get(url, headers=headers)
try:
    print("レスポンスを通常に取得しました:")
    print(response.json())
except Exception as e:
    print("リクエストエラーが発生しました:", e)

PHP

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

try {
    $response = $client->get("https://api.maiagent.ai/api/v1/reranker-models/", [
        'headers' => [
            'Authorization' => 'Api-Key YOUR_API_KEY'
        ]
    ]);
    
    $data = json_decode($response->getBody(), true);
    echo "レスポンスを通常に取得しました:\n";
    print_r($data);
} catch (Exception $e) {
    echo 'リクエストエラーが発生しました: ' . $e->getMessage();
}
?>

レスポンス内容

ステータスコード: 200

レスポンス構造の例

[
  {
    "id": string (uuid)
    "name": string
    "isDefault"?: boolean // 任意
    "icon": 
    {
      "id": string (uuid)
      "name": string
      "image": string (uri)
    }
  }
]

レスポンス値の例

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列",
    "isDefault": false,
    "icon": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列",
      "image": "https://example.com/file.jpg"
    }
  }
]

---

大規模言語モデルの一覧を取得します

GET /api/v1/large-language-models/

コード例

Shell/Bash

# API 呼び出し例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/large-language-models/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

const axios = require('axios');

// リクエストヘッダーを設定します
const config = {
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY'
  }
};

axios.get("https://api.maiagent.ai/api/v1/large-language-models/", config)
  .then(response => {
    console.log('レスポンスを通常に取得しました:');
    console.log(response.data);
  })
  .catch(error => {
    console.error('リクエストエラーが発生しました:');
    console.error(error.response?.data || error.message);
  });

Python

import requests

url = "https://api.maiagent.ai/api/v1/large-language-models/"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY"
}


response = requests.get(url, headers=headers)
try:
    print("レスポンスを通常に取得しました:")
    print(response.json())
except Exception as e:
    print("リクエストエラーが発生しました:", e)

PHP

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

try {
    $response = $client->get("https://api.maiagent.ai/api/v1/large-language-models/", [
        'headers' => [
            'Authorization' => 'Api-Key YOUR_API_KEY'
        ]
    ]);
    
    $data = json_decode($response->getBody(), true);
    echo "レスポンスを通常に取得しました:\n";
    print_r($data);
} catch (Exception $e) {
    echo 'リクエストエラーが発生しました: ' . $e->getMessage();
}
?>

レスポンス内容

ステータスコード: 200

レスポンス構造の例

[
  {
    "id": string (uuid)
    "name": string
    "retiresAt": string (date) // プロバイダーによる提供終了日です。この日を過ぎると、毎日の定期処理でアシスタントを replacement に切り替え、このモデルを無効にします。null は提供終了が予定されていないことを示します。
    "replacement":  // 提供終了後に引き継ぐモデル（id と name）です。null は未指定を示し、提供終了時に自動移行しません。
    {
      "id": string (uuid)
      "name": string
    }
    "contextWindow"?: integer // Used only by OpenAILike or Ollama models; other models ignore this value. (任意)
    "isDefault"?: boolean // 任意
    "provider": string
    "servedBy": string // Who runs inference, which is where prompts are sent (for example OpenRouter, AWS Bedrock); models on a customer credential show Customer credential.
    "icon": 
    {
      "id": string (uuid)
      "name": string
      "image": string (uri)
    }
    "isMultiModalSupport"?: boolean // 任意
    "isFunctionalCallingAvailable": boolean // Deprecated: same value as isToolCallingAvailable; use isToolCallingAvailable.
    "isToolCallingAvailable"?: boolean // 任意
    "isTemplateAvailable": boolean
    "isOutputFormatAvailable": boolean
    "isThinkingAvailable"?: boolean // When checked, this model shows the thinking depth setting and requests carry thinking parameters (thinking_budget for Gemini, reasoning_effort for OpenAI-compatible hosts). Unchecking stops sending them; saved thinking settings are kept but have no effect. Check only for models known to support thinking parameters, otherwise the provider returns 4xx. (任意)
    "defaultThinkingLevel"?: // 異なる型を取る場合があります (任意)
    string (enum: off, minimal, low, medium, high, xhigh, max) // The thinking level sent when neither the conversation nor the assistant sets one. Empty sends no thinking parameter, so the provider default applies. A level the model does not accept is lowered to the nearest one it does. Takes effect only when Supports Thinking is checked.

* `off` - off
* `minimal` - minimal
* `low` - low
* `medium` - medium
* `high` - high
* `xhigh` - xhigh
* `max` - max (任意)
    "thinkingConfigSchema": object
    "replyMode": [
      string
    ]
    "outputMode": [
      string
    ]
    "agentMode": [
      string
    ]
    "maxTokens"?: integer // 任意
    "minTokens": integer
    "isCustomModel": boolean // Whether the row is organization-owned (materialized from an AI Gateway custom model).
    "originCountry": string // ISO 3166-1 alpha-2 code of the country the model developer is based in (e.g. US, CN, FR); null when unknown. Follows the model, not who runs inference.
    "originRegion": // 異なる型を取る場合があります
    string (enum: cn, us, other) // Origin group for labels and filters: cn / us / other; null when unknown (no label).

* `cn` - China
* `us` - United States
* `other` - Other countries
    "originRegionDisplay": string // Translated origin group name (e.g. 中国／米国／その他の国); null when unknown.
  }
]

レスポンス値の例

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列",
    "retiresAt": "レスポンス文字列",
    "replacement": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    },
    "contextWindow": 456,
    "isDefault": false,
    "provider": "レスポンス文字列",
    "servedBy": "レスポンス文字列",
    "icon": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列",
      "image": "https://example.com/file.jpg"
    },
    "isMultiModalSupport": false,
    "isFunctionalCallingAvailable": false,
    "isToolCallingAvailable": false,
    "isTemplateAvailable": false,
    "isOutputFormatAvailable": false,
    "isThinkingAvailable": false,
    "defaultThinkingLevel": "off",
    "thinkingConfigSchema": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス名の例",
      "description": "レスポンス説明の例"
    },
    "replyMode": [
      "レスポンス文字列"
    ],
    "outputMode": [
      "レスポンス文字列"
    ],
    "agentMode": [
      "レスポンス文字列"
    ],
    "maxTokens": 456,
    "minTokens": 456,
    "isCustomModel": false,
    "originCountry": "レスポンス文字列",
    "originRegion": "cn",
    "originRegionDisplay": "レスポンス文字列"
  }
]

---

AI アシスタントの一覧を取得します

GET /api/v1/chatbots/

パラメーター

パラメーター名	必須	型	説明
largeLanguageModel	❌	string
page	❌	integer	A page number within the paginated result set.
pageSize	❌	integer	Number of results to return per page.
pagination	❌	string	ページ分割するかどうかを指定します (true/false)
query	❌	string
replyMode	❌	string
source	❌	string	`self_built`: self_built ; `built_in`: built_in ; `all`: all;

コード例

Shell/Bash

# API 呼び出し例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/chatbots/?largeLanguageModel=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&pagination=example&query=example&replyMode=example&source=all" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

const axios = require('axios');

// リクエストヘッダーを設定します
const config = {
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY'
  }
};

axios.get("https://api.maiagent.ai/api/v1/chatbots/?largeLanguageModel=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&pagination=example&query=example&replyMode=example&source=all", config)
  .then(response => {
    console.log('レスポンスを通常に取得しました:');
    console.log(response.data);
  })
  .catch(error => {
    console.error('リクエストエラーが発生しました:');
    console.error(error.response?.data || error.message);
  });

Python

import requests

url = "https://api.maiagent.ai/api/v1/chatbots/?largeLanguageModel=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&pagination=example&query=example&replyMode=example&source=all"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY"
}


response = requests.get(url, headers=headers)
try:
    print("レスポンスを通常に取得しました:")
    print(response.json())
except Exception as e:
    print("リクエストエラーが発生しました:", e)

PHP

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

try {
    $response = $client->get("https://api.maiagent.ai/api/v1/chatbots/?largeLanguageModel=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&pagination=example&query=example&replyMode=example&source=all", [
        'headers' => [
            'Authorization' => 'Api-Key YOUR_API_KEY'
        ]
    ]);
    
    $data = json_decode($response->getBody(), true);
    echo "レスポンスを通常に取得しました:\n";
    print_r($data);
} catch (Exception $e) {
    echo 'リクエストエラーが発生しました: ' . $e->getMessage();
}
?>

レスポンス内容

ステータスコード: 200

レスポンス構造の例

{
  "count": integer
  "next"?: string (uri) // 任意
  "previous"?: string (uri) // 任意
  "results": [
    {
      "id": string (uuid)
      "name": string // Chatbot name. In Agent mode it carries semantic meaning; in other modes it only distinguishes chatbots.
      "groups": [
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "largeLanguageModel": { // LLM の基本シリアライザーです。識別フィールドと提供終了情報を含み、モデルの提供終了が近づいた際にフロントエンドで通知するために使用します。
      {
        "id": string (uuid)
        "name": string
        "retiresAt": string (date) // プロバイダーによる提供終了日です。この日を過ぎると、毎日の定期処理でアシスタントを replacement に切り替え、このモデルを無効にします。null は提供終了が予定されていないことを示します。
        "replacement":  // 提供終了後に引き継ぐモデル（id と name）です。null は未指定を示し、提供終了時に自動移行しません。
        {
          "id": string (uuid)
          "name": string
        }
      }
      }
      "embeddingModel": {
      {
        "id": string (uuid)
        "name": string
        "isDefault"?: boolean // 任意
        "isMultimodal"?: boolean // Whether this embedding model supports multimodal (text + image) embeddings (任意)
        "icon": 
        {
          "id": string (uuid)
          "name": string
          "image": string (uri)
        }
      }
      }
      "rerankerModel": {
      {
        "id": string (uuid)
        "name": string
        "isDefault"?: boolean // 任意
        "icon": 
        {
          "id": string (uuid)
          "name": string
          "image": string (uri)
        }
      }
      }
      "knowledgeBases": [
        {
          "id": string (uuid)
          "name": string
        }
      ]
      "tools": [
        {
          "id": string (uuid)
          "name": string
          "description": string
          "displayName": string
          "toolType": string
        }
      ]
      "skills": [
        {
          "id": string (uuid)
          "name": string
          "description": string
        }
      ]
      "agentMode"?:  // Agent mode: Canvas or Normal. Canvas mode generates answers on a canvas; Normal mode generates regular answers.

* `normal` - 通常
* `canvas` - キャンバス
* `team` - チーム (任意)
      {
      }
      "replyMode"?:  // Reply mode: Normal, Template, Hybrid, or Agent.

* `normal` - 通常
* `template` - テンプレート
* `hybrid` - ハイブリッド
* `agent` - エージェント (任意)
      {
      }
      "updatedAt": string (timestamp)
      "enableEvaluation"?: boolean // 任意
      "enableInlineCitations"?: boolean // Enables inline citations, inserting citation markers such as [1][2] into responses. (任意)
      "enableToolSearching"?: boolean // Enables dynamic tool search, letting the agent discover and load tools via tool_searching_tool. (任意)
      "enableCodeInterpreter"?: boolean // When enabled, provides the Code Interpreter tool to run code in an isolated container. (任意)
      "enableBrowserTool"?: boolean // Enable browser automation tool for web tasks (任意)
      "enableImageSearch"?: boolean // Provide the image_search tool when any attached knowledge base uses a multimodal embedding model. Disable to remove the tool entirely. (任意)
      "numberOfRetrievedChunks"?: integer // 任意
      "useFullRetrievalRange"?: boolean // When enabled, the retrieval tool ignores the top_k set by the LLM and returns the full reranker result up to the maximum number of retrieved chunks. Useful for knowledge bases with long tables that need a wider retrieval range. (任意)
      "isMultimodalLlm": boolean // Return whether the chatbot's LLM supports multimodal.
      "voiceConfig": 
      {
        "enabled"?: boolean // Whether this chatbot can be used as a voice agent. Checked by every conversation platform (WebChat, SIP phone, admin/marketplace voice test) instead of a per-platform toggle. (任意)
      }
      "createdBy": 
      {
        "id": string (uuid)
        "name": string
      }
      "isLocked"?: boolean // Locked instance: config follows the official version; only the dedicated KB can be modified (任意)
      "sourceBuildInAgent"?: string (uuid) // Points to the official Build-in Agent blueprint when instantiated by a rental (任意)
      "canUpdate": boolean // Return whether the current user can update this resource.
      "canDelete": boolean // Return whether the current user can delete this resource.
    }
  ]
}

レスポンス値の例

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列",
      "groups": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列"
        }
      ],
      "largeLanguageModel": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列",
        "retiresAt": "レスポンス文字列",
        "replacement": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列"
        }
      },
      "embeddingModel": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列",
        "isDefault": false,
        "isMultimodal": false,
        "icon": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列",
          "image": "https://example.com/file.jpg"
        }
      },
      "rerankerModel": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列",
        "isDefault": false,
        "icon": {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列",
          "image": "https://example.com/file.jpg"
        }
      },
      "knowledgeBases": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列"
        }
      ],
      "tools": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列",
          "description": "レスポンス文字列",
          "displayName": "レスポンス文字列",
          "toolType": "レスポンス文字列"
        }
      ],
      "skills": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "レスポンス文字列",
          "description": "レスポンス文字列"
        }
      ],
      "agentMode": {},
      "replyMode": {},
      "updatedAt": "レスポンス文字列",
      "enableEvaluation": false,
      "enableInlineCitations": false,
      "enableToolSearching": false,
      "enableCodeInterpreter": false,
      "enableBrowserTool": false,
      "enableImageSearch": false,
      "numberOfRetrievedChunks": 456,
      "useFullRetrievalRange": false,
      "isMultimodalLlm": false,
      "voiceConfig": {
        "enabled": false
      },
      "createdBy": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "レスポンス文字列"
      },
      "isLocked": false,
      "sourceBuildInAgent": "550e8400-e29b-41d4-a716-446655440000",
      "canUpdate": false,
      "canDelete": false
    }
  ]
}

---

特定の AI アシスタントを取得します

GET /api/v1/chatbots/{id}/

パラメーター

パラメーター名	必須	型	説明
id	✅	string

コード例

Shell/Bash

# API 呼び出し例 (Shell)
curl -X GET "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

const axios = require('axios');

// リクエストヘッダーを設定します
const config = {
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY'
  }
};

axios.get("https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/", config)
  .then(response => {
    console.log('レスポンスを通常に取得しました:');
    console.log(response.data);
  })
  .catch(error => {
    console.error('リクエストでエラーが発生しました:');
    console.error(error.response?.data || error.message);
  });

Python

import requests

url = "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY"
}


response = requests.get(url, headers=headers)
try:
    print("レスポンスを通常に取得しました:")
    print(response.json())
except Exception as e:
    print("リクエストでエラーが発生しました:", e)

PHP

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

try {
    $response = $client->get("https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/", [
        'headers' => [
            'Authorization' => 'Api-Key YOUR_API_KEY'
        ]
    ]);
    
    $data = json_decode($response->getBody(), true);
    echo "レスポンスを通常に取得しました:\n";
    print_r($data);
} catch (Exception $e) {
    echo 'リクエストでエラーが発生しました: ' . $e->getMessage();
}
?>

レスポンス内容

ステータスコード: 200

レスポンス構造の例

{
  "id": string (uuid)
  "name": string // Chatbot name. In Agent mode it carries semantic meaning; in other modes it only distinguishes chatbots.
  "largeLanguageModel": string (uuid) // チャットボットが回答生成に使用する大規模言語モデルです（組織が独自に作成した AI Gateway モデルを含みます）
  "llm":  // 紐づけられたモデルの id、name、提供終了情報です。FK を直接参照するため、組織がモデルを無効化していても返されます
  {
    "id": string (uuid)
    "name": string
    "retiresAt": string (date) // プロバイダーによる提供終了日です。この日を過ぎると、毎日のスケジュール処理がアシスタントを replacement に切り替え、このモデルを無効化します。null は提供終了が予定されていないことを示します
    "replacement":  // 提供終了後の後継モデルです（id と name）。null は未指定を示し、提供終了時に自動移行されません
    {
      "id": string (uuid)
      "name": string
    }
  }
  "embeddingModel"?: string (uuid) // テキストのベクトル化に使用する埋め込みモデルです。任意項目です (任意)
  "rerankerModel"?: string (uuid) // 再ランキングに使用するモデルです。任意項目です (任意)
  "instructions"?: string // Role instructions describing the chatbot's role and behavior. (任意)
  "knowledgeBases"?: [ // チャットボットがアクセスできるナレッジベースの一覧です (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "databases"?: [ // チャットボットがアクセスできる SQL データベースの一覧です（Text-to-SQL 機能用） (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "updatedAt": string (timestamp)
  "organization"?: string (uuid) // チャットボットが所属する組織です。空の場合は個人用チャットボットです (任意)
  "replyMode"?:  // 応答モード：通常の応答またはストリーミング応答です

* `normal` - 通常
* `template` - テンプレート
* `hybrid` - ハイブリッド
* `agent` - エージェント (任意)
  {
  }
  "template"?: string // Template used by Template and Hybrid modes. (任意)
  "unanswerableTemplate"?: string // Template used by Template and Hybrid modes when the question cannot be answered. (任意)
  "totalWordsCount"?: integer (int64) // Accumulated total word count used. (任意)
  "outputMode"?:  // 出力モード：テキスト、表、またはカスタム形式です

* `text` - テキスト
* `json_schema` - JSON Schema (任意)
  {
  }
  "rawOutputFormat"?: object // カスタム出力形式の JSON 構造定義です (任意)
  "groups"?: [ // チャットボットがアクセスできるグループの一覧です (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "tools"?: [ // チャットボットが使用できるツールの一覧です (任意)
    {
      "id": string (uuid)
      "name": string
      "description": string
      "displayName": string
      "toolType": string
    }
  ]
  "skills"?: [ // チャットボットに関連付けられたスキルの一覧です (任意)
    {
      "id": string (uuid)
      "name": string
      "description": string
    }
  ]
  "connectors"?: [ // Connectors associated with this chatbot, gating per-contact OAuth authorization (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "agentMode"?:  // エージェントモード：通常、SQL、またはワークフローモードです

* `normal` - 通常
* `canvas` - キャンバス
* `team` - チーム (任意)
  {
  }
  "numberOfRetrievedChunks"?: integer // 取得する参照チャンク数です。デフォルトは 12、最小値は 1 です (任意)
  "defaultLabelRelations"?: object // アシスタント単位のデフォルトのナレッジベースラベルフィルター条件です。形式は query_metadata.label_relations と同じです。null はフィルターなしを示します。呼び出し元が query_metadata を指定しない場合にのみ、最も優先度の低いフォールバックとして適用されます。 (任意)
  "useFullRetrievalRange"?: boolean // 有効にすると LLM の top_k による切り詰めを無視し、reranker の結果をすべて返します (任意)
  "enableEvaluation"?: boolean // 任意
  "enableInlineCitations"?: boolean // Enables inline citations, inserting citation markers such as [1][2] into responses. (任意)
  "enableCodeInterpreter"?: boolean // When enabled, provides the Code Interpreter tool to run code in an isolated container. (任意)
  "enableBrowserTool"?: boolean // Enable browser automation tool for web tasks (任意)
  "enableImageSearch"?: boolean // Provide the image_search tool when any attached knowledge base uses a multimodal embedding model. Disable to remove the tool entirely. (任意)
  "enableClaudeStreamRetry"?: boolean // When a Claude streaming call stalls (first-chunk or mid-stream), abort and re-issue the call once in non-streaming mode. Mid-stream retries send a reset signal so the client discards any partial output already rendered. Each retry incurs a second billing for the same prompt. (任意)
  "customMaxLlmOutputTokens"?: integer // LLM の最大出力トークン数を指定します。最小値は 512 です (任意)
  "voiceConfig"?: { // 任意
  {
    "enabled"?: boolean // Whether this chatbot can be used as a voice agent. Checked by every conversation platform (WebChat, SIP phone, admin/marketplace voice test) instead of a per-platform toggle. (任意)
    "voiceAgentType"?: string (uuid) // Voice agent mode type. (任意)
    "sttProvider"?: string (uuid) // Speech-to-Text service provider. (任意)
    "sttConfig"?: object // STT configuration parameters (JSON). (任意)
    "ttsProvider"?: string (uuid) // Text-to-Speech service provider. (任意)
    "ttsConfig"?: object // TTS configuration parameters (JSON). (任意)
    "realtimeProvider"?: string (uuid) // Realtime end-to-end voice model provider. (任意)
    "realtimeConfig"?: object // Realtime configuration parameters (JSON). (任意)
    "realtimeInstructions"?: string // Prompt dedicated to the realtime voice session; falls back to chatbot instructions when empty (任意)
    "turnHandling"?: object // Turn-taking and interruption settings for the voice agent. (任意)
    "enableVoiceReply"?: boolean // When disabled, the voice agent replies in text only and does not speak (任意)
  }
  }
  "thinkingConfig"?: object // 思考レベル：null（モデルのデフォルト）または {"reasoning_effort": "off|minimal|low|medium|high|xhigh|max"} (任意)
  "enableToolSearching"?: boolean // 動的ツール検索を有効にし、エージェントが tool_searching_tool を通じてツールを動的に検出して読み込めるようにします (任意)
  "maxAgentIterations"?: integer // Maximum number of iterations for AgentWorkflow (1-100, default: 20) (任意)
  "agentTimeoutSeconds"?: integer // Timeout in seconds for AgentWorkflow execution (30-1200, default: 600) (任意)
  "agentTimeoutMessage"?: string // Custom user-facing message shown when AgentWorkflow times out (max 500 chars). Leave empty to use the system default. (任意)
  "requireTextWithFlexCards"?: boolean // When enabled, a turn that would end with only Flex Message cards and no text for the user is re-issued to the LLM once, asking it to write the text first and then send the card. Each retry incurs a second billing for the same prompt. (任意)
  "isMultimodalLlm": boolean // Whether the chatbot LLM supports multimodal (read-only)
  "enableSizeBasedToolResultTruncation"?: boolean // When enabled, tool results exceeding the character threshold are truncated using head+tail strategy instead of the legacy SYSTEM_TOOLS whitelist approach. Reduces memory bloat from large tool outputs (code interpreter bash stdout, web search results, etc.). (任意)
  "toolResultMaxChars"?: integer // Character threshold for size-based tool result truncation (500-50000). Only effective when enable_size_based_tool_result_truncation is True. (任意)
  "enableVectorMemory"?: boolean // When enabled, archived messages are vectorized and processed by fact extraction for semantic retrieval (existing behavior). When disabled, archived messages are discarded and only the active chat history window is used for multi-turn context. (任意)
  "longTermMemoryTopK"?: integer // 長期記憶の検索ごとに取得する記憶ノード数です（ベクトル検索の similarity_top_k）。デフォルトは 10、範囲は 1–50 です (任意)
  "enableCrossConversationSearch"?: boolean // When enabled, the conversation history tools also reach this contact's other conversations in the same inbox, within the lookback window. When disabled, they only reach the current conversation. (任意)
  "crossConversationLookbackDays"?: integer // How far back cross-conversation search may reach, measured from each conversation's last message (1-365 days). Leave empty to fall back to 90 days. Only effective when enable_cross_conversation_search is True. (任意)
  "useGatewayFallback"?: boolean // When enabled, use the fallback group instead of the single LLM (任意)
  "gatewayFallbackGroup"?: string (uuid) // 任意
  "enableSearchMessagesTool"?: boolean // Allow the AI to search past messages in the current conversation. (任意)
  "enableGetMessageContextTool"?: boolean // Allow the AI to retrieve messages surrounding a specific message for context. (任意)
  "enableReadAttachmentFullTextTool"?: boolean // Allow the AI to read the full text of plain-text attachments. AGENT mode only. (任意)
  "enableParseAttachmentContentTool"?: boolean // Allow the AI to parse PDF, Office, audio, and other attachments. AGENT mode only. (任意)
  "enableListAvailableParsersTool"?: boolean // Allow the AI to list available parsers and their capabilities. AGENT mode only. (任意)
  "enableGetDownloadLinkTool"?: boolean // Allow the AI to generate shareable download links for produced content. AGENT mode only. (任意)
  "isLocked": boolean // Locked instance: config follows the official version; only the dedicated KB can be modified
  "sourceBuildInAgent": string (uuid) // Points to the official Build-in Agent blueprint when instantiated by a rental
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
}

レスポンス値の例

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンステキスト列",
  "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
  "llm": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンステキスト列",
    "retiresAt": "レスポンステキスト列",
    "replacement": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンステキスト列"
    }
  },
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "instructions": "レスポンステキスト列",
  "knowledgeBases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンステキスト列"
    }
  ],
  "databases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンステキスト列"
    }
  ],
  "updatedAt": "レスポンステキスト列",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "replyMode": {},
  "template": "レスポンステキスト列",
  "unanswerableTemplate": "レスポンステキスト列",
  "totalWordsCount": 456,
  "outputMode": {},
  "rawOutputFormat": null,
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンステキスト列"
    }
  ],
  "tools": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンステキスト列",
      "description": "レスポンステキスト列",
      "displayName": "レスポンステキスト列",
      "toolType": "レスポンステキスト列"
    }
  ],
  "skills": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンステキスト列",
      "description": "レスポンステキスト列"
    }
  ],
  "connectors": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンステキスト列"
    }
  ],
  "agentMode": {},
  "numberOfRetrievedChunks": 456,
  "defaultLabelRelations": null,
  "useFullRetrievalRange": false,
  "enableEvaluation": false,
  "enableInlineCitations": false,
  "enableCodeInterpreter": false,
  "enableBrowserTool": false,
  "enableImageSearch": false,
  "enableClaudeStreamRetry": false,
  "customMaxLlmOutputTokens": 456,
  "voiceConfig": {
    "enabled": false,
    "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
    "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
    "sttConfig": null,
    "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
    "ttsConfig": null,
    "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
    "realtimeConfig": null,
    "realtimeInstructions": "レスポンステキスト列",
    "turnHandling": null,
    "enableVoiceReply": false
  },
  "thinkingConfig": null,
  "enableToolSearching": false,
  "maxAgentIterations": 456,
  "agentTimeoutSeconds": 456,
  "agentTimeoutMessage": "レスポンステキスト列",
  "requireTextWithFlexCards": false,
  "isMultimodalLlm": false,
  "enableSizeBasedToolResultTruncation": false,
  "toolResultMaxChars": 456,
  "enableVectorMemory": false,
  "longTermMemoryTopK": 456,
  "enableCrossConversationSearch": false,
  "crossConversationLookbackDays": 456,
  "useGatewayFallback": false,
  "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
  "enableSearchMessagesTool": false,
  "enableGetMessageContextTool": false,
  "enableReadAttachmentFullTextTool": false,
  "enableParseAttachmentContentTool": false,
  "enableListAvailableParsersTool": false,
  "enableGetDownloadLinkTool": false,
  "isLocked": false,
  "sourceBuildInAgent": "550e8400-e29b-41d4-a716-446655440000",
  "canUpdate": false,
  "canDelete": false
}

---

AI アシスタントの更新

PUT /api/v1/chatbots/{id}/

パラメータ

パラメータ名	必須	型	説明
id	✅	string

リクエスト内容

リクエストパラメータ

フィールド	型	必須	説明
name	string	はい	Chatbot name. In Agent mode it carries semantic meaning; in other modes it only distinguishes chatbots.
largeLanguageModel	string (uuid)	はい	チャットボットが回答生成に使用する大規模言語モデルです（組織が独自に作成した AI Gateway モデルを含みます）
embeddingModel	string (uuid)	いいえ	テキストのベクトル化に使用する埋め込みモデルです。任意項目です
rerankerModel	string (uuid)	いいえ	再ランキングに使用するモデルです。任意項目です
instructions	string	いいえ	Role instructions describing the chatbot's role and behavior.
knowledgeBases	array[IdName]	いいえ	チャットボットがアクセスできるナレッジベースの一覧です
databases	array[IdName]	いいえ	チャットボットがアクセスできる SQL データベースの一覧です（Text-to-SQL 機能用）
organization	string (uuid)	いいえ	チャットボットが所属する組織です。空の場合は個人用チャットボットです
replyMode	object	いいえ	応答モード：通常の応答またはストリーミング応答です normal: 通常 ; template: テンプレート ; hybrid: ハイブリッド ; agent: エージェント;
template	string	いいえ	Template used by Template and Hybrid modes.
unanswerableTemplate	string	いいえ	Template used by Template and Hybrid modes when the question cannot be answered.
totalWordsCount	integer (int64)	いいえ	Accumulated total word count used.
outputMode	object	いいえ	出力モード：テキスト、表、またはカスタム形式です text: テキスト ; json_schema: JSON Schema;
rawOutputFormat	object	いいえ	カスタム出力形式の JSON 構造定義です
groups	array[IdName]	いいえ	チャットボットがアクセスできるグループの一覧です
tools	array[ToolSummary]	いいえ	チャットボットが使用できるツールの一覧です
skills	array[SkillSummary]	いいえ	チャットボットに関連付けられたスキルの一覧です
connectors	array[IdName]	いいえ	Connectors associated with this chatbot, gating per-contact OAuth authorization
agentMode	object	いいえ	エージェントモード：通常、SQL、またはワークフローモードです normal: 通常 ; canvas: キャンバス ; team: チーム;
numberOfRetrievedChunks	integer	いいえ	取得する参照チャンク数です。デフォルトは 12、最小値は 1 です
defaultLabelRelations	object	いいえ	アシスタント単位のデフォルトのナレッジベースラベルフィルター条件です。形式は query_metadata.label_relations と同じです。null はフィルターなしを示します。呼び出し元が query_metadata を指定しない場合にのみ、最も優先度の低いフォールバックとして適用されます。
useFullRetrievalRange	boolean	いいえ	有効にすると LLM の top_k による切り詰めを無視し、reranker の結果をすべて返します
enableEvaluation	boolean	いいえ
enableInlineCitations	boolean	いいえ	Enables inline citations, inserting citation markers such as [1][2] into responses.
enableCodeInterpreter	boolean	いいえ	When enabled, provides the Code Interpreter tool to run code in an isolated container.
enableBrowserTool	boolean	いいえ	Enable browser automation tool for web tasks
enableImageSearch	boolean	いいえ	Provide the image_search tool when any attached knowledge base uses a multimodal embedding model. Disable to remove the tool entirely.
enableClaudeStreamRetry	boolean	いいえ	When a Claude streaming call stalls (first-chunk or mid-stream), abort and re-issue the call once in non-streaming mode. Mid-stream retries send a reset signal so the client discards any partial outpu...
customMaxLlmOutputTokens	integer	いいえ	LLM の最大出力トークン数を指定します。最小値は 512 です
voiceConfig	object	いいえ
voiceConfig.enabled	boolean	いいえ	Whether this chatbot can be used as a voice agent. Checked by every conversation platform (WebChat, SIP phone, admin/marketplace voice test) instead of a per-platform toggle.
voiceConfig.voiceAgentType	string (uuid)	いいえ	Voice agent mode type.
voiceConfig.sttProvider	string (uuid)	いいえ	Speech-to-Text service provider.
voiceConfig.sttConfig	object	いいえ	STT configuration parameters (JSON).
voiceConfig.ttsProvider	string (uuid)	いいえ	Text-to-Speech service provider.
voiceConfig.ttsConfig	object	いいえ	TTS configuration parameters (JSON).
voiceConfig.realtimeProvider	string (uuid)	いいえ	Realtime end-to-end voice model provider.
voiceConfig.realtimeConfig	object	いいえ	Realtime configuration parameters (JSON).
voiceConfig.realtimeInstructions	string	いいえ	Prompt dedicated to the realtime voice session; falls back to chatbot instructions when empty
voiceConfig.turnHandling	object	いいえ	Turn-taking and interruption settings for the voice agent.
voiceConfig.enableVoiceReply	boolean	いいえ	When disabled, the voice agent replies in text only and does not speak
thinkingConfig	object	いいえ	思考レベル：null（モデルのデフォルト）または {"reasoning_effort": "off
enableToolSearching	boolean	いいえ	動的ツール検索を有効にし、エージェントが tool_searching_tool を通じてツールを動的に検出して読み込めるようにします
maxAgentIterations	integer	いいえ	Maximum number of iterations for AgentWorkflow (1-100, default: 20)
agentTimeoutSeconds	integer	いいえ	Timeout in seconds for AgentWorkflow execution (30-1200, default: 600)
agentTimeoutMessage	string	いいえ	Custom user-facing message shown when AgentWorkflow times out (max 500 chars). Leave empty to use the system default.
requireTextWithFlexCards	boolean	いいえ	When enabled, a turn that would end with only Flex Message cards and no text for the user is re-issued to the LLM once, asking it to write the text first and then send the card. Each retry incurs a se...
enableSizeBasedToolResultTruncation	boolean	いいえ	When enabled, tool results exceeding the character threshold are truncated using head+tail strategy instead of the legacy SYSTEM_TOOLS whitelist approach. Reduces memory bloat from large tool outputs ...
toolResultMaxChars	integer	いいえ	Character threshold for size-based tool result truncation (500-50000). Only effective when enable_size_based_tool_result_truncation is True.
enableVectorMemory	boolean	いいえ	When enabled, archived messages are vectorized and processed by fact extraction for semantic retrieval (existing behavior). When disabled, archived messages are discarded and only the active chat hist...
longTermMemoryTopK	integer	いいえ	長期記憶の検索ごとに取得する記憶ノード数です（ベクトル検索の similarity_top_k）。デフォルトは 10、範囲は 1–50 です
enableCrossConversationSearch	boolean	いいえ	When enabled, the conversation history tools also reach this contact's other conversations in the same inbox, within the lookback window. When disabled, they only reach the current conversation.
crossConversationLookbackDays	integer	いいえ	How far back cross-conversation search may reach, measured from each conversation's last message (1-365 days). Leave empty to fall back to 90 days. Only effective when enable_cross_conversation_search...
useGatewayFallback	boolean	いいえ	When enabled, use the fallback group instead of the single LLM
gatewayFallbackGroup	string (uuid)	いいえ
enableSearchMessagesTool	boolean	いいえ	Allow the AI to search past messages in the current conversation.
enableGetMessageContextTool	boolean	いいえ	Allow the AI to retrieve messages surrounding a specific message for context.
enableReadAttachmentFullTextTool	boolean	いいえ	Allow the AI to read the full text of plain-text attachments. AGENT mode only.
enableParseAttachmentContentTool	boolean	いいえ	Allow the AI to parse PDF, Office, audio, and other attachments. AGENT mode only.
enableListAvailableParsersTool	boolean	いいえ	Allow the AI to list available parsers and their capabilities. AGENT mode only.
enableGetDownloadLinkTool	boolean	いいえ	Allow the AI to generate shareable download links for produced content. AGENT mode only.

リクエスト構造の例

{
  "name": string // Chatbot name. In Agent mode it carries semantic meaning; in other modes it only distinguishes chatbots.
  "largeLanguageModel": string (uuid) // チャットボットが回答の生成に使用する大規模言語モデルです（組織が独自に作成した AI Gateway モデルを含みます）。
  "embeddingModel"?: string (uuid) // テキストのベクトル化に使用する任意の埋め込みモデルです。 (任意)
  "rerankerModel"?: string (uuid) // 再ランキングに使用する任意のモデルです。 (任意)
  "instructions"?: string // Role instructions describing the chatbot's role and behavior. (任意)
  "knowledgeBases"?: [ // チャットボットがアクセスできるナレッジベースの一覧です。 (任意)
    {
      "id": string (uuid)
    }
  ]
  "databases"?: [ // チャットボットがアクセスできる SQL データベースの一覧です（Text-to-SQL 機能で使用します）。 (任意)
    {
      "id": string (uuid)
    }
  ]
  "organization"?: string (uuid) // チャットボットが所属する組織です。空の場合は個人用チャットボットになります。 (任意)
  "replyMode"?:  // 応答モードです。通常応答またはストリーミング応答を指定します。

* `normal` - 通常
* `template` - テンプレート
* `hybrid` - ハイブリッド
* `agent` - エージェント (任意)
  {
  }
  "template"?: string // Template used by Template and Hybrid modes. (任意)
  "unanswerableTemplate"?: string // Template used by Template and Hybrid modes when the question cannot be answered. (任意)
  "totalWordsCount"?: integer (int64) // Accumulated total word count used. (任意)
  "outputMode"?:  // 出力モードです。テキスト、表、またはカスタム形式を指定します。

* `text` - テキスト
* `json_schema` - JSON Schema (任意)
  {
  }
  "rawOutputFormat"?: object // カスタム出力形式の JSON 構造定義です。 (任意)
  "groups"?: [ // チャットボットがアクセスできるグループの一覧です。 (任意)
    {
      "id": string (uuid)
    }
  ]
  "tools"?: [ // チャットボットが使用できるツールの一覧です。 (任意)
    {
      "id": string (uuid)
    }
  ]
  "skills"?: [ // チャットボットに関連付けられたスキルの一覧です。 (任意)
    {
      "id": string (uuid)
    }
  ]
  "connectors"?: [ // Connectors associated with this chatbot, gating per-contact OAuth authorization (任意)
    {
      "id": string (uuid)
    }
  ]
  "agentMode"?:  // エージェントモードです。通常、SQL、またはワークフローモードを指定します。

* `normal` - 通常
* `canvas` - Canvas
* `team` - チーム (任意)
  {
  }
  "numberOfRetrievedChunks"?: integer // 取得する参照チャンク数です。デフォルトは 12、最小値は 1 です。 (任意)
  "defaultLabelRelations"?: object // アシスタント単位のデフォルトのナレッジベースラベルフィルターです。形式は query_metadata.label_relations と同じで、null はフィルタリングなしを意味します。呼び出し側が query_metadata を指定しない場合にのみ、優先度が最も低いフォールバックとして適用されます。 (任意)
  "useFullRetrievalRange"?: boolean // 有効にすると、LLM の top_k による切り詰めを無視し、再ランキングの結果をすべて返します。 (任意)
  "enableEvaluation"?: boolean // 任意
  "enableInlineCitations"?: boolean // Enables inline citations, inserting citation markers such as [1][2] into responses. (任意)
  "enableCodeInterpreter"?: boolean // When enabled, provides the Code Interpreter tool to run code in an isolated container. (任意)
  "enableBrowserTool"?: boolean // Enable browser automation tool for web tasks (任意)
  "enableImageSearch"?: boolean // Provide the image_search tool when any attached knowledge base uses a multimodal embedding model. Disable to remove the tool entirely. (任意)
  "enableClaudeStreamRetry"?: boolean // When a Claude streaming call stalls (first-chunk or mid-stream), abort and re-issue the call once in non-streaming mode. Mid-stream retries send a reset signal so the client discards any partial output already rendered. Each retry incurs a second billing for the same prompt. (任意)
  "customMaxLlmOutputTokens"?: integer // LLM の出力トークン数の上限をカスタマイズします。最小値は 512 です。 (任意)
  "voiceConfig"?: { // 任意
  {
    "enabled"?: boolean // Whether this chatbot can be used as a voice agent. Checked by every conversation platform (WebChat, SIP phone, admin/marketplace voice test) instead of a per-platform toggle. (任意)
    "voiceAgentType"?: string (uuid) // Voice agent mode type. (任意)
    "sttProvider"?: string (uuid) // Speech-to-Text service provider. (任意)
    "sttConfig"?: object // STT configuration parameters (JSON). (任意)
    "ttsProvider"?: string (uuid) // Text-to-Speech service provider. (任意)
    "ttsConfig"?: object // TTS configuration parameters (JSON). (任意)
    "realtimeProvider"?: string (uuid) // Realtime end-to-end voice model provider. (任意)
    "realtimeConfig"?: object // Realtime configuration parameters (JSON). (任意)
    "realtimeInstructions"?: string // Prompt dedicated to the realtime voice session; falls back to chatbot instructions when empty (任意)
    "turnHandling"?: object // Turn-taking and interruption settings for the voice agent. (任意)
    "enableVoiceReply"?: boolean // When disabled, the voice agent replies in text only and does not speak (任意)
  }
  }
  "thinkingConfig"?: object // 推論レベルです。null（モデルのデフォルト）または {"reasoning_effort": "off|minimal|low|medium|high|xhigh|max"} を指定します。 (任意)
  "enableToolSearching"?: boolean // 動的ツール検索を有効にし、エージェントが tool_searching_tool を通じてツールを動的に検出して読み込めるようにします。 (任意)
  "maxAgentIterations"?: integer // Maximum number of iterations for AgentWorkflow (1-100, default: 20) (任意)
  "agentTimeoutSeconds"?: integer // Timeout in seconds for AgentWorkflow execution (30-1200, default: 600) (任意)
  "agentTimeoutMessage"?: string // Custom user-facing message shown when AgentWorkflow times out (max 500 chars). Leave empty to use the system default. (任意)
  "requireTextWithFlexCards"?: boolean // When enabled, a turn that would end with only Flex Message cards and no text for the user is re-issued to the LLM once, asking it to write the text first and then send the card. Each retry incurs a second billing for the same prompt. (任意)
  "enableSizeBasedToolResultTruncation"?: boolean // When enabled, tool results exceeding the character threshold are truncated using head+tail strategy instead of the legacy SYSTEM_TOOLS whitelist approach. Reduces memory bloat from large tool outputs (code interpreter bash stdout, web search results, etc.). (任意)
  "toolResultMaxChars"?: integer // Character threshold for size-based tool result truncation (500-50000). Only effective when enable_size_based_tool_result_truncation is True. (任意)
  "enableVectorMemory"?: boolean // When enabled, archived messages are vectorized and processed by fact extraction for semantic retrieval (existing behavior). When disabled, archived messages are discarded and only the active chat history window is used for multi-turn context. (任意)
  "longTermMemoryTopK"?: integer // 長期メモリの検索ごとに取得するメモリノード数です（ベクトル検索の similarity_top_k）。デフォルトは 10、範囲は 1–50 です。 (任意)
  "enableCrossConversationSearch"?: boolean // When enabled, the conversation history tools also reach this contact's other conversations in the same inbox, within the lookback window. When disabled, they only reach the current conversation. (任意)
  "crossConversationLookbackDays"?: integer // How far back cross-conversation search may reach, measured from each conversation's last message (1-365 days). Leave empty to fall back to 90 days. Only effective when enable_cross_conversation_search is True. (任意)
  "useGatewayFallback"?: boolean // When enabled, use the fallback group instead of the single LLM (任意)
  "gatewayFallbackGroup"?: string (uuid) // 任意
  "enableSearchMessagesTool"?: boolean // Allow the AI to search past messages in the current conversation. (任意)
  "enableGetMessageContextTool"?: boolean // Allow the AI to retrieve messages surrounding a specific message for context. (任意)
  "enableReadAttachmentFullTextTool"?: boolean // Allow the AI to read the full text of plain-text attachments. AGENT mode only. (任意)
  "enableParseAttachmentContentTool"?: boolean // Allow the AI to parse PDF, Office, audio, and other attachments. AGENT mode only. (任意)
  "enableListAvailableParsersTool"?: boolean // Allow the AI to list available parsers and their capabilities. AGENT mode only. (任意)
  "enableGetDownloadLinkTool"?: boolean // Allow the AI to generate shareable download links for produced content. AGENT mode only. (任意)
}

リクエスト値の例

{
  "name": "サンプル名",
  "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "instructions": "サンプル文字列",
  "knowledgeBases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "databases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "replyMode": {},
  "template": "サンプル文字列",
  "unanswerableTemplate": "サンプル文字列",
  "totalWordsCount": 123,
  "outputMode": {},
  "rawOutputFormat": null,
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "tools": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "skills": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "connectors": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "agentMode": {},
  "numberOfRetrievedChunks": 123,
  "defaultLabelRelations": null,
  "useFullRetrievalRange": true,
  "enableEvaluation": true,
  "enableInlineCitations": true,
  "enableCodeInterpreter": true,
  "enableBrowserTool": true,
  "enableImageSearch": true,
  "enableClaudeStreamRetry": true,
  "customMaxLlmOutputTokens": 123,
  "voiceConfig": {
    "enabled": true,
    "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
    "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
    "sttConfig": null,
    "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
    "ttsConfig": null,
    "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
    "realtimeConfig": null,
    "realtimeInstructions": "サンプル文字列",
    "turnHandling": null,
    "enableVoiceReply": true
  },
  "thinkingConfig": null,
  "enableToolSearching": true,
  "maxAgentIterations": 123,
  "agentTimeoutSeconds": 123,
  "agentTimeoutMessage": "サンプル文字列",
  "requireTextWithFlexCards": true,
  "enableSizeBasedToolResultTruncation": true,
  "toolResultMaxChars": 123,
  "enableVectorMemory": true,
  "longTermMemoryTopK": 123,
  "enableCrossConversationSearch": true,
  "crossConversationLookbackDays": 123,
  "useGatewayFallback": true,
  "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
  "enableSearchMessagesTool": true,
  "enableGetMessageContextTool": true,
  "enableReadAttachmentFullTextTool": true,
  "enableParseAttachmentContentTool": true,
  "enableListAvailableParsersTool": true,
  "enableGetDownloadLinkTool": true
}

コード例

Shell/Bash

# API 呼び出し例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "サンプル名",
    "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
    "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
    "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
    "instructions": "サンプル文字列",
    "knowledgeBases": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "databases": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "organization": "550e8400-e29b-41d4-a716-446655440000",
    "replyMode": {},
    "template": "サンプル文字列",
    "unanswerableTemplate": "サンプル文字列",
    "totalWordsCount": 123,
    "outputMode": {},
    "rawOutputFormat": null,
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "tools": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "skills": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "connectors": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "agentMode": {},
    "numberOfRetrievedChunks": 123,
    "defaultLabelRelations": null,
    "useFullRetrievalRange": true,
    "enableEvaluation": true,
    "enableInlineCitations": true,
    "enableCodeInterpreter": true,
    "enableBrowserTool": true,
    "enableImageSearch": true,
    "enableClaudeStreamRetry": true,
    "customMaxLlmOutputTokens": 123,
    "voiceConfig": {
      "enabled": true,
      "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
      "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
      "sttConfig": null,
      "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
      "ttsConfig": null,
      "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
      "realtimeConfig": null,
      "realtimeInstructions": "サンプル文字列",
      "turnHandling": null,
      "enableVoiceReply": true
    },
    "thinkingConfig": null,
    "enableToolSearching": true,
    "maxAgentIterations": 123,
    "agentTimeoutSeconds": 123,
    "agentTimeoutMessage": "サンプル文字列",
    "requireTextWithFlexCards": true,
    "enableSizeBasedToolResultTruncation": true,
    "toolResultMaxChars": 123,
    "enableVectorMemory": true,
    "longTermMemoryTopK": 123,
    "enableCrossConversationSearch": true,
    "crossConversationLookbackDays": 123,
    "useGatewayFallback": true,
    "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
    "enableSearchMessagesTool": true,
    "enableGetMessageContextTool": true,
    "enableReadAttachmentFullTextTool": true,
    "enableParseAttachmentContentTool": true,
    "enableListAvailableParsersTool": true,
    "enableGetDownloadLinkTool": true
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

const axios = require('axios');

// リクエストヘッダーを設定します
const config = {
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
};

// リクエスト本文 (payload)
const data = {
    "name": "サンプル名",
    "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
    "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
    "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
    "instructions": "サンプル文字列",
    "knowledgeBases": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "databases": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "organization": "550e8400-e29b-41d4-a716-446655440000",
    "replyMode": {},
    "template": "サンプル文字列",
    "unanswerableTemplate": "サンプル文字列",
    "totalWordsCount": 123,
    "outputMode": {},
    "rawOutputFormat": null,
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "tools": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "skills": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "connectors": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "agentMode": {},
    "numberOfRetrievedChunks": 123,
    "defaultLabelRelations": null,
    "useFullRetrievalRange": true,
    "enableEvaluation": true,
    "enableInlineCitations": true,
    "enableCodeInterpreter": true,
    "enableBrowserTool": true,
    "enableImageSearch": true,
    "enableClaudeStreamRetry": true,
    "customMaxLlmOutputTokens": 123,
    "voiceConfig": {
      "enabled": true,
      "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
      "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
      "sttConfig": null,
      "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
      "ttsConfig": null,
      "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
      "realtimeConfig": null,
      "realtimeInstructions": "サンプル文字列",
      "turnHandling": null,
      "enableVoiceReply": true
    },
    "thinkingConfig": null,
    "enableToolSearching": true,
    "maxAgentIterations": 123,
    "agentTimeoutSeconds": 123,
    "agentTimeoutMessage": "サンプル文字列",
    "requireTextWithFlexCards": true,
    "enableSizeBasedToolResultTruncation": true,
    "toolResultMaxChars": 123,
    "enableVectorMemory": true,
    "longTermMemoryTopK": 123,
    "enableCrossConversationSearch": true,
    "crossConversationLookbackDays": 123,
    "useGatewayFallback": true,
    "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
    "enableSearchMessagesTool": true,
    "enableGetMessageContextTool": true,
    "enableReadAttachmentFullTextTool": true,
    "enableParseAttachmentContentTool": true,
    "enableListAvailableParsersTool": true,
    "enableGetDownloadLinkTool": true
  };

axios.put("https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/", data, config)
  .then(response => {
    console.log('応答を正常に取得しました:');
    console.log(response.data);
  })
  .catch(error => {
    console.error('リクエストでエラーが発生しました:');
    console.error(error.response?.data || error.message);
  });

Python

import requests

url = "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY",
    "Content-Type": "application/json"
}

# リクエスト本文 (payload)
data = {
      "name": "サンプル名",
      "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
      "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
      "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
      "instructions": "サンプル文字列",
      "knowledgeBases": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "databases": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "organization": "550e8400-e29b-41d4-a716-446655440000",
      "replyMode": {},
      "template": "サンプル文字列",
      "unanswerableTemplate": "サンプル文字列",
      "totalWordsCount": 123,
      "outputMode": {},
      "rawOutputFormat": null,
      "groups": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "tools": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "skills": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "connectors": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "agentMode": {},
      "numberOfRetrievedChunks": 123,
      "defaultLabelRelations": null,
      "useFullRetrievalRange": true,
      "enableEvaluation": true,
      "enableInlineCitations": true,
      "enableCodeInterpreter": true,
      "enableBrowserTool": true,
      "enableImageSearch": true,
      "enableClaudeStreamRetry": true,
      "customMaxLlmOutputTokens": 123,
      "voiceConfig": {
        "enabled": true,
        "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
        "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
        "sttConfig": null,
        "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
        "ttsConfig": null,
        "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
        "realtimeConfig": null,
        "realtimeInstructions": "サンプル文字列",
        "turnHandling": null,
        "enableVoiceReply": true
      },
      "thinkingConfig": null,
      "enableToolSearching": true,
      "maxAgentIterations": 123,
      "agentTimeoutSeconds": 123,
      "agentTimeoutMessage": "サンプル文字列",
      "requireTextWithFlexCards": true,
      "enableSizeBasedToolResultTruncation": true,
      "toolResultMaxChars": 123,
      "enableVectorMemory": true,
      "longTermMemoryTopK": 123,
      "enableCrossConversationSearch": true,
      "crossConversationLookbackDays": 123,
      "useGatewayFallback": true,
      "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
      "enableSearchMessagesTool": true,
      "enableGetMessageContextTool": true,
      "enableReadAttachmentFullTextTool": true,
      "enableParseAttachmentContentTool": true,
      "enableListAvailableParsersTool": true,
      "enableGetDownloadLinkTool": true
    }

response = requests.put(url, json=data, headers=headers)
try:
    print("応答を正常に取得しました:")
    print(response.json())
except Exception as e:
    print("リクエストでエラーが発生しました:", e)

PHP

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

try {
    $response = $client->put("https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/", [
        'headers' => [
            'Authorization' => 'Api-Key YOUR_API_KEY',
            'Content-Type' => 'application/json'
        ],
        'json' => {
            "name": "名前の例",
            "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
            "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
            "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
            "instructions": "文字列の例",
            "knowledgeBases": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "databases": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "organization": "550e8400-e29b-41d4-a716-446655440000",
            "replyMode": {},
            "template": "文字列の例",
            "unanswerableTemplate": "文字列の例",
            "totalWordsCount": 123,
            "outputMode": {},
            "rawOutputFormat": null,
            "groups": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "tools": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "skills": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "connectors": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "agentMode": {},
            "numberOfRetrievedChunks": 123,
            "defaultLabelRelations": null,
            "useFullRetrievalRange": true,
            "enableEvaluation": true,
            "enableInlineCitations": true,
            "enableCodeInterpreter": true,
            "enableBrowserTool": true,
            "enableImageSearch": true,
            "enableClaudeStreamRetry": true,
            "customMaxLlmOutputTokens": 123,
            "voiceConfig": {
                "enabled": true,
                "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
                "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
                "sttConfig": null,
                "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
                "ttsConfig": null,
                "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
                "realtimeConfig": null,
                "realtimeInstructions": "文字列の例",
                "turnHandling": null,
                "enableVoiceReply": true
            },
            "thinkingConfig": null,
            "enableToolSearching": true,
            "maxAgentIterations": 123,
            "agentTimeoutSeconds": 123,
            "agentTimeoutMessage": "文字列の例",
            "requireTextWithFlexCards": true,
            "enableSizeBasedToolResultTruncation": true,
            "toolResultMaxChars": 123,
            "enableVectorMemory": true,
            "longTermMemoryTopK": 123,
            "enableCrossConversationSearch": true,
            "crossConversationLookbackDays": 123,
            "useGatewayFallback": true,
            "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
            "enableSearchMessagesTool": true,
            "enableGetMessageContextTool": true,
            "enableReadAttachmentFullTextTool": true,
            "enableParseAttachmentContentTool": true,
            "enableListAvailableParsersTool": true,
            "enableGetDownloadLinkTool": true
        }
    ]);
    
    $data = json_decode($response->getBody(), true);
    echo "レスポンスを正常に取得しました:\n";
    print_r($data);
} catch (Exception $e) {
    echo 'リクエストでエラーが発生しました: ' . $e->getMessage();
}
?>

レスポンス内容

ステータスコード: 200

レスポンス構造の例

{
  "id": string (uuid)
  "name": string // Chatbot name. In Agent mode it carries semantic meaning; in other modes it only distinguishes chatbots.
  "largeLanguageModel": string (uuid) // チャットボットが回答の生成に使用する大規模言語モデルです（組織が独自に作成した AI Gateway モデルを含みます）。
  "llm":  // 関連付けられたモデルの id、name、提供終了情報です。FK から直接読み取り、組織がそのモデルを無効にしている場合も返します。
  {
    "id": string (uuid)
    "name": string
    "retiresAt": string (date) // プロバイダーによる提供終了日です。この日を過ぎると、毎日の定期処理でアシスタントを replacement に切り替え、このモデルを無効にします。null は提供終了が予定されていないことを示します。
    "replacement":  // 提供終了後の移行先モデル（id と name）です。null は未指定を示し、提供終了時に自動移行しません。
    {
      "id": string (uuid)
      "name": string
    }
  }
  "embeddingModel"?: string (uuid) // テキストのベクトル化に使用する埋め込みモデルです。省略可能です。 (省略可能)
  "rerankerModel"?: string (uuid) // 再ランキングに使用するモデルです。省略可能です。 (省略可能)
  "instructions"?: string // Role instructions describing the chatbot's role and behavior. (省略可能)
  "knowledgeBases"?: [ // チャットボットがアクセスできるナレッジベースの一覧です。 (省略可能)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "databases"?: [ // チャットボットがアクセスできる SQL データベースの一覧です（Text-to-SQL 用）。 (省略可能)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "updatedAt": string (timestamp)
  "organization"?: string (uuid) // チャットボットが所属する組織です。空の場合は個人用チャットボットです。 (省略可能)
  "replyMode"?:  // 応答モードです。通常の応答またはストリーミング応答を指定します。

* `normal` - 通常
* `template` - テンプレート
* `hybrid` - ハイブリッド
* `agent` - エージェント (省略可能)
  {
  }
  "template"?: string // Template used by Template and Hybrid modes. (省略可能)
  "unanswerableTemplate"?: string // Template used by Template and Hybrid modes when the question cannot be answered. (省略可能)
  "totalWordsCount"?: integer (int64) // Accumulated total word count used. (省略可能)
  "outputMode"?:  // 出力モードです。テキスト、表、カスタム形式を指定します。

* `text` - テキスト
* `json_schema` - JSON Schema (省略可能)
  {
  }
  "rawOutputFormat"?: object // カスタム出力形式の JSON 構造定義です。 (省略可能)
  "groups"?: [ // チャットボットがアクセスできるグループの一覧です。 (省略可能)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "tools"?: [ // チャットボットが使用できるツールの一覧です。 (省略可能)
    {
      "id": string (uuid)
      "name": string
      "description": string
      "displayName": string
      "toolType": string
    }
  ]
  "skills"?: [ // チャットボットに関連付けられたスキルの一覧です。 (省略可能)
    {
      "id": string (uuid)
      "name": string
      "description": string
    }
  ]
  "connectors"?: [ // Connectors associated with this chatbot, gating per-contact OAuth authorization (省略可能)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "agentMode"?:  // エージェントモードです。通常、SQL、ワークフローモードを指定します。

* `normal` - 通常
* `canvas` - キャンバス
* `team` - チーム (省略可能)
  {
  }
  "numberOfRetrievedChunks"?: integer // 取得する参照資料のチャンク数です。デフォルトは 12、最小値は 1 です。 (省略可能)
  "defaultLabelRelations"?: object // アシスタント単位のデフォルトのナレッジベースラベルフィルターです。形式は query_metadata.label_relations と同じです。null はフィルターなしを示します。呼び出し元が query_metadata を指定しない場合にのみ、優先度が最も低いフォールバックとして適用します。 (省略可能)
  "useFullRetrievalRange"?: boolean // 有効にすると LLM の top_k による切り詰めを無視し、reranker の結果をすべて返します。 (省略可能)
  "enableEvaluation"?: boolean // 省略可能
  "enableInlineCitations"?: boolean // Enables inline citations, inserting citation markers such as [1][2] into responses. (省略可能)
  "enableCodeInterpreter"?: boolean // When enabled, provides the Code Interpreter tool to run code in an isolated container. (省略可能)
  "enableBrowserTool"?: boolean // Enable browser automation tool for web tasks (省略可能)
  "enableImageSearch"?: boolean // Provide the image_search tool when any attached knowledge base uses a multimodal embedding model. Disable to remove the tool entirely. (省略可能)
  "enableClaudeStreamRetry"?: boolean // When a Claude streaming call stalls (first-chunk or mid-stream), abort and re-issue the call once in non-streaming mode. Mid-stream retries send a reset signal so the client discards any partial output already rendered. Each retry incurs a second billing for the same prompt. (省略可能)
  "customMaxLlmOutputTokens"?: integer // LLM の出力トークン数の上限を指定します。最小値は 512 です。 (省略可能)
  "voiceConfig"?: { // 省略可能
  {
    "enabled"?: boolean // Whether this chatbot can be used as a voice agent. Checked by every conversation platform (WebChat, SIP phone, admin/marketplace voice test) instead of a per-platform toggle. (省略可能)
    "voiceAgentType"?: string (uuid) // Voice agent mode type. (省略可能)
    "sttProvider"?: string (uuid) // Speech-to-Text service provider. (省略可能)
    "sttConfig"?: object // STT configuration parameters (JSON). (省略可能)
    "ttsProvider"?: string (uuid) // Text-to-Speech service provider. (省略可能)
    "ttsConfig"?: object // TTS configuration parameters (JSON). (省略可能)
    "realtimeProvider"?: string (uuid) // Realtime end-to-end voice model provider. (省略可能)
    "realtimeConfig"?: object // Realtime configuration parameters (JSON). (省略可能)
    "realtimeInstructions"?: string // Prompt dedicated to the realtime voice session; falls back to chatbot instructions when empty (省略可能)
    "turnHandling"?: object // Turn-taking and interruption settings for the voice agent. (省略可能)
    "enableVoiceReply"?: boolean // When disabled, the voice agent replies in text only and does not speak (省略可能)
  }
  }
  "thinkingConfig"?: object // 推論レベルです。null（モデルのデフォルト）または {"reasoning_effort": "off|minimal|low|medium|high|xhigh|max"} (省略可能)
  "enableToolSearching"?: boolean // 動的なツール検索を有効にし、agent が tool_searching_tool を通じてツールを動的に検出して読み込めるようにします。 (省略可能)
  "maxAgentIterations"?: integer // Maximum number of iterations for AgentWorkflow (1-100, default: 20) (省略可能)
  "agentTimeoutSeconds"?: integer // Timeout in seconds for AgentWorkflow execution (30-1200, default: 600) (省略可能)
  "agentTimeoutMessage"?: string // Custom user-facing message shown when AgentWorkflow times out (max 500 chars). Leave empty to use the system default. (省略可能)
  "requireTextWithFlexCards"?: boolean // When enabled, a turn that would end with only Flex Message cards and no text for the user is re-issued to the LLM once, asking it to write the text first and then send the card. Each retry incurs a second billing for the same prompt. (省略可能)
  "isMultimodalLlm": boolean // Whether the chatbot LLM supports multimodal (read-only)
  "enableSizeBasedToolResultTruncation"?: boolean // When enabled, tool results exceeding the character threshold are truncated using head+tail strategy instead of the legacy SYSTEM_TOOLS whitelist approach. Reduces memory bloat from large tool outputs (code interpreter bash stdout, web search results, etc.). (省略可能)
  "toolResultMaxChars"?: integer // Character threshold for size-based tool result truncation (500-50000). Only effective when enable_size_based_tool_result_truncation is True. (省略可能)
  "enableVectorMemory"?: boolean // When enabled, archived messages are vectorized and processed by fact extraction for semantic retrieval (existing behavior). When disabled, archived messages are discarded and only the active chat history window is used for multi-turn context. (省略可能)
  "longTermMemoryTopK"?: integer // 長期記憶の検索ごとに取得する記憶ノード数です（ベクトル検索の similarity_top_k）。デフォルトは 10、範囲は 1–50 です。 (省略可能)
  "enableCrossConversationSearch"?: boolean // When enabled, the conversation history tools also reach this contact's other conversations in the same inbox, within the lookback window. When disabled, they only reach the current conversation. (省略可能)
  "crossConversationLookbackDays"?: integer // How far back cross-conversation search may reach, measured from each conversation's last message (1-365 days). Leave empty to fall back to 90 days. Only effective when enable_cross_conversation_search is True. (省略可能)
  "useGatewayFallback"?: boolean // When enabled, use the fallback group instead of the single LLM (省略可能)
  "gatewayFallbackGroup"?: string (uuid) // 省略可能
  "enableSearchMessagesTool"?: boolean // Allow the AI to search past messages in the current conversation. (省略可能)
  "enableGetMessageContextTool"?: boolean // Allow the AI to retrieve messages surrounding a specific message for context. (省略可能)
  "enableReadAttachmentFullTextTool"?: boolean // Allow the AI to read the full text of plain-text attachments. AGENT mode only. (省略可能)
  "enableParseAttachmentContentTool"?: boolean // Allow the AI to parse PDF, Office, audio, and other attachments. AGENT mode only. (省略可能)
  "enableListAvailableParsersTool"?: boolean // Allow the AI to list available parsers and their capabilities. AGENT mode only. (省略可能)
  "enableGetDownloadLinkTool"?: boolean // Allow the AI to generate shareable download links for produced content. AGENT mode only. (省略可能)
  "isLocked": boolean // Locked instance: config follows the official version; only the dedicated KB can be modified
  "sourceBuildInAgent": string (uuid) // Points to the official Build-in Agent blueprint when instantiated by a rental
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
}

レスポンス値の例

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンス文字列",
  "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
  "llm": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンス文字列",
    "retiresAt": "レスポンス文字列",
    "replacement": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  },
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "instructions": "レスポンス文字列",
  "knowledgeBases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "databases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "updatedAt": "レスポンス文字列",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "replyMode": {},
  "template": "レスポンス文字列",
  "unanswerableTemplate": "レスポンス文字列",
  "totalWordsCount": 456,
  "outputMode": {},
  "rawOutputFormat": null,
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "tools": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列",
      "description": "レスポンス文字列",
      "displayName": "レスポンス文字列",
      "toolType": "レスポンス文字列"
    }
  ],
  "skills": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列",
      "description": "レスポンス文字列"
    }
  ],
  "connectors": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンス文字列"
    }
  ],
  "agentMode": {},
  "numberOfRetrievedChunks": 456,
  "defaultLabelRelations": null,
  "useFullRetrievalRange": false,
  "enableEvaluation": false,
  "enableInlineCitations": false,
  "enableCodeInterpreter": false,
  "enableBrowserTool": false,
  "enableImageSearch": false,
  "enableClaudeStreamRetry": false,
  "customMaxLlmOutputTokens": 456,
  "voiceConfig": {
    "enabled": false,
    "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
    "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
    "sttConfig": null,
    "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
    "ttsConfig": null,
    "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
    "realtimeConfig": null,
    "realtimeInstructions": "レスポンス文字列",
    "turnHandling": null,
    "enableVoiceReply": false
  },
  "thinkingConfig": null,
  "enableToolSearching": false,
  "maxAgentIterations": 456,
  "agentTimeoutSeconds": 456,
  "agentTimeoutMessage": "レスポンス文字列",
  "requireTextWithFlexCards": false,
  "isMultimodalLlm": false,
  "enableSizeBasedToolResultTruncation": false,
  "toolResultMaxChars": 456,
  "enableVectorMemory": false,
  "longTermMemoryTopK": 456,
  "enableCrossConversationSearch": false,
  "crossConversationLookbackDays": 456,
  "useGatewayFallback": false,
  "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
  "enableSearchMessagesTool": false,
  "enableGetMessageContextTool": false,
  "enableReadAttachmentFullTextTool": false,
  "enableParseAttachmentContentTool": false,
  "enableListAvailableParsersTool": false,
  "enableGetDownloadLinkTool": false,
  "isLocked": false,
  "sourceBuildInAgent": "550e8400-e29b-41d4-a716-446655440000",
  "canUpdate": false,
  "canDelete": false
}

---

AI アシスタントを部分更新

PATCH /api/v1/chatbots/{id}/

パラメーター

パラメーター名	必須	型	説明
id	✅	string

リクエスト内容

リクエストパラメーター

フィールド	型	必須	説明
name	string	いいえ	Chatbot name. In Agent mode it carries semantic meaning; in other modes it only distinguishes chatbots.
largeLanguageModel	string (uuid)	いいえ	チャットボットが回答の生成に使用する大規模言語モデルです（組織が独自に構築した AI Gateway モデルを含みます）。
embeddingModel	string (uuid)	いいえ	テキストのベクトル化に使用する埋め込みモデルです。省略可能です。
rerankerModel	string (uuid)	いいえ	再ランキングに使用するモデルです。省略可能です。
instructions	string	いいえ	Role instructions describing the chatbot's role and behavior.
knowledgeBases	array[IdName]	いいえ	チャットボットがアクセスできるナレッジベースの一覧です。
databases	array[IdName]	いいえ	チャットボットがアクセスできる SQL データベースの一覧です（Text-to-SQL 機能で使用します）。
organization	string (uuid)	いいえ	チャットボットが所属する組織です。空の場合は個人用チャットボットです。
replyMode	object	いいえ	応答モード：通常応答またはストリーミング応答 normal: 通常 ; template: テンプレート ; hybrid: ハイブリッド ; agent: エージェント;
template	string	いいえ	Template used by Template and Hybrid modes.
unanswerableTemplate	string	いいえ	Template used by Template and Hybrid modes when the question cannot be answered.
totalWordsCount	integer (int64)	いいえ	Accumulated total word count used.
outputMode	object	いいえ	出力モード：テキスト、表、またはカスタム形式 text: テキスト ; json_schema: JSON Schema;
rawOutputFormat	object	いいえ	カスタム出力形式の JSON 構造定義です。
groups	array[IdName]	いいえ	チャットボットがアクセスできるグループの一覧です。
tools	array[ToolSummary]	いいえ	チャットボットが使用できるツールの一覧です。
skills	array[SkillSummary]	いいえ	チャットボットに関連付けられたスキルの一覧です。
connectors	array[IdName]	いいえ	Connectors associated with this chatbot, gating per-contact OAuth authorization
agentMode	object	いいえ	エージェントモード：通常、SQL、またはワークフローモード normal: 通常 ; canvas: Canvas ; team: チーム;
numberOfRetrievedChunks	integer	いいえ	取得する参考資料のチャンク数です。デフォルトは 12、最小値は 1 です。
defaultLabelRelations	object	いいえ	アシスタント単位のデフォルトのナレッジベースラベルフィルター条件です。形式は query_metadata.label_relations と同じで、null はフィルターなしを意味します。呼び出し元が query_metadata を指定しない場合にのみ、最も優先度の低いフォールバックとして適用されます。
useFullRetrievalRange	boolean	いいえ	有効にすると、LLM の top_k による切り捨てを無視し、再ランキングの全結果を返します。
enableEvaluation	boolean	いいえ
enableInlineCitations	boolean	いいえ	Enables inline citations, inserting citation markers such as [1][2] into responses.
enableCodeInterpreter	boolean	いいえ	When enabled, provides the Code Interpreter tool to run code in an isolated container.
enableBrowserTool	boolean	いいえ	Enable browser automation tool for web tasks
enableImageSearch	boolean	いいえ	Provide the image_search tool when any attached knowledge base uses a multimodal embedding model. Disable to remove the tool entirely.
enableClaudeStreamRetry	boolean	いいえ	When a Claude streaming call stalls (first-chunk or mid-stream), abort and re-issue the call once in non-streaming mode. Mid-stream retries send a reset signal so the client discards any partial outpu...
customMaxLlmOutputTokens	integer	いいえ	LLM の最大出力トークン数を指定します。最小値は 512 です。
voiceConfig	object	いいえ
voiceConfig.enabled	boolean	いいえ	Whether this chatbot can be used as a voice agent. Checked by every conversation platform (WebChat, SIP phone, admin/marketplace voice test) instead of a per-platform toggle.
voiceConfig.voiceAgentType	string (uuid)	いいえ	Voice agent mode type.
voiceConfig.sttProvider	string (uuid)	いいえ	Speech-to-Text service provider.
voiceConfig.sttConfig	object	いいえ	STT configuration parameters (JSON).
voiceConfig.ttsProvider	string (uuid)	いいえ	Text-to-Speech service provider.
voiceConfig.ttsConfig	object	いいえ	TTS configuration parameters (JSON).
voiceConfig.realtimeProvider	string (uuid)	いいえ	Realtime end-to-end voice model provider.
voiceConfig.realtimeConfig	object	いいえ	Realtime configuration parameters (JSON).
voiceConfig.realtimeInstructions	string	いいえ	Prompt dedicated to the realtime voice session; falls back to chatbot instructions when empty
voiceConfig.turnHandling	object	いいえ	Turn-taking and interruption settings for the voice agent.
voiceConfig.enableVoiceReply	boolean	いいえ	When disabled, the voice agent replies in text only and does not speak
thinkingConfig	object	いいえ	推論レベル：null（モデルのデフォルト）または {"reasoning_effort": "off
enableToolSearching	boolean	いいえ	動的ツール検索を有効にし、エージェントが tool_searching_tool を通じてツールを動的に検出して読み込めるようにします。
maxAgentIterations	integer	いいえ	Maximum number of iterations for AgentWorkflow (1-100, default: 20)
agentTimeoutSeconds	integer	いいえ	Timeout in seconds for AgentWorkflow execution (30-1200, default: 600)
agentTimeoutMessage	string	いいえ	Custom user-facing message shown when AgentWorkflow times out (max 500 chars). Leave empty to use the system default.
requireTextWithFlexCards	boolean	いいえ	When enabled, a turn that would end with only Flex Message cards and no text for the user is re-issued to the LLM once, asking it to write the text first and then send the card. Each retry incurs a se...
enableSizeBasedToolResultTruncation	boolean	いいえ	When enabled, tool results exceeding the character threshold are truncated using head+tail strategy instead of the legacy SYSTEM_TOOLS whitelist approach. Reduces memory bloat from large tool outputs ...
toolResultMaxChars	integer	いいえ	Character threshold for size-based tool result truncation (500-50000). Only effective when enable_size_based_tool_result_truncation is True.
enableVectorMemory	boolean	いいえ	When enabled, archived messages are vectorized and processed by fact extraction for semantic retrieval (existing behavior). When disabled, archived messages are discarded and only the active chat hist...
longTermMemoryTopK	integer	いいえ	長期記憶の検索ごとに取得する記憶ノード数です（ベクトル検索の similarity_top_k）。デフォルトは 10、範囲は 1–50 です。
enableCrossConversationSearch	boolean	いいえ	When enabled, the conversation history tools also reach this contact's other conversations in the same inbox, within the lookback window. When disabled, they only reach the current conversation.
crossConversationLookbackDays	integer	いいえ	How far back cross-conversation search may reach, measured from each conversation's last message (1-365 days). Leave empty to fall back to 90 days. Only effective when enable_cross_conversation_search...
useGatewayFallback	boolean	いいえ	When enabled, use the fallback group instead of the single LLM
gatewayFallbackGroup	string (uuid)	いいえ
enableSearchMessagesTool	boolean	いいえ	Allow the AI to search past messages in the current conversation.
enableGetMessageContextTool	boolean	いいえ	Allow the AI to retrieve messages surrounding a specific message for context.
enableReadAttachmentFullTextTool	boolean	いいえ	Allow the AI to read the full text of plain-text attachments. AGENT mode only.
enableParseAttachmentContentTool	boolean	いいえ	Allow the AI to parse PDF, Office, audio, and other attachments. AGENT mode only.
enableListAvailableParsersTool	boolean	いいえ	Allow the AI to list available parsers and their capabilities. AGENT mode only.
enableGetDownloadLinkTool	boolean	いいえ	Allow the AI to generate shareable download links for produced content. AGENT mode only.

リクエスト構造の例

{
  "name"?: string // Chatbot name. In Agent mode it carries semantic meaning; in other modes it only distinguishes chatbots. (省略可能)
  "largeLanguageModel"?: string (uuid) // チャットボットが回答の生成に使用する大規模言語モデルです（組織が独自に構築した AI Gateway モデルを含みます）。 (省略可能)
  "embeddingModel"?: string (uuid) // テキストのベクトル化に使用する埋め込みモデルです。省略可能です。 (省略可能)
  "rerankerModel"?: string (uuid) // 再ランキングに使用するモデルです。省略可能です。 (省略可能)
  "instructions"?: string // Role instructions describing the chatbot's role and behavior. (省略可能)
  "knowledgeBases"?: [ // チャットボットがアクセスできるナレッジベースの一覧です。 (省略可能)
    {
      "id": string (uuid)
    }
  ]
  "databases"?: [ // チャットボットがアクセスできる SQL データベースの一覧です（Text-to-SQL 機能で使用します）。 (省略可能)
    {
      "id": string (uuid)
    }
  ]
  "organization"?: string (uuid) // チャットボットが所属する組織です。空の場合は個人用チャットボットです。 (省略可能)
  "replyMode"?:  // 応答モード：通常応答またはストリーミング応答

* `normal` - 通常
* `template` - テンプレート
* `hybrid` - ハイブリッド
* `agent` - エージェント (省略可能)
  {
  }
  "template"?: string // Template used by Template and Hybrid modes. (省略可能)
  "unanswerableTemplate"?: string // Template used by Template and Hybrid modes when the question cannot be answered. (省略可能)
  "totalWordsCount"?: integer (int64) // Accumulated total word count used. (省略可能)
  "outputMode"?:  // 出力モード：テキスト、表、またはカスタム形式

* `text` - テキスト
* `json_schema` - JSON Schema (省略可能)
  {
  }
  "rawOutputFormat"?: object // カスタム出力形式の JSON 構造定義です。 (省略可能)
  "groups"?: [ // チャットボットがアクセスできるグループの一覧です。 (省略可能)
    {
      "id": string (uuid)
    }
  ]
  "tools"?: [ // チャットボットが使用できるツールの一覧です。 (省略可能)
    {
      "id": string (uuid)
    }
  ]
  "skills"?: [ // チャットボットに関連付けられたスキルの一覧です。 (省略可能)
    {
      "id": string (uuid)
    }
  ]
  "connectors"?: [ // Connectors associated with this chatbot, gating per-contact OAuth authorization (省略可能)
    {
      "id": string (uuid)
    }
  ]
  "agentMode"?:  // エージェントモード：通常、SQL、またはワークフローモード

* `normal` - 通常
* `canvas` - Canvas
* `team` - チーム (省略可能)
  {
  }
  "numberOfRetrievedChunks"?: integer // 取得する参考資料のチャンク数です。デフォルトは 12、最小値は 1 です。 (省略可能)
  "defaultLabelRelations"?: object // アシスタント単位のデフォルトのナレッジベースラベルフィルター条件です。形式は query_metadata.label_relations と同じで、null はフィルターなしを意味します。呼び出し元が query_metadata を指定しない場合にのみ、最も優先度の低いフォールバックとして適用されます。 (省略可能)
  "useFullRetrievalRange"?: boolean // 有効にすると、LLM の top_k による切り捨てを無視し、再ランキングの全結果を返します。 (省略可能)
  "enableEvaluation"?: boolean // 省略可能
  "enableInlineCitations"?: boolean // Enables inline citations, inserting citation markers such as [1][2] into responses. (省略可能)
  "enableCodeInterpreter"?: boolean // When enabled, provides the Code Interpreter tool to run code in an isolated container. (省略可能)
  "enableBrowserTool"?: boolean // Enable browser automation tool for web tasks (省略可能)
  "enableImageSearch"?: boolean // Provide the image_search tool when any attached knowledge base uses a multimodal embedding model. Disable to remove the tool entirely. (省略可能)
  "enableClaudeStreamRetry"?: boolean // When a Claude streaming call stalls (first-chunk or mid-stream), abort and re-issue the call once in non-streaming mode. Mid-stream retries send a reset signal so the client discards any partial output already rendered. Each retry incurs a second billing for the same prompt. (省略可能)
  "customMaxLlmOutputTokens"?: integer // LLM の最大出力トークン数を指定します。最小値は 512 です。 (省略可能)
  "voiceConfig"?: { // 省略可能
  {
    "enabled"?: boolean // Whether this chatbot can be used as a voice agent. Checked by every conversation platform (WebChat, SIP phone, admin/marketplace voice test) instead of a per-platform toggle. (省略可能)
    "voiceAgentType"?: string (uuid) // Voice agent mode type. (省略可能)
    "sttProvider"?: string (uuid) // Speech-to-Text service provider. (省略可能)
    "sttConfig"?: object // STT configuration parameters (JSON). (省略可能)
    "ttsProvider"?: string (uuid) // Text-to-Speech service provider. (省略可能)
    "ttsConfig"?: object // TTS configuration parameters (JSON). (省略可能)
    "realtimeProvider"?: string (uuid) // Realtime end-to-end voice model provider. (省略可能)
    "realtimeConfig"?: object // Realtime configuration parameters (JSON). (省略可能)
    "realtimeInstructions"?: string // Prompt dedicated to the realtime voice session; falls back to chatbot instructions when empty (省略可能)
    "turnHandling"?: object // Turn-taking and interruption settings for the voice agent. (省略可能)
    "enableVoiceReply"?: boolean // When disabled, the voice agent replies in text only and does not speak (省略可能)
  }
  }
  "thinkingConfig"?: object // 推論レベル：null（モデルのデフォルト）または {"reasoning_effort": "off|minimal|low|medium|high|xhigh|max"} (省略可能)
  "enableToolSearching"?: boolean // 動的ツール検索を有効にし、エージェントが tool_searching_tool を通じてツールを動的に検出して読み込めるようにします。 (省略可能)
  "maxAgentIterations"?: integer // Maximum number of iterations for AgentWorkflow (1-100, default: 20) (省略可能)
  "agentTimeoutSeconds"?: integer // Timeout in seconds for AgentWorkflow execution (30-1200, default: 600) (省略可能)
  "agentTimeoutMessage"?: string // Custom user-facing message shown when AgentWorkflow times out (max 500 chars). Leave empty to use the system default. (省略可能)
  "requireTextWithFlexCards"?: boolean // When enabled, a turn that would end with only Flex Message cards and no text for the user is re-issued to the LLM once, asking it to write the text first and then send the card. Each retry incurs a second billing for the same prompt. (省略可能)
  "enableSizeBasedToolResultTruncation"?: boolean // When enabled, tool results exceeding the character threshold are truncated using head+tail strategy instead of the legacy SYSTEM_TOOLS whitelist approach. Reduces memory bloat from large tool outputs (code interpreter bash stdout, web search results, etc.). (省略可能)
  "toolResultMaxChars"?: integer // Character threshold for size-based tool result truncation (500-50000). Only effective when enable_size_based_tool_result_truncation is True. (省略可能)
  "enableVectorMemory"?: boolean // When enabled, archived messages are vectorized and processed by fact extraction for semantic retrieval (existing behavior). When disabled, archived messages are discarded and only the active chat history window is used for multi-turn context. (省略可能)
  "longTermMemoryTopK"?: integer // 長期記憶の検索ごとに取得する記憶ノード数です（ベクトル検索の similarity_top_k）。デフォルトは 10、範囲は 1–50 です。 (省略可能)
  "enableCrossConversationSearch"?: boolean // When enabled, the conversation history tools also reach this contact's other conversations in the same inbox, within the lookback window. When disabled, they only reach the current conversation. (省略可能)
  "crossConversationLookbackDays"?: integer // How far back cross-conversation search may reach, measured from each conversation's last message (1-365 days). Leave empty to fall back to 90 days. Only effective when enable_cross_conversation_search is True. (省略可能)
  "useGatewayFallback"?: boolean // When enabled, use the fallback group instead of the single LLM (省略可能)
  "gatewayFallbackGroup"?: string (uuid) // 省略可能
  "enableSearchMessagesTool"?: boolean // Allow the AI to search past messages in the current conversation. (省略可能)
  "enableGetMessageContextTool"?: boolean // Allow the AI to retrieve messages surrounding a specific message for context. (省略可能)
  "enableReadAttachmentFullTextTool"?: boolean // Allow the AI to read the full text of plain-text attachments. AGENT mode only. (省略可能)
  "enableParseAttachmentContentTool"?: boolean // Allow the AI to parse PDF, Office, audio, and other attachments. AGENT mode only. (省略可能)
  "enableListAvailableParsersTool"?: boolean // Allow the AI to list available parsers and their capabilities. AGENT mode only. (省略可能)
  "enableGetDownloadLinkTool"?: boolean // Allow the AI to generate shareable download links for produced content. AGENT mode only. (省略可能)
}

リクエスト値の例

{
  "name": "範例名稱",
  "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "instructions": "範例字串",
  "knowledgeBases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "databases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "replyMode": {},
  "template": "範例字串",
  "unanswerableTemplate": "範例字串",
  "totalWordsCount": 123,
  "outputMode": {},
  "rawOutputFormat": null,
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "tools": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "skills": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "connectors": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "agentMode": {},
  "numberOfRetrievedChunks": 123,
  "defaultLabelRelations": null,
  "useFullRetrievalRange": true,
  "enableEvaluation": true,
  "enableInlineCitations": true,
  "enableCodeInterpreter": true,
  "enableBrowserTool": true,
  "enableImageSearch": true,
  "enableClaudeStreamRetry": true,
  "customMaxLlmOutputTokens": 123,
  "voiceConfig": {
    "enabled": true,
    "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
    "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
    "sttConfig": null,
    "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
    "ttsConfig": null,
    "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
    "realtimeConfig": null,
    "realtimeInstructions": "範例字串",
    "turnHandling": null,
    "enableVoiceReply": true
  },
  "thinkingConfig": null,
  "enableToolSearching": true,
  "maxAgentIterations": 123,
  "agentTimeoutSeconds": 123,
  "agentTimeoutMessage": "範例字串",
  "requireTextWithFlexCards": true,
  "enableSizeBasedToolResultTruncation": true,
  "toolResultMaxChars": 123,
  "enableVectorMemory": true,
  "longTermMemoryTopK": 123,
  "enableCrossConversationSearch": true,
  "crossConversationLookbackDays": 123,
  "useGatewayFallback": true,
  "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
  "enableSearchMessagesTool": true,
  "enableGetMessageContextTool": true,
  "enableReadAttachmentFullTextTool": true,
  "enableParseAttachmentContentTool": true,
  "enableListAvailableParsersTool": true,
  "enableGetDownloadLinkTool": true
}

コード例

Shell/Bash

# API 呼び出し例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "範例名稱",
    "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
    "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
    "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
    "instructions": "範例字串",
    "knowledgeBases": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "databases": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "organization": "550e8400-e29b-41d4-a716-446655440000",
    "replyMode": {},
    "template": "範例字串",
    "unanswerableTemplate": "範例字串",
    "totalWordsCount": 123,
    "outputMode": {},
    "rawOutputFormat": null,
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "tools": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "skills": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "connectors": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "agentMode": {},
    "numberOfRetrievedChunks": 123,
    "defaultLabelRelations": null,
    "useFullRetrievalRange": true,
    "enableEvaluation": true,
    "enableInlineCitations": true,
    "enableCodeInterpreter": true,
    "enableBrowserTool": true,
    "enableImageSearch": true,
    "enableClaudeStreamRetry": true,
    "customMaxLlmOutputTokens": 123,
    "voiceConfig": {
      "enabled": true,
      "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
      "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
      "sttConfig": null,
      "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
      "ttsConfig": null,
      "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
      "realtimeConfig": null,
      "realtimeInstructions": "範例字串",
      "turnHandling": null,
      "enableVoiceReply": true
    },
    "thinkingConfig": null,
    "enableToolSearching": true,
    "maxAgentIterations": 123,
    "agentTimeoutSeconds": 123,
    "agentTimeoutMessage": "範例字串",
    "requireTextWithFlexCards": true,
    "enableSizeBasedToolResultTruncation": true,
    "toolResultMaxChars": 123,
    "enableVectorMemory": true,
    "longTermMemoryTopK": 123,
    "enableCrossConversationSearch": true,
    "crossConversationLookbackDays": 123,
    "useGatewayFallback": true,
    "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
    "enableSearchMessagesTool": true,
    "enableGetMessageContextTool": true,
    "enableReadAttachmentFullTextTool": true,
    "enableParseAttachmentContentTool": true,
    "enableListAvailableParsersTool": true,
    "enableGetDownloadLinkTool": true
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

const axios = require('axios');

// リクエストヘッダーを設定します
const config = {
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
};

// リクエスト内容 (payload)
const data = {
    "name": "サンプル名",
    "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
    "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
    "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
    "instructions": "サンプルテキスト列",
    "knowledgeBases": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "databases": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "organization": "550e8400-e29b-41d4-a716-446655440000",
    "replyMode": {},
    "template": "サンプルテキスト列",
    "unanswerableTemplate": "サンプルテキスト列",
    "totalWordsCount": 123,
    "outputMode": {},
    "rawOutputFormat": null,
    "groups": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "tools": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "skills": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "connectors": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    ],
    "agentMode": {},
    "numberOfRetrievedChunks": 123,
    "defaultLabelRelations": null,
    "useFullRetrievalRange": true,
    "enableEvaluation": true,
    "enableInlineCitations": true,
    "enableCodeInterpreter": true,
    "enableBrowserTool": true,
    "enableImageSearch": true,
    "enableClaudeStreamRetry": true,
    "customMaxLlmOutputTokens": 123,
    "voiceConfig": {
      "enabled": true,
      "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
      "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
      "sttConfig": null,
      "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
      "ttsConfig": null,
      "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
      "realtimeConfig": null,
      "realtimeInstructions": "サンプルテキスト列",
      "turnHandling": null,
      "enableVoiceReply": true
    },
    "thinkingConfig": null,
    "enableToolSearching": true,
    "maxAgentIterations": 123,
    "agentTimeoutSeconds": 123,
    "agentTimeoutMessage": "サンプルテキスト列",
    "requireTextWithFlexCards": true,
    "enableSizeBasedToolResultTruncation": true,
    "toolResultMaxChars": 123,
    "enableVectorMemory": true,
    "longTermMemoryTopK": 123,
    "enableCrossConversationSearch": true,
    "crossConversationLookbackDays": 123,
    "useGatewayFallback": true,
    "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
    "enableSearchMessagesTool": true,
    "enableGetMessageContextTool": true,
    "enableReadAttachmentFullTextTool": true,
    "enableParseAttachmentContentTool": true,
    "enableListAvailableParsersTool": true,
    "enableGetDownloadLinkTool": true
  };

axios.patch("https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/", data, config)
  .then(response => {
    console.log('レスポンスを通常に取得しました:');
    console.log(response.data);
  })
  .catch(error => {
    console.error('リクエストでエラーが発生しました:');
    console.error(error.response?.data || error.message);
  });

Python

import requests

url = "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY",
    "Content-Type": "application/json"
}

# リクエスト内容 (payload)
data = {
      "name": "サンプル名",
      "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
      "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
      "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
      "instructions": "サンプルテキスト列",
      "knowledgeBases": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "databases": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "organization": "550e8400-e29b-41d4-a716-446655440000",
      "replyMode": {},
      "template": "サンプルテキスト列",
      "unanswerableTemplate": "サンプルテキスト列",
      "totalWordsCount": 123,
      "outputMode": {},
      "rawOutputFormat": null,
      "groups": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "tools": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "skills": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "connectors": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "agentMode": {},
      "numberOfRetrievedChunks": 123,
      "defaultLabelRelations": null,
      "useFullRetrievalRange": true,
      "enableEvaluation": true,
      "enableInlineCitations": true,
      "enableCodeInterpreter": true,
      "enableBrowserTool": true,
      "enableImageSearch": true,
      "enableClaudeStreamRetry": true,
      "customMaxLlmOutputTokens": 123,
      "voiceConfig": {
        "enabled": true,
        "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
        "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
        "sttConfig": null,
        "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
        "ttsConfig": null,
        "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
        "realtimeConfig": null,
        "realtimeInstructions": "サンプルテキスト列",
        "turnHandling": null,
        "enableVoiceReply": true
      },
      "thinkingConfig": null,
      "enableToolSearching": true,
      "maxAgentIterations": 123,
      "agentTimeoutSeconds": 123,
      "agentTimeoutMessage": "サンプルテキスト列",
      "requireTextWithFlexCards": true,
      "enableSizeBasedToolResultTruncation": true,
      "toolResultMaxChars": 123,
      "enableVectorMemory": true,
      "longTermMemoryTopK": 123,
      "enableCrossConversationSearch": true,
      "crossConversationLookbackDays": 123,
      "useGatewayFallback": true,
      "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
      "enableSearchMessagesTool": true,
      "enableGetMessageContextTool": true,
      "enableReadAttachmentFullTextTool": true,
      "enableParseAttachmentContentTool": true,
      "enableListAvailableParsersTool": true,
      "enableGetDownloadLinkTool": true
    }

response = requests.patch(url, json=data, headers=headers)
try:
    print("レスポンスを通常に取得しました:")
    print(response.json())
except Exception as e:
    print("リクエストでエラーが発生しました:", e)

PHP

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

try {
    $response = $client->patch("https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/", [
        'headers' => [
            'Authorization' => 'Api-Key YOUR_API_KEY',
            'Content-Type' => 'application/json'
        ],
        'json' => {
            "name": "サンプル名",
            "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
            "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
            "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
            "instructions": "サンプルテキスト列",
            "knowledgeBases": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "databases": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "organization": "550e8400-e29b-41d4-a716-446655440000",
            "replyMode": {},
            "template": "サンプルテキスト列",
            "unanswerableTemplate": "サンプルテキスト列",
            "totalWordsCount": 123,
            "outputMode": {},
            "rawOutputFormat": null,
            "groups": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "tools": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "skills": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "connectors": [
                {
                    "id": "550e8400-e29b-41d4-a716-446655440000"
                }
            ],
            "agentMode": {},
            "numberOfRetrievedChunks": 123,
            "defaultLabelRelations": null,
            "useFullRetrievalRange": true,
            "enableEvaluation": true,
            "enableInlineCitations": true,
            "enableCodeInterpreter": true,
            "enableBrowserTool": true,
            "enableImageSearch": true,
            "enableClaudeStreamRetry": true,
            "customMaxLlmOutputTokens": 123,
            "voiceConfig": {
                "enabled": true,
                "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
                "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
                "sttConfig": null,
                "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
                "ttsConfig": null,
                "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
                "realtimeConfig": null,
                "realtimeInstructions": "サンプルテキスト列",
                "turnHandling": null,
                "enableVoiceReply": true
            },
            "thinkingConfig": null,
            "enableToolSearching": true,
            "maxAgentIterations": 123,
            "agentTimeoutSeconds": 123,
            "agentTimeoutMessage": "サンプルテキスト列",
            "requireTextWithFlexCards": true,
            "enableSizeBasedToolResultTruncation": true,
            "toolResultMaxChars": 123,
            "enableVectorMemory": true,
            "longTermMemoryTopK": 123,
            "enableCrossConversationSearch": true,
            "crossConversationLookbackDays": 123,
            "useGatewayFallback": true,
            "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
            "enableSearchMessagesTool": true,
            "enableGetMessageContextTool": true,
            "enableReadAttachmentFullTextTool": true,
            "enableParseAttachmentContentTool": true,
            "enableListAvailableParsersTool": true,
            "enableGetDownloadLinkTool": true
        }
    ]);
    
    $data = json_decode($response->getBody(), true);
    echo "レスポンスを通常に取得しました:\n";
    print_r($data);
} catch (Exception $e) {
    echo 'リクエストでエラーが発生しました: ' . $e->getMessage();
}
?>

レスポンス内容

ステータスコード: 200

レスポンス構造の例

{
  "id": string (uuid)
  "name": string // Chatbot name. In Agent mode it carries semantic meaning; in other modes it only distinguishes chatbots.
  "largeLanguageModel": string (uuid) // チャットボットが回答の生成に使用する大規模言語モデルです（組織が独自に作成した AI Gateway モデルを含みます）。
  "llm":  // 関連付けられたモデルの id、name、廃止情報です。FK を直接参照するため、組織がそのモデルを無効にしていても返されます。
  {
    "id": string (uuid)
    "name": string
    "retiresAt": string (date) // プロバイダーが定めた廃止日です。この日を過ぎると、毎日の定期処理でアシスタントを replacement に切り替え、このモデルを無効にします。null は廃止予定がないことを示します。
    "replacement":  // 廃止後に引き継ぐモデル（id と name）です。null は未指定を示し、廃止日に自動移行は行われません。
    {
      "id": string (uuid)
      "name": string
    }
  }
  "embeddingModel"?: string (uuid) // テキストのベクトル化に使用する埋め込みモデルです。任意項目です。 (任意)
  "rerankerModel"?: string (uuid) // 再ランキングに使用するモデルです。任意項目です。 (任意)
  "instructions"?: string // Role instructions describing the chatbot's role and behavior. (任意)
  "knowledgeBases"?: [ // チャットボットがアクセスできるナレッジベースの一覧です。 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "databases"?: [ // チャットボットがアクセスできる SQL データベースの一覧です（Text-to-SQL 機能で使用します）。 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "updatedAt": string (timestamp)
  "organization"?: string (uuid) // チャットボットが所属する組織です。空の場合は個人用チャットボットです。 (任意)
  "replyMode"?:  // 応答モードです。通常の応答またはストリーミング応答を指定します。

* `normal` - 通常
* `template` - テンプレート
* `hybrid` - ハイブリッド
* `agent` - エージェント (任意)
  {
  }
  "template"?: string // Template used by Template and Hybrid modes. (任意)
  "unanswerableTemplate"?: string // Template used by Template and Hybrid modes when the question cannot be answered. (任意)
  "totalWordsCount"?: integer (int64) // Accumulated total word count used. (任意)
  "outputMode"?:  // 出力モードです。テキスト、表、またはカスタム形式を指定します。

* `text` - テキスト
* `json_schema` - JSON Schema (任意)
  {
  }
  "rawOutputFormat"?: object // カスタム出力形式の JSON 構造定義です。 (任意)
  "groups"?: [ // チャットボットがアクセスできるグループの一覧です。 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "tools"?: [ // チャットボットが使用できるツールの一覧です。 (任意)
    {
      "id": string (uuid)
      "name": string
      "description": string
      "displayName": string
      "toolType": string
    }
  ]
  "skills"?: [ // チャットボットに関連付けられたスキルの一覧です。 (任意)
    {
      "id": string (uuid)
      "name": string
      "description": string
    }
  ]
  "connectors"?: [ // Connectors associated with this chatbot, gating per-contact OAuth authorization (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "agentMode"?:  // エージェントモードです。通常、SQL、またはワークフローモードを指定します。

* `normal` - 通常
* `canvas` - キャンバス
* `team` - チーム (任意)
  {
  }
  "numberOfRetrievedChunks"?: integer // 取得する参考資料チャンクの数です。デフォルトは 12、最小値は 1 です。 (任意)
  "defaultLabelRelations"?: object // アシスタント単位のデフォルトのナレッジベースラベルフィルター条件です。形式は query_metadata.label_relations と同じです。null はフィルターしないことを示します。呼び出し元が query_metadata を指定しない場合にのみ、最も優先度の低いフォールバックとして適用されます。 (任意)
  "useFullRetrievalRange"?: boolean // 有効にすると、LLM の top_k による切り詰めを無視し、reranker の結果をすべて返します。 (任意)
  "enableEvaluation"?: boolean // 任意
  "enableInlineCitations"?: boolean // Enables inline citations, inserting citation markers such as [1][2] into responses. (任意)
  "enableCodeInterpreter"?: boolean // When enabled, provides the Code Interpreter tool to run code in an isolated container. (任意)
  "enableBrowserTool"?: boolean // Enable browser automation tool for web tasks (任意)
  "enableImageSearch"?: boolean // Provide the image_search tool when any attached knowledge base uses a multimodal embedding model. Disable to remove the tool entirely. (任意)
  "enableClaudeStreamRetry"?: boolean // When a Claude streaming call stalls (first-chunk or mid-stream), abort and re-issue the call once in non-streaming mode. Mid-stream retries send a reset signal so the client discards any partial output already rendered. Each retry incurs a second billing for the same prompt. (任意)
  "customMaxLlmOutputTokens"?: integer // LLM の最大出力トークン数をカスタマイズします。最小値は 512 です。 (任意)
  "voiceConfig"?: { // 任意
  {
    "enabled"?: boolean // Whether this chatbot can be used as a voice agent. Checked by every conversation platform (WebChat, SIP phone, admin/marketplace voice test) instead of a per-platform toggle. (任意)
    "voiceAgentType"?: string (uuid) // Voice agent mode type. (任意)
    "sttProvider"?: string (uuid) // Speech-to-Text service provider. (任意)
    "sttConfig"?: object // STT configuration parameters (JSON). (任意)
    "ttsProvider"?: string (uuid) // Text-to-Speech service provider. (任意)
    "ttsConfig"?: object // TTS configuration parameters (JSON). (任意)
    "realtimeProvider"?: string (uuid) // Realtime end-to-end voice model provider. (任意)
    "realtimeConfig"?: object // Realtime configuration parameters (JSON). (任意)
    "realtimeInstructions"?: string // Prompt dedicated to the realtime voice session; falls back to chatbot instructions when empty (任意)
    "turnHandling"?: object // Turn-taking and interruption settings for the voice agent. (任意)
    "enableVoiceReply"?: boolean // When disabled, the voice agent replies in text only and does not speak (任意)
  }
  }
  "thinkingConfig"?: object // 推論レベルです。null（モデルのデフォルト）または {"reasoning_effort": "off|minimal|low|medium|high|xhigh|max"} を指定します。 (任意)
  "enableToolSearching"?: boolean // 動的ツール検索を有効にし、エージェントが tool_searching_tool を通じてツールを動的に検出して読み込めるようにします。 (任意)
  "maxAgentIterations"?: integer // Maximum number of iterations for AgentWorkflow (1-100, default: 20) (任意)
  "agentTimeoutSeconds"?: integer // Timeout in seconds for AgentWorkflow execution (30-1200, default: 600) (任意)
  "agentTimeoutMessage"?: string // Custom user-facing message shown when AgentWorkflow times out (max 500 chars). Leave empty to use the system default. (任意)
  "requireTextWithFlexCards"?: boolean // When enabled, a turn that would end with only Flex Message cards and no text for the user is re-issued to the LLM once, asking it to write the text first and then send the card. Each retry incurs a second billing for the same prompt. (任意)
  "isMultimodalLlm": boolean // Whether the chatbot LLM supports multimodal (read-only)
  "enableSizeBasedToolResultTruncation"?: boolean // When enabled, tool results exceeding the character threshold are truncated using head+tail strategy instead of the legacy SYSTEM_TOOLS whitelist approach. Reduces memory bloat from large tool outputs (code interpreter bash stdout, web search results, etc.). (任意)
  "toolResultMaxChars"?: integer // Character threshold for size-based tool result truncation (500-50000). Only effective when enable_size_based_tool_result_truncation is True. (任意)
  "enableVectorMemory"?: boolean // When enabled, archived messages are vectorized and processed by fact extraction for semantic retrieval (existing behavior). When disabled, archived messages are discarded and only the active chat history window is used for multi-turn context. (任意)
  "longTermMemoryTopK"?: integer // 長期記憶の検索ごとに取得する記憶ノード数です（ベクトル検索の similarity_top_k）。デフォルトは 10、範囲は 1–50 です。 (任意)
  "enableCrossConversationSearch"?: boolean // When enabled, the conversation history tools also reach this contact's other conversations in the same inbox, within the lookback window. When disabled, they only reach the current conversation. (任意)
  "crossConversationLookbackDays"?: integer // How far back cross-conversation search may reach, measured from each conversation's last message (1-365 days). Leave empty to fall back to 90 days. Only effective when enable_cross_conversation_search is True. (任意)
  "useGatewayFallback"?: boolean // When enabled, use the fallback group instead of the single LLM (任意)
  "gatewayFallbackGroup"?: string (uuid) // 任意
  "enableSearchMessagesTool"?: boolean // Allow the AI to search past messages in the current conversation. (任意)
  "enableGetMessageContextTool"?: boolean // Allow the AI to retrieve messages surrounding a specific message for context. (任意)
  "enableReadAttachmentFullTextTool"?: boolean // Allow the AI to read the full text of plain-text attachments. AGENT mode only. (任意)
  "enableParseAttachmentContentTool"?: boolean // Allow the AI to parse PDF, Office, audio, and other attachments. AGENT mode only. (任意)
  "enableListAvailableParsersTool"?: boolean // Allow the AI to list available parsers and their capabilities. AGENT mode only. (任意)
  "enableGetDownloadLinkTool"?: boolean // Allow the AI to generate shareable download links for produced content. AGENT mode only. (任意)
  "isLocked": boolean // Locked instance: config follows the official version; only the dedicated KB can be modified
  "sourceBuildInAgent": string (uuid) // Points to the official Build-in Agent blueprint when instantiated by a rental
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
}

レスポンス値の例

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "レスポンステキスト列",
  "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
  "llm": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "レスポンステキスト列",
    "retiresAt": "レスポンステキスト列",
    "replacement": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンステキスト列"
    }
  },
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "instructions": "レスポンステキスト列",
  "knowledgeBases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンステキスト列"
    }
  ],
  "databases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンステキスト列"
    }
  ],
  "updatedAt": "レスポンステキスト列",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "replyMode": {},
  "template": "レスポンステキスト列",
  "unanswerableTemplate": "レスポンステキスト列",
  "totalWordsCount": 456,
  "outputMode": {},
  "rawOutputFormat": null,
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンステキスト列"
    }
  ],
  "tools": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンステキスト列",
      "description": "レスポンステキスト列",
      "displayName": "レスポンステキスト列",
      "toolType": "レスポンステキスト列"
    }
  ],
  "skills": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンステキスト列",
      "description": "レスポンステキスト列"
    }
  ],
  "connectors": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "レスポンステキスト列"
    }
  ],
  "agentMode": {},
  "numberOfRetrievedChunks": 456,
  "defaultLabelRelations": null,
  "useFullRetrievalRange": false,
  "enableEvaluation": false,
  "enableInlineCitations": false,
  "enableCodeInterpreter": false,
  "enableBrowserTool": false,
  "enableImageSearch": false,
  "enableClaudeStreamRetry": false,
  "customMaxLlmOutputTokens": 456,
  "voiceConfig": {
    "enabled": false,
    "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
    "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
    "sttConfig": null,
    "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
    "ttsConfig": null,
    "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
    "realtimeConfig": null,
    "realtimeInstructions": "レスポンステキスト列",
    "turnHandling": null,
    "enableVoiceReply": false
  },
  "thinkingConfig": null,
  "enableToolSearching": false,
  "maxAgentIterations": 456,
  "agentTimeoutSeconds": 456,
  "agentTimeoutMessage": "レスポンステキスト列",
  "requireTextWithFlexCards": false,
  "isMultimodalLlm": false,
  "enableSizeBasedToolResultTruncation": false,
  "toolResultMaxChars": 456,
  "enableVectorMemory": false,
  "longTermMemoryTopK": 456,
  "enableCrossConversationSearch": false,
  "crossConversationLookbackDays": 456,
  "useGatewayFallback": false,
  "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
  "enableSearchMessagesTool": false,
  "enableGetMessageContextTool": false,
  "enableReadAttachmentFullTextTool": false,
  "enableParseAttachmentContentTool": false,
  "enableListAvailableParsersTool": false,
  "enableGetDownloadLinkTool": false,
  "isLocked": false,
  "sourceBuildInAgent": "550e8400-e29b-41d4-a716-446655440000",
  "canUpdate": false,
  "canDelete": false
}

---

AI アシスタントの削除

DELETE /api/v1/chatbots/{id}/

パラメーター

パラメーター名	必須	型	説明
id	✅	string

コード例

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X DELETE "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/" \
  -H "Authorization: Api-Key YOUR_API_KEY"

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

const axios = require('axios');

// リクエストヘッダーを設定します
const config = {
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY'
  }
};

// リクエスト内容 (payload)
const data = null;

axios.delete("https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/", data, config)
  .then(response => {
    console.log('応答を通常に取得しました:');
    console.log(response.data);
  })
  .catch(error => {
    console.error('リクエストでエラーが発生しました:');
    console.error(error.response?.data || error.message);
  });

Python

import requests

url = "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY"
}


response = requests.delete(url, headers=headers)
try:
    print("応答を通常に取得しました:")
    print(response.json())
except Exception as e:
    print("リクエストでエラーが発生しました:", e)

PHP

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

try {
    $response = $client->delete("https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/", [
        'headers' => [
            'Authorization' => 'Api-Key YOUR_API_KEY'
        ]
    ]);
    
    $data = json_decode($response->getBody(), true);
    echo "応答を通常に取得しました:\n";
    print_r($data);
} catch (Exception $e) {
    echo 'リクエストでエラーが発生しました: ' . $e->getMessage();
}
?>

応答内容

ステータスコード	説明
204	No response body

---

AI アシスタントの複製

POST /api/v1/chatbots/{id}/duplicate/

パラメーター

パラメーター名	必須	型	説明
id	✅	string

リクエスト内容

リクエストパラメーター

フィールド	型	必須	説明
name	string	はい

リクエスト構造の例

{
  "name": string
}

リクエスト値の例

{
  "name": "サンプル名"
}

コード例

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X POST "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/duplicate/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "サンプル名"
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

const axios = require('axios');

// リクエストヘッダーを設定します
const config = {
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
};

// リクエスト内容 (payload)
const data = {
    "name": "サンプル名"
  };

axios.post("https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/duplicate/", data, config)
  .then(response => {
    console.log('応答を通常に取得しました:');
    console.log(response.data);
  })
  .catch(error => {
    console.error('リクエストでエラーが発生しました:');
    console.error(error.response?.data || error.message);
  });

Python

import requests

url = "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/duplicate/"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY",
    "Content-Type": "application/json"
}

# リクエスト内容 (payload)
data = {
      "name": "サンプル名"
    }

response = requests.post(url, json=data, headers=headers)
try:
    print("応答を通常に取得しました:")
    print(response.json())
except Exception as e:
    print("リクエストでエラーが発生しました:", e)

PHP

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

try {
    $response = $client->post("https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/duplicate/", [
        'headers' => [
            'Authorization' => 'Api-Key YOUR_API_KEY',
            'Content-Type' => 'application/json'
        ],
        'json' => {
            "name": "サンプル名"
        }
    ]);
    
    $data = json_decode($response->getBody(), true);
    echo "応答を通常に取得しました:\n";
    print_r($data);
} catch (Exception $e) {
    echo 'リクエストでエラーが発生しました: ' . $e->getMessage();
}
?>

応答内容

ステータスコード: 201

応答構造の例

{
  "id": string (uuid)
  "name": string // Chatbot name. In Agent mode it carries semantic meaning; in other modes it only distinguishes chatbots.
  "largeLanguageModel": string (uuid) // チャットボットが回答の生成に使用する大規模言語モデルです（組織が独自に構築した AI Gateway モデルを含みます）。
  "llm":  // 関連付けられたモデルの id、name、廃止情報です。FK から直接取得するため、組織がモデルを無効にしていても返されます。
  {
    "id": string (uuid)
    "name": string
    "retiresAt": string (date) // プロバイダーによる廃止日です。到達すると日次のスケジュール処理がアシスタントを replacement に切り替え、このモデルを無効にします。null は廃止予定がないことを示します。
    "replacement":  // 廃止後の代替モデルです（id と name）。null は未指定を示し、廃止日に自動移行されません。
    {
      "id": string (uuid)
      "name": string
    }
  }
  "embeddingModel"?: string (uuid) // テキストのベクトル化に使用する埋め込みモデルです。省略できます。 (任意)
  "rerankerModel"?: string (uuid) // 再ランキングに使用するモデルです。省略できます。 (任意)
  "instructions"?: string // Role instructions describing the chatbot's role and behavior. (任意)
  "knowledgeBases"?: [ // チャットボットがアクセスできるナレッジベースの一覧です。 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "databases"?: [ // チャットボットがアクセスできる SQL データベースの一覧です（Text-to-SQL 用）。 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "updatedAt": string (timestamp)
  "organization"?: string (uuid) // チャットボットが所属する組織です。空の場合は個人用チャットボットです。 (任意)
  "replyMode"?:  // 応答モードです。通常応答またはストリーミング応答を指定します。

* `normal` - 通常
* `template` - テンプレート
* `hybrid` - ハイブリッド
* `agent` - エージェント (任意)
  {
  }
  "template"?: string // Template used by Template and Hybrid modes. (任意)
  "unanswerableTemplate"?: string // Template used by Template and Hybrid modes when the question cannot be answered. (任意)
  "totalWordsCount"?: integer (int64) // Accumulated total word count used. (任意)
  "outputMode"?:  // 出力モードです。テキスト、表、カスタム形式を指定します。

* `text` - テキスト
* `json_schema` - JSON Schema (任意)
  {
  }
  "rawOutputFormat"?: object // カスタム出力形式の JSON 構造定義です。 (任意)
  "groups"?: [ // チャットボットがアクセスできるグループの一覧です。 (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "tools"?: [ // チャットボットが使用できるツールの一覧です。 (任意)
    {
      "id": string (uuid)
      "name": string
      "description": string
      "displayName": string
      "toolType": string
    }
  ]
  "skills"?: [ // チャットボットに関連付けられたスキルの一覧です。 (任意)
    {
      "id": string (uuid)
      "name": string
      "description": string
    }
  ]
  "connectors"?: [ // Connectors associated with this chatbot, gating per-contact OAuth authorization (任意)
    {
      "id": string (uuid)
      "name": string
    }
  ]
  "agentMode"?:  // エージェントモードです。通常、SQL、ワークフローモードを指定します。

* `normal` - 通常
* `canvas` - キャンバス
* `team` - チーム (任意)
  {
  }
  "numberOfRetrievedChunks"?: integer // 取得する参照チャンク数です。デフォルトは 12、最小値は 1 です。 (任意)
  "defaultLabelRelations"?: object // アシスタント単位のデフォルトのナレッジベースラベルフィルターです。形式は query_metadata.label_relations と同じで、null はフィルタリングなしを示します。呼び出し元が query_metadata を指定しない場合にのみ、最も優先度の低いフォールバックとして適用されます。 (任意)
  "useFullRetrievalRange"?: boolean // 有効にすると LLM の top_k による切り詰めを無視し、再ランキングの結果をすべて返します。 (任意)
  "enableEvaluation"?: boolean // 任意
  "enableInlineCitations"?: boolean // Enables inline citations, inserting citation markers such as [1][2] into responses. (任意)
  "enableCodeInterpreter"?: boolean // When enabled, provides the Code Interpreter tool to run code in an isolated container. (任意)
  "enableBrowserTool"?: boolean // Enable browser automation tool for web tasks (任意)
  "enableImageSearch"?: boolean // Provide the image_search tool when any attached knowledge base uses a multimodal embedding model. Disable to remove the tool entirely. (任意)
  "enableClaudeStreamRetry"?: boolean // When a Claude streaming call stalls (first-chunk or mid-stream), abort and re-issue the call once in non-streaming mode. Mid-stream retries send a reset signal so the client discards any partial output already rendered. Each retry incurs a second billing for the same prompt. (任意)
  "customMaxLlmOutputTokens"?: integer // LLM の最大出力トークン数を指定します。最小値は 512 です。 (任意)
  "voiceConfig"?: { // 任意
  {
    "enabled"?: boolean // Whether this chatbot can be used as a voice agent. Checked by every conversation platform (WebChat, SIP phone, admin/marketplace voice test) instead of a per-platform toggle. (任意)
    "voiceAgentType"?: string (uuid) // Voice agent mode type. (任意)
    "sttProvider"?: string (uuid) // Speech-to-Text service provider. (任意)
    "sttConfig"?: object // STT configuration parameters (JSON). (任意)
    "ttsProvider"?: string (uuid) // Text-to-Speech service provider. (任意)
    "ttsConfig"?: object // TTS configuration parameters (JSON). (任意)
    "realtimeProvider"?: string (uuid) // Realtime end-to-end voice model provider. (任意)
    "realtimeConfig"?: object // Realtime configuration parameters (JSON). (任意)
    "realtimeInstructions"?: string // Prompt dedicated to the realtime voice session; falls back to chatbot instructions when empty (任意)
    "turnHandling"?: object // Turn-taking and interruption settings for the voice agent. (任意)
    "enableVoiceReply"?: boolean // When disabled, the voice agent replies in text only and does not speak (任意)
  }
  }
  "thinkingConfig"?: object // 推論レベルです。null（モデルのデフォルト）または {"reasoning_effort": "off|minimal|low|medium|high|xhigh|max"} (任意)
  "enableToolSearching"?: boolean // 動的ツール検索を有効にし、エージェントが tool_searching_tool を通じてツールを動的に検出して読み込めるようにします。 (任意)
  "maxAgentIterations"?: integer // Maximum number of iterations for AgentWorkflow (1-100, default: 20) (任意)
  "agentTimeoutSeconds"?: integer // Timeout in seconds for AgentWorkflow execution (30-1200, default: 600) (任意)
  "agentTimeoutMessage"?: string // Custom user-facing message shown when AgentWorkflow times out (max 500 chars). Leave empty to use the system default. (任意)
  "requireTextWithFlexCards"?: boolean // When enabled, a turn that would end with only Flex Message cards and no text for the user is re-issued to the LLM once, asking it to write the text first and then send the card. Each retry incurs a second billing for the same prompt. (任意)
  "isMultimodalLlm": boolean // Whether the chatbot LLM supports multimodal (read-only)
  "enableSizeBasedToolResultTruncation"?: boolean // When enabled, tool results exceeding the character threshold are truncated using head+tail strategy instead of the legacy SYSTEM_TOOLS whitelist approach. Reduces memory bloat from large tool outputs (code interpreter bash stdout, web search results, etc.). (任意)
  "toolResultMaxChars"?: integer // Character threshold for size-based tool result truncation (500-50000). Only effective when enable_size_based_tool_result_truncation is True. (任意)
  "enableVectorMemory"?: boolean // When enabled, archived messages are vectorized and processed by fact extraction for semantic retrieval (existing behavior). When disabled, archived messages are discarded and only the active chat history window is used for multi-turn context. (任意)
  "longTermMemoryTopK"?: integer // 長期メモリの検索ごとに取得するメモリノード数です（ベクトル検索の similarity_top_k）。デフォルトは 10、範囲は 1–50 です。 (任意)
  "enableCrossConversationSearch"?: boolean // When enabled, the conversation history tools also reach this contact's other conversations in the same inbox, within the lookback window. When disabled, they only reach the current conversation. (任意)
  "crossConversationLookbackDays"?: integer // How far back cross-conversation search may reach, measured from each conversation's last message (1-365 days). Leave empty to fall back to 90 days. Only effective when enable_cross_conversation_search is True. (任意)
  "useGatewayFallback"?: boolean // When enabled, use the fallback group instead of the single LLM (任意)
  "gatewayFallbackGroup"?: string (uuid) // 任意
  "enableSearchMessagesTool"?: boolean // Allow the AI to search past messages in the current conversation. (任意)
  "enableGetMessageContextTool"?: boolean // Allow the AI to retrieve messages surrounding a specific message for context. (任意)
  "enableReadAttachmentFullTextTool"?: boolean // Allow the AI to read the full text of plain-text attachments. AGENT mode only. (任意)
  "enableParseAttachmentContentTool"?: boolean // Allow the AI to parse PDF, Office, audio, and other attachments. AGENT mode only. (任意)
  "enableListAvailableParsersTool"?: boolean // Allow the AI to list available parsers and their capabilities. AGENT mode only. (任意)
  "enableGetDownloadLinkTool"?: boolean // Allow the AI to generate shareable download links for produced content. AGENT mode only. (任意)
  "isLocked": boolean // Locked instance: config follows the official version; only the dedicated KB can be modified
  "sourceBuildInAgent": string (uuid) // Points to the official Build-in Agent blueprint when instantiated by a rental
  "canUpdate": boolean // Return whether the current user can update this resource.
  "canDelete": boolean // Return whether the current user can delete this resource.
}

応答値の例

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "応答テキスト列",
  "largeLanguageModel": "550e8400-e29b-41d4-a716-446655440000",
  "llm": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "応答テキスト列",
    "retiresAt": "応答テキスト列",
    "replacement": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "応答テキスト列"
    }
  },
  "embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
  "rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
  "instructions": "応答テキスト列",
  "knowledgeBases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "応答テキスト列"
    }
  ],
  "databases": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "応答テキスト列"
    }
  ],
  "updatedAt": "応答テキスト列",
  "organization": "550e8400-e29b-41d4-a716-446655440000",
  "replyMode": {},
  "template": "応答テキスト列",
  "unanswerableTemplate": "応答テキスト列",
  "totalWordsCount": 456,
  "outputMode": {},
  "rawOutputFormat": null,
  "groups": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "応答テキスト列"
    }
  ],
  "tools": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "応答テキスト列",
      "description": "応答テキスト列",
      "displayName": "応答テキスト列",
      "toolType": "応答テキスト列"
    }
  ],
  "skills": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "応答テキスト列",
      "description": "応答テキスト列"
    }
  ],
  "connectors": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "応答テキスト列"
    }
  ],
  "agentMode": {},
  "numberOfRetrievedChunks": 456,
  "defaultLabelRelations": null,
  "useFullRetrievalRange": false,
  "enableEvaluation": false,
  "enableInlineCitations": false,
  "enableCodeInterpreter": false,
  "enableBrowserTool": false,
  "enableImageSearch": false,
  "enableClaudeStreamRetry": false,
  "customMaxLlmOutputTokens": 456,
  "voiceConfig": {
    "enabled": false,
    "voiceAgentType": "550e8400-e29b-41d4-a716-446655440000",
    "sttProvider": "550e8400-e29b-41d4-a716-446655440000",
    "sttConfig": null,
    "ttsProvider": "550e8400-e29b-41d4-a716-446655440000",
    "ttsConfig": null,
    "realtimeProvider": "550e8400-e29b-41d4-a716-446655440000",
    "realtimeConfig": null,
    "realtimeInstructions": "応答テキスト列",
    "turnHandling": null,
    "enableVoiceReply": false
  },
  "thinkingConfig": null,
  "enableToolSearching": false,
  "maxAgentIterations": 456,
  "agentTimeoutSeconds": 456,
  "agentTimeoutMessage": "応答テキスト列",
  "requireTextWithFlexCards": false,
  "isMultimodalLlm": false,
  "enableSizeBasedToolResultTruncation": false,
  "toolResultMaxChars": 456,
  "enableVectorMemory": false,
  "longTermMemoryTopK": 456,
  "enableCrossConversationSearch": false,
  "crossConversationLookbackDays": 456,
  "useGatewayFallback": false,
  "gatewayFallbackGroup": "550e8400-e29b-41d4-a716-446655440000",
  "enableSearchMessagesTool": false,
  "enableGetMessageContextTool": false,
  "enableReadAttachmentFullTextTool": false,
  "enableParseAttachmentContentTool": false,
  "enableListAvailableParsersTool": false,
  "enableGetDownloadLinkTool": false,
  "isLocked": false,
  "sourceBuildInAgent": "550e8400-e29b-41d4-a716-446655440000",
  "canUpdate": false,
  "canDelete": false
}

---

評価機能の有効化または無効化

PATCH /api/v1/chatbots/{id}/enable-evaluation/

パラメーター

パラメーター名	必須	型	説明
id	✅	string

リクエスト内容

リクエストパラメーター

フィールド	型	必須	説明
enableEvaluation	boolean	いいえ

リクエスト構造の例

{
  "enableEvaluation"?: boolean // 任意
}

リクエスト値の例

{
  "enableEvaluation": true
}

コード例

Shell/Bash

# API 呼び出しの例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/enable-evaluation/" \
  -H "Authorization: Api-Key YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "enableEvaluation": true
  }'

# 実行前に YOUR_API_KEY を置き換え、リクエストデータを確認してください。

JavaScript

const axios = require('axios');

// リクエストヘッダーを設定します
const config = {
  headers: {
    'Authorization': 'Api-Key YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
};

// リクエスト内容 (payload)
const data = {
    "enableEvaluation": true
  };

axios.patch("https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/enable-evaluation/", data, config)
  .then(response => {
    console.log('応答を通常に取得しました:');
    console.log(response.data);
  })
  .catch(error => {
    console.error('リクエストでエラーが発生しました:');
    console.error(error.response?.data || error.message);
  });

Python

import requests

url = "https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/enable-evaluation/"
headers = {
    "Authorization": "Api-Key YOUR_API_KEY",
    "Content-Type": "application/json"
}

# リクエスト内容 (payload)
data = {
      "enableEvaluation": true
    }

response = requests.patch(url, json=data, headers=headers)
try:
    print("応答を通常に取得しました:")
    print(response.json())
except Exception as e:
    print("リクエストでエラーが発生しました:", e)

PHP

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

try {
    $response = $client->patch("https://api.maiagent.ai/api/v1/chatbots/550e8400-e29b-41d4-a716-446655440000/enable-evaluation/", [
        'headers' => [
            'Authorization' => 'Api-Key YOUR_API_KEY',
            'Content-Type' => 'application/json'
        ],
        'json' => {
            "enableEvaluation": true
        }
    ]);
    
    $data = json_decode($response->getBody(), true);
    echo "応答を通常に取得しました:\n";
    print_r($data);
} catch (Exception $e) {
    echo 'リクエストでエラーが発生しました: ' . $e->getMessage();
}
?>

応答内容

ステータスコード: 200

応答構造の例

{
  "enableEvaluation"?: boolean // 任意
}

応答値の例

{
  "enableEvaluation": false
}

---