Apps
App related APIs
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
アプリ名が取得できました
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"
}
]
}Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
アプリAPI成功応答を作成する（このAPIが何のAPIかわかないため直し方が不明）
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"
}
]
}
}アプリAPI成功応答を作成する（このAPIが何のAPIかわかないため直し方が不明）
{
"result": {
"id": "text"
}
}このAPIはスキルを実行し、最終的なテキスト回答をJSON形式で返します。このAPIは、スキルがエンティティ抽出のために設計されている場合にも、使用できます。
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
スキルの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"
]
}回答生成APIは、非構造化テキストドキュメント、Q&A、さらには複雑な表からも回答を見つけます。さまざまな情報源から情報を統合して、ユーザーの問い合わせに対する包括的な回答を提供します。
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
クエリ（質問文）。
回答生成に利用するプロンプトを指定する。デフォルトモデルは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)
回答生成時に検索するソース データの範囲を指定します。現在使用可能な値は、web、qna、document、およびリスト形式でのデータ入力です。 例：["web", "qna"]
出力のランダム性を制御します。値が高いほど、出力はよりランダムになります。デフォルト = 0。
検索を特定の（ナレッジベースIDとは？）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: 476
{
"query": "text",
"model": "text",
"answerFormat": "text",
"isStateful": true,
"threadId": "123e4567-e89b-12d3-a456-426614174000",
"promptGroupId": "text",
"mode": "text",
"clueText": true,
"clues": true,
"hashtags": {
"qnaInclude": [
"text"
],
"qnaIncludeOption": "or",
"qnaExclude": [
"text"
],
"qnaExcludeOption": "or",
"docsInclude": [
"text"
],
"docsIncludeOption": "or",
"docsExclude": [
"text"
],
"docsExcludeOption": "or"
},
"search_from": [
"text"
],
"temperature": 1,
"knowledgeBaseIds": [
"text"
],
"folderIds": [
"text"
]
}{
"answer": {},
"answerHash": "text",
"confidence": 1,
"effectiveConfidence": 1,
"documentId": "text",
"documentName": "text",
"hashtags": [],
"pageNo": 1,
"createdDate": "2025-08-16",
"agentFeedback": {},
"userFeedback": {},
"body": "text",
"css": "text",
"pdfPreview": "text",
"folder": "text",
"editor": [
"text"
],
"viewer": [
"text"
],
"threadId": "text",
"fuQuestion": "text",
"intent": "text",
"clues": []
}スキルを使用して会話を開始します。注意：このエンドポイントは現在、会話応答ノード、Q&Aノード、回答生成ノードとしか互換性がありません。アプリには対応していません。
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
どのスキルで会話を開始するかを一致させるために使用されます。
会話を正常に開始しました。
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": {}
}End a conversation from the agent side.
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
Your API key can be found in your dashboard Settings menu, under the General tab.
The conversation ID to end
Conversation ended successfully
POST /webapi/end_conversation_by_agent HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: text
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ノード、ドキュメントノードとのみ互換性があります。
Optional: Email of the agent to use for this request
Optional: Email address to associate with the user
Optional: User ID to identify or create a user
会話で送信するメッセージ。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": {}
}Was this helpful?