For the complete documentation index, see llms.txt. This page is also available as Markdown.

Conversations

Folder related APIs

利用履歴の会話を取得

get
/webapi/v2/conversations

会話リストを取得します。会話はデフォルトで最後のチャット時間を基準に降順で並べ替えられています。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Query parameters
llmAppIdstring · nullableOptional
categoryIdstring · nullableOptional
startedAtnumber · nullableOptional

指定された値以降の最後のチャット時間を検索

endAtnumber · nullableOptional

指定された値以前の最後のチャット時間を検索

firstChatStartedAtnumber · nullableOptional

指定された値以降の最初のチャット時間を検索

firstChatEndAtnumber · nullableOptional

指定された値以前の最初のチャット時間を検索

searchTermstring · nullableOptional
cursorstring · nullableOptional
variablesstring[] · nullableOptional
pageSizeinteger · min: 1 · max: 50OptionalDefault: 50
activeOnlybooleanOptionalDefault: false
backgroundRunningboolean · nullableOptional
orderstring · enumOptionalPossible values:
Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses
200

成功

application/json
cursorstring · nullableRequired

ページネーション用のカーソル

get/webapi/v2/conversations

会話を更新する

post
/webapi/v2/conversations/bulk_update

Update state, assignee, title, or categories for multiple conversations at once. Filter by conversation IDs, user IDs, app IDs, or category IDs.

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body
userIdsstring[] · nullableOptional

フィルタリング対象のユーザーID

llmAppIdsstring[] · nullableOptional

フィルタリング対象のllmアプリID

categoryIdsstring[] · nullableOptional

フィルタリング対象のの会話カテゴリID

conversationIdsstring[] · nullableOptional

フィルタリング対象の会話ID

Responses
200

正常に更新されました。

No content

post/webapi/v2/conversations/bulk_update

No content

会話IDから会話内容を取得

get
/webapi/v2/conversations/{conversation_id}

指定の会話IDに紐づく会話内容を取得します。 取得できるメッセージは、最新の20件までです。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
conversation_idstringRequired
Query parameters
variablesstring[] · nullableOptional

取得したい会話の ID

Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses
200

正常に取得しました。

application/json
idstringRequired

会話ID

titlestringRequired

会話のタイトル

createdAtnumberRequired

会話作成時間

lastChatTimenumber · nullableRequired

最終チャット時間

isEndbooleanRequired

会話の終了状況

categoriesstring[] · nullableRequired

会話カテゴリー

memostring · nullableRequired

会話メモ

chatCountintegerRequired

合計会話数

get/webapi/v2/conversations/{conversation_id}

会話を設定

patch
/webapi/v2/conversations/{conversation_id}

Partially update a conversation's state, assignee, title, or categories.

Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
conversation_idstringRequired
Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body
statestring · enum · nullableOptional

会話の状態

Possible values:
assigneestring · nullableOptional

会話の担当者

categoryIdsstring[] · nullableOptional

カテゴリのID

titlestring · nullableOptional

会話のタイトル

Responses
200

正常に設定されました。

application/json
idstringRequired

会話ID

titlestringRequired

会話のタイトル

createdAtnumberRequired

会話作成時間

lastChatTimenumber · nullableRequired

最終チャット時間

isEndbooleanRequired

会話の終了状況

categoriesstring[] · nullableRequired

会話カテゴリー

memostring · nullableRequired

会話メモ

chatCountintegerRequired

合計会話数

patch/webapi/v2/conversations/{conversation_id}

会話内のチャットの一覧を取得する

get
/webapi/v2/conversations/{conversation_id}/chats

会話内のチャットの一覧を取得します。チャットはタイムスタンプによって昇順に並べ替えられています。

チャットページのサイズは100です。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
conversation_idstringRequired
Query parameters
pageNointeger · min: 1OptionalDefault: 1
Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses
200

成功

application/json
pageNointegerRequired
totalCountintegerRequired
get/webapi/v2/conversations/{conversation_id}/chats

会話IDで会話の状態を取得

get
/webapi/v2/conversations/{conversation_id}/running

会話IDで会話の状態を取得します。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
conversation_idstringRequired
Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses
200

正常に取得しました。

application/json
isRunningbooleanRequired

バックグラウンド実行ステータス

get/webapi/v2/conversations/{conversation_id}/running

会話を終了する

post
/webapi/v2/conversations/{conversation_id}/stop

進行中の会話を終了する。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
conversation_idstringRequired
Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses
200

正常に完了しました。

application/json
isRunningbooleanRequired

バックグラウンド実行ステータス

post/webapi/v2/conversations/{conversation_id}/stop

Get Conversation Chat By Id

get
/webapi/v2/conversations/{conversation_id}/chats/{chat_id}

Get a specific chat by ID from a conversation.

This API is useful for verifying the message content after a streaming response from run_apps API. The response includes detailed chat information compatible with LLMResponse.

Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
conversation_idstringRequired
chat_idstringRequired
Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses
200

OK

application/json

Detailed chat information compatible with LLMResponse for run_apps API response verification.

Extends Chat with additional fields for verifying streaming responses from run_apps API.

idstringRequired

Unique ID of the chat

typestring · nullableOptional

Node type of the chat

senderstringRequired

Sender Type

Example: USER
messagestringRequired

Chat message

timestampnumberRequired

Timestamp of the chat message creation time

completedbooleanRequired

Whether the chat generation is completed

ratingboolean · nullableRequired

Rating of the chat

agentRatingboolean · nullableRequired

Agent rating of the chat

get/webapi/v2/conversations/{conversation_id}/chats/{chat_id}

IDで会話チャットを削除

delete
/webapi/v2/conversations/{conversation_id}/chats/{chat_id}

Delete a specific chat message from a conversation.

Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
conversation_idstringRequired
chat_idstringRequired
Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses
200

成功

No content

delete/webapi/v2/conversations/{conversation_id}/chats/{chat_id}

No content

会話のタイトルを更新

put
/webapi/v2/conversations/{conversation_id}/title

会話のタイトルを設定します。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
conversation_idstringRequired
Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body
titlestringRequired

会話のタイトル。

Responses
200

成功

application/json
idstringRequired

会話ID

titlestringRequired

会話のタイトル

createdAtnumberRequired

会話作成時間

lastChatTimenumber · nullableRequired

最終チャット時間

isEndbooleanRequired

会話の終了状況

categoriesstring[] · nullableRequired

会話カテゴリー

memostring · nullableRequired

会話メモ

chatCountintegerRequired

合計会話数

put/webapi/v2/conversations/{conversation_id}/title

フィードバックを投稿する

post
/webapi/v2/conversations/{conversation_id}/chats/{chat_id}/feedback

Submit a thumbs-up or thumbs-down feedback on a generated chat response. Negative feedback can include a suggested answer and feedback selections.

Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
conversation_idstringRequired
chat_idstringRequired
Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body
ratingboolean · nullableOptional

チャットの評価

suggestedAnswerstring · nullableOptional

提案された回答

Responses
200

成功

application/json
conversationIdstringRequired
chatIdstringRequired
ratingboolean · nullableOptional
post/webapi/v2/conversations/{conversation_id}/chats/{chat_id}/feedback

会話カテゴリーの一覧を出力する

get
/webapi/v2/conversation_categories

List all conversation categories in the project.

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses
200

正常に出力されました。

application/json
get/webapi/v2/conversation_categories

会話カテゴリを作成する

post
/webapi/v2/conversation_categories

Create a new conversation category with the given name.

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body
namestringRequired
Responses
200

正常に作成されました。

application/json
categoryIdstringRequired

カテゴリID

namestringRequired

カテゴリー名

post/webapi/v2/conversation_categories

会話カテゴリーを削除

delete
/webapi/v2/conversation_categories/{conversation_category_id}

会話カテゴリーを削除します。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
conversation_category_idstringRequired
Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Responses
200

会話カテゴリーが正常に削除されました。

No content

delete/webapi/v2/conversation_categories/{conversation_category_id}

No content

チャット補完

post
/webapi/v2/chat/completions

検索を行わずLLMを直接呼び出します。

MallyのLLMインフラ(モデルルーティング、課金)を経由します。 'mode'フィールドで同期モードとストリーミングモードの両方に対応します。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body
modelstringOptional

LLM model name (Mally internal name)

Default: gpt4_o
temperaturenumberOptional

Sampling temperature

Default: 0.3
modestring · enumOptional

sync or stream

Default: syncPossible values:
max_tokensintegerOptional

Max completion tokens

Default: 2048
Responses
200

OK

No content

post/webapi/v2/chat/completions

No content

毎日の会話数

get
/webapi/conversation_daily_count

指定した範囲の1日あたりの会話の総数を取得します。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

任意: このリクエストに使用するメンバーのメールアドレス

USER-EMAILstringOptional

任意: このリクエストに使用するユーザーのメールアドレス

OWN-USER-IDstringOptional

任意: このリクエストに使用するユーザーのID

Body
startDatestringOptional

開始日をYYYY-MM-DD形式で範囲指定

endDatestringOptional

終了日を YYYY-MM-DD 形式で範囲指定します。

Responses
200

成功

application/json
errorsobject · nullableOptional
get/webapi/conversation_daily_count

Last updated