Apps
App related APIs
Get a list of apps. The apps are sorted by weight in descending order by default.
認証用のAPIキー
Search term for app name or description
Filter by app categories
Filter by app type
Filter by published status
Number of apps per page
50Cursor for pagination
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OK
GET /webapi/v2/apps HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
OK
{
"apps": [
{
"id": "text",
"name": "text",
"description": "text",
"type": "text",
"category": "text",
"published": true,
"agentPermission": {
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"permissionGroupName": "text",
"accessType": "order_1_editor"
}
],
"viewAccessToAgent": true
},
"userPermission": {
"ownUserIds": [
"text"
],
"customerGroups": [
"text"
],
"viewAccessToUser": true
}
}
],
"cursor": "text"
}Get a specific app by ID.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OK
GET /webapi/v2/apps/{app_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
OK
{
"id": "text",
"name": "text",
"description": "text",
"type": "text",
"category": "text",
"published": true,
"agentPermission": {
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"permissionGroupName": "text",
"accessType": "order_1_editor"
}
],
"viewAccessToAgent": true
},
"userPermission": {
"ownUserIds": [
"text"
],
"customerGroups": [
"text"
],
"viewAccessToUser": true
}
}Update an app.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Request schema for updating an app.
Name of the app
Description of the app
Category of the app
Whether the app is published
Agent permission
User permission
OK
PATCH /webapi/v2/apps/{app_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 359
{
"name": "text",
"description": "text",
"category": "text",
"published": true,
"agentPermission": {
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"accessType": "order_1_editor"
}
],
"viewAccessToAgent": true
},
"userPermission": {
"ownUserIds": [
"text"
],
"customerGroups": [
"text"
],
"viewAccessToUser": true
}
}OK
{
"id": "text",
"name": "text",
"description": "text",
"type": "text",
"category": "text",
"published": true,
"agentPermission": {
"accessAgents": [
{
"agentId": "text",
"accessType": "order_1_editor"
}
],
"accessPermissionGroups": [
{
"permissionGroupId": "text",
"permissionGroupName": "text",
"accessType": "order_1_editor"
}
],
"viewAccessToAgent": true
},
"userPermission": {
"ownUserIds": [
"text"
],
"customerGroups": [
"text"
],
"viewAccessToUser": true
}
}認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
アプリリストを正常に取得できました。
GET /webapi/apps HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
アプリリストを正常に取得できました。
{
"result": [
{
"id": "text",
"name": "text",
"type": "single_action",
"description": "text",
"category": "text",
"app_from": "text",
"app_url": "text"
}
]
}認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
create App API success response
POST /webapi/apps HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 472
{
"user_id": "text",
"type": "single_action",
"name": "text",
"description": "text",
"category": "text",
"published": true,
"enabled": true,
"single_action_app_input": {
"name": "text",
"description": "text",
"llm_model": "text",
"selected_llm_processing_method": "stuff",
"selected_map_reduce_input_variable_name": "text",
"inputs": [
{
"name": "text",
"value": "text",
"placeholder": "text",
"input_type": "text",
"options": [
{
"name": "text",
"value": "text"
}
]
}
],
"messages": [
{
"role": "system",
"content": "text"
}
]
}
}create App API success response
{
"result": {
"id": "text"
}
}Execute an LLM App via REST API. Supports JSON requests.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Execution mode. Use "sync" for synchronous responses or "stream" for streaming responses. Default is "sync".
syncPossible values: Whether to maintain conversation state. Set to true to enable conversation history. When true, conversationId must be provided for follow-up messages.
falseConversation ID for continuing a previous conversation. Required when isStateful is true for follow-up messages. Use the conversation.id from the previous response.
Name of the LLM model to use. Must be a registered model name (lowercase). See model registration documentation for available models.
ID of the LLM prompt to use
ID of the Generative Answer prompt group to use
Controls the randomness of the output. Higher values make the output more random. Range is typically 0 to 2.
0List of required variable names to include in the response
Successfully executed the LLM App
Bad request
Unauthorized - Invalid or missing authentication token
Rate limit exceeded
Internal server error
POST /webapi/apps/{app_id}/run HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 321
{
"chat": {
"message": "text",
"source": {
"knowledgeBaseIds": [
"text"
],
"folderIds": [
"text"
],
"webSites": [
"text"
]
}
},
"inputs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"mode": "sync",
"isStateful": false,
"conversationId": "text",
"llmModel": "text",
"llmPromptId": "text",
"gaPromptGroupId": "text",
"temperature": 0,
"requiredVariables": [
"text"
]
}{
"result": {
"id": "text",
"name": "text",
"type": "campaign",
"category": "General",
"responses": [
{
"id": "text",
"type": "text",
"message": "text",
"source": {},
"sender": "text",
"createdAt": "2024-09-23T04:53:12.675",
"completed": true,
"citations": [
{
"clueId": "text",
"source": "text",
"title": "text",
"knowledgeBaseId": "text",
"pageNo": 1,
"url": "text",
"text": "text"
}
],
"error": {
"timestamp": 1,
"nodeId": "text",
"nodeType": "text",
"errorType": "text",
"errorObject": {}
},
"intermediateStep": {
"completed": true,
"key": "text",
"createdAt": "2025-12-07T07:14:16.210Z",
"statusMessage": "text",
"markdownMessage": "text"
}
}
],
"variables": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"conversation": {
"id": "text",
"state": "text"
}
},
"error": "text"
}このAPIはスキルを実行し、最終的なテキスト回答をJSON形式で返します。このAPIは、スキルがエンティティ抽出のために設計されている場合にも、使用できます。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
スキルのIDです。Alliのダッシュボードでスキルをクリックすると、URLはhttps://app.alli.ai/projects/PROJECT_ID/campaigns/SKILL_IDのようになります。URL内のSKILL_IDを入力してください。
スキルを実行するための入力テキストです。
変数は、スキル内の変数を設定するためのJSONオブジェクトです。Alliにおける変数について詳は、ユーザーガイドをご覧ください。
正常に実行されました。
不正なリクエスト
許可されていないリクエストです。
POST /webapi/skill HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"id": "text",
"text": "text",
"variables": {}
}{
"result": "text",
"errors": [
"text"
]
}非構造化テキストドキュメント、Q&A、複雑な表などから、さまざまな情報を統合して、ユーザーの問い合わせに対する包括的な回答を生成します。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
クエリ(質問文)
回答生成に利用するプロンプトを指定。デフォルトモデルはGPT4o。利用可能なオプションについてはドキュメントをご参照ください。
応答のフォーマットを決定します。指定できる値はDRAFTJSまたはMARKDOWNです。デフォルトのフォーマットはDRAFTJSです。
フォローアップ質問を使用するには、以前の会話履歴が必要です。会話履歴はthreadIdによって管理されます。isStatefulオプションをTrueに設定し、threadIdを入力すると、クエリは以前の会話履歴を参照して書き換えられます。デフォルトはFalseです。
threadIdはisStatefulがTrueの場合に使用されます。最初に会話を開始するときは、空のまま送信し、次のクエリ以降は出力からのthreadIdを使用して送信します。最初からthreadIdを設定したい場合は、UUIDとして記入し送信します。例: UUID - 36e7bb2b-1063-47ec-。デフォルト = None。
回答生成に使用するプロジェクトのグループプロンプトを選択します。この設定は、デフォルトで準備されたグループプロンプトから変更を行い利用している場合などに有効です。 IDはプロジェクト設定>プロンプト管理>回答生成タブの選択します。使用するグループプロンプトを選択した際に表示されるURLからIDが確認できます。 例:https://app.alli.ai/projects/UHJvamVjdDo2NDljYTRjZDMzMGY2MDZkYWRjOPOjNjE=/settings/prompt-management/generative-answer/groups/TExNUHJvbXB0R3JvdXA6NjUzNzc3MzA5GHUyMGE2ZjlhM2Q5OTIw
'データをsyncかstreamのどちらで出力するか設定します。(Default = sync) streamモードの場合、syncと同じ出力形式のjson文字列がstreamとして出力されます。
clueTextはclues=Trueの時に利用できるオプションです。 clueに用いたドキュメントのテキスト情報を含めるかどうか設定できます。(Default = False)
回答を生成するために使用されたclueを出力に含めるかどうか設定できます。(Default = False)
回答に詳細な引用情報を含めるかの有無。回答の生成に使用されたソース文書を参照します。デフォルトはFalseです。
回答生成時に検索するソース データの範囲を指定します。現在使用可能な値は、web、qna、document、およびリスト形式でのデータ入力です。 例：["web", "qna"]
出力のランダム性を制御します。値が高いほど、出力はよりランダムになります。デフォルト = 0。
検索を特定のナレッジベースノード(ドキュメントやフォルダ)IDに限定します。
検索を特定のドキュメントフォルダーIDに限定します。
回答が生成されました
不正なリクエスト
無許可
レート制限を超えました。
POST /webapi/generative_answer HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 609
{
"query": "text",
"model": "text",
"answerFormat": "text",
"isStateful": true,
"threadId": "123e4567-e89b-12d3-a456-426614174000",
"promptGroupId": "text",
"mode": "text",
"clueText": true,
"clues": true,
"includeCitations": true,
"hashtags": {
"qnaInclude": [
"text"
],
"qnaIncludeOption": "or",
"qnaExclude": [
"text"
],
"qnaExcludeOption": "or",
"docsInclude": [
"text"
],
"docsIncludeOption": "or",
"docsExclude": [
"text"
],
"docsExcludeOption": "or"
},
"search_from": [
"text"
],
"temperature": 1,
"source": {
"sharedKnowledgeBaseNodeIds": [
"text"
],
"personalKnowledgeBaseNodeIds": [
"text"
],
"webSites": [
"text"
]
},
"knowledgeBaseIds": [
"text"
],
"folderIds": [
"text"
]
}{
"answer": {},
"answerHash": "text",
"confidence": 1,
"effectiveConfidence": 1,
"documentId": "text",
"documentName": "text",
"hashtags": [],
"pageNo": 1,
"createdDate": "2025-12-07",
"agentFeedback": {},
"userFeedback": {},
"body": "text",
"css": "text",
"pdfPreview": "text",
"folder": "text",
"editor": [
"text"
],
"viewer": [
"text"
],
"threadId": "text",
"fuQuestion": "text",
"intent": "text",
"clues": [],
"citations": [
{
"index": 1,
"clueId": "text",
"source": "text",
"title": "text",
"pageNo": 1,
"knowledgeBaseId": "text",
"faqId": "text",
"url": "text",
"text": "text"
}
]
}スキルを使用して会話を開始します。注意:このエンドポイントは現在、会話応答ノード、Q&Aノード、回答生成ノードとしか互換性がありません。アプリには対応していません。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
どのスキルで会話を開始するかを一致させるために使用されます。
会話を正常に開始しました。
POST /webapi/start_conversation HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"placement": "text"
}会話を正常に開始しました。
{
"result": {
"conversation": {
"id": "text",
"project": {
"nluLanguage": "text"
},
"chats": {
"edges": [
{
"node": {
"id": "text",
"message": "text",
"createdAt": 1,
"chatOptionInfos": [
{
"shortenOption": "text",
"longOption": "text",
"style": {
"bgColor": "text",
"bold": true,
"fontColor": "text",
"italic": true,
"lineColor": "text",
"underline": true
},
"meta": "text"
}
],
"isDeleted": true
}
}
]
}
}
},
"errors": {}
}管理者側で会話ステータスを終了することができます。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
The conversation ID to end
Conversation ended successfully
POST /webapi/end_conversation_by_agent HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 13
{
"id": "text"
}Conversation ended successfully
{
"result": {
"conversation": {
"id": "text",
"completedTime": 1,
"state": "text",
"__typename": "text"
},
"__typename": "text"
},
"errors": {}
}既存の会話においてユーザーとしてメッセージを送信します。注意: このエンドポイントは現在、メッセージノード、Q&Aノード、ドキュメントノード、回答生成ノードとのみ互換性があります。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
会話で送信するメッセージ。null または空の文字列にはできません。
メッセージを送信したい会話のユニークID。
チャットの送信に成功しました。
POST /webapi/send_chat HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42
{
"message": "text",
"conversationId": "text"
}チャットの送信に成功しました。
{
"result": {
"responses": [
{
"id": "text",
"message": "text",
"createdAt": 1,
"chatOptionInfos": [
{
"shortenOption": "text",
"longOption": "text",
"style": {
"bgColor": "text",
"bold": true,
"fontColor": "text",
"italic": true,
"lineColor": "text",
"underline": true
},
"meta": "text"
}
],
"isDeleted": true
}
],
"state": "text"
},
"errors": {}
}Last updated
Was this helpful?