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

App Market

Knowledge base related APIs

Get List Apps

get
/webapi/v2/apps

Get a list of apps. The apps are sorted by weight in descending order by default.

Authorizations
API-KEYstringRequired

認証用のAPIキー

Query parameters
searchTermstring · nullableOptional

Search term for app name or description

categoriesstring[] · nullableOptional

Filter by app categories

typestring · nullableOptional

Filter by app type

publishedboolean · nullableOptional

Filter by published status

pageSizeinteger · min: 1 · max: 100Optional

Number of apps per page

Default: 50
cursorstring · nullableOptional

Cursor for pagination

Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses
200

OK

application/json

Response for listing apps.

cursorstring · nullableOptional

Cursor for pagination

get/webapi/v2/apps

Get App By Id

get
/webapi/v2/apps/{app_id}

Get a specific app by ID.

Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
app_idstringRequired
Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses
200

OK

application/json

App information.

idstringRequired

Unique ID of the app

namestringRequired

Name of the app

descriptionstring · nullableOptional

Description of the app

typestringRequired

Type of the app

categorystringRequired

Category of the app

publishedbooleanRequired

Whether the app is published

get/webapi/v2/apps/{app_id}

Update App

patch
/webapi/v2/apps/{app_id}

Update an app.

Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
app_idstringRequired
Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

Request schema for updating an app.

namestring · nullableOptional

Name of the app

descriptionstring · nullableOptional

Description of the app

categorystring · nullableOptional

Category of the app

publishedboolean · nullableOptional

Whether the app is published

Responses
200

OK

application/json

App information.

idstringRequired

Unique ID of the app

namestringRequired

Name of the app

descriptionstring · nullableOptional

Description of the app

typestringRequired

Type of the app

categorystringRequired

Category of the app

publishedbooleanRequired

Whether the app is published

patch/webapi/v2/apps/{app_id}

Conversation Appを実行

post
/webapi/v2/apps/{app_id}/run_conversation

キャンペーンAppをストリーミングレスポンスで実行します。

キャンペーン(スキル/エージェント)Appを実行し、ストリーミングレスポンスを返します。 テキストメッセージ、ボタン選択、ファイル/メディアのアップロード、フォーム送信に対応しています。 常にmultipart/form-dataを使用します。send_form_inputはJSON文字列として渡してください。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
app_idstringRequired
Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body
conversationIdstring · nullableOptional

Existing conversation ID to continue

messagestring · nullableOptional

User message text

choicesstring · nullableOptional

Button/option choice indices (JSON array string, e.g. '[0, 1]')

sendFormInputstring · nullableOptional

Form submission data (JSON string)

fileIdsstring · nullableOptional
filesstring · binary[]Optional
media_filesstring · binary[]Optional
form_filesstring · binary[]Optional
Responses
200

OK

No content

post/webapi/v2/apps/{app_id}/run_conversation

No content

Cognitive Configを取得

get
/webapi/v2/cognitive_config

プロジェクトのcognitive_configをJSONで返します。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses
200

OK

application/json
Other propertiesanyOptional
get/webapi/v2/cognitive_config

Cognitive Configを部分更新

patch
/webapi/v2/cognitive_config

cognitive_configのフィールドを部分更新します。

リクエストボディ: field_name -> value のフラットなJSON dict。 指定したフィールドのみ更新され、他は変更されません。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body
Other propertiesanyOptional
Responses
200

OK

application/json
Other propertiesanyOptional
patch/webapi/v2/cognitive_config
get
/webapi/apps
Authorizations
API-KEYstringRequired

認証用のAPIキー

Query parameters
publishedstringOptional
idstring[]Optional
localestringOptional
Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses
200

アプリリストを正常に取得できました。

application/json
get/webapi/apps
post
/webapi/apps
Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body
user_idstringOptional
typestring · enumRequiredPossible values:
namestringRequired
descriptionstringRequired
categorystringRequired
publishedbooleanRequired
enabledbooleanRequired
Responses
200

create App API success response

application/json
post/webapi/apps

LLM Appを実行

post
/webapi/apps/{app_id}/run

REST APIからLLM Appを実行します。JSONリクエストに対応しています。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
app_idstringRequired
Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body
modestring · enumOptional

Execution mode. Use "sync" for synchronous responses or "stream" for streaming responses. Default is "sync".

Default: syncPossible values:
isStatefulbooleanOptional

Whether to maintain conversation state. Set to true to enable conversation history. When true, conversationId must be provided for follow-up messages.

Default: false
conversationIdstringOptional

Conversation ID for continuing a previous conversation. Required when isStateful is true for follow-up messages. Use the conversation.id from the previous response.

llmModelstringOptional

Name of the LLM model to use. Must be a registered model name (lowercase). See model registration documentation for available models.

llmPromptIdstringOptional

ID of the LLM prompt to use

gaPromptGroupIdstringOptional

ID of the Generative Answer prompt group to use

temperaturenumberOptional

Controls the randomness of the output. Higher values make the output more random. Range is typically 0 to 2.

Default: 0
requiredVariablesstring[]Optional

List of required variable names to include in the response

Responses
200

Successfully executed the LLM App

application/json
errorstringOptional

Error message if an error occurred

post/webapi/apps/{app_id}/run

スキルの実行

post
/webapi/skill

このAPIはスキルを実行し、最終的なテキスト回答をJSON形式で返します。このAPIは、スキルがエンティティ抽出のために設計されている場合にも、使用できます。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body
idstringRequired

スキルのIDです。Alliのダッシュボードでスキルをクリックすると、URLはhttps://app.alli.ai/projects/PROJECT_ID/campaigns/SKILL_IDのようになります。URL内のSKILL_IDを入力してください。

textstringRequired

スキルを実行するための入力テキストです。

variablesobjectOptional

変数は、スキル内の変数を設定するためのJSONオブジェクトです。Alliにおける変数について詳は、ユーザーガイドをご覧ください。

Responses
200

正常に実行されました。

application/json
resultstringOptional

スキル実行からの最終テキスト出力。

errorsstring[]Optional

エラーが発生した場合、ここにエラーメッセージが含まれます。

post/webapi/skill

会話を始める(skillを開始する)

post
/webapi/start_conversation

スキルを使用して会話を開始します。注意:このエンドポイントは現在、会話応答ノード、Q&Aノード、回答生成ノードとしか互換性がありません。アプリには対応していません。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body
placementstringOptional

どのスキルで会話を開始するかを一致させるために使用されます。

Responses
200

会話を正常に開始しました。

application/json
errorsobject · nullableOptional
post/webapi/start_conversation

会話ステータスを終了に切り替える

post
/webapi/end_conversation_by_agent

管理者側で会話ステータスを終了することができます。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body
idstringRequired

The conversation ID to end

Responses
200

Conversation ended successfully

application/json
errorsobject · nullableOptional

Error information if the request fails

post/webapi/end_conversation_by_agent

チャットを送信

post
/webapi/send_chat

既存の会話においてユーザーとしてメッセージを送信します。注意: このエンドポイントは現在、メッセージノード、Q&Aノード、ドキュメントノード、回答生成ノードとのみ互換性があります。

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body
messagestringRequired

会話で送信するメッセージ。null または空の文字列にはできません。

conversationIdstringRequired

メッセージを送信したい会話のユニークID。

Responses
200

チャットの送信に成功しました。

application/json
errorsobject · nullableOptional
post/webapi/send_chat

Last updated