Others
FAQ related APIs
フィルタリングおよびページネーションを使用して、Alliの操作ログを取得します。
認証用のAPIキー
Base timestamp (UTC)
Days before created_at (max 31 days)
31Agent email filter
API request type (rest/graphql)
Offset for pagination
0Limit for pagination
10任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
成功
Audit logのリスト応答。
総数
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/audit/logs HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": [
{
"id": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"agent": {
"id": "text",
"email": "text",
"firstName": "text",
"lastName": "text"
},
"ip": "text",
"operation": "text",
"mutation": "text",
"method": "text",
"path": "text",
"variables": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"query": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"body": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
],
"count": 1
}すべての操作ログを CSV ファイルとしてダウンロードします。
認証用のAPIキー
Base timestamp (UTC)
Days before created_at (max 31 days)
31Agent email filter
API request type (rest/graphql)
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
成功
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/audit/logs/download HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
シングルプロンプトを取得します。
認証用のAPIキー
シングルプロンプトのオフセット
0シングルプロンプトの制限
100任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
正常に取得しました。
プロンプトのID
プロンプト名
プロンプトの説明文
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/llm_prompts HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
[
{
"llmPromptId": "text",
"name": "text",
"description": "text",
"messages": [
{
"role": "system",
"content": "text"
}
],
"dynamicInputs": [
{
"name": "text",
"variableName": "text",
"isClipToken": false
}
]
}
]シングルプロンプトを作成します。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
プロンプト名
プロンプトの説明文
正常に作成しました。
プロンプトのID
プロンプト名
プロンプトの説明文
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/v2/llm_prompts HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 160
{
"name": "text",
"description": "text",
"messages": [
{
"role": "system",
"content": "text"
}
],
"dynamicInputs": [
{
"name": "text",
"variableName": "text",
"isClipToken": false
}
]
}{
"llmPromptId": "text",
"name": "text",
"description": "text",
"messages": [
{
"role": "system",
"content": "text"
}
],
"dynamicInputs": [
{
"name": "text",
"variableName": "text",
"isClipToken": false
}
]
}This API allows you to retrieve a single LLM prompt by ID.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
正常に取得しました。
プロンプトのID
プロンプト名
プロンプトの説明文
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/llm_prompts/{llm_prompt_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"llmPromptId": "text",
"name": "text",
"description": "text",
"messages": [
{
"role": "system",
"content": "text"
}
],
"dynamicInputs": [
{
"name": "text",
"variableName": "text",
"isClipToken": false
}
]
}This API allows you to soft-delete an LLM prompt. Fails if the prompt is currently used by a campaign.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
正常に削除されました。
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
DELETE /webapi/v2/llm_prompts/{llm_prompt_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
This API allows you to partially update an LLM prompt. Only provided fields are changed.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Request Body
name (string, required): Name of the prompt.
description (string, optional): Description of the prompt.
messages (array[object], optional): List of messages with
roleandcontent.dynamicInputs (array[object], optional): Dynamic input variables with
name,variableName, andisClipToken.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
プロンプト名
プロンプトの説明文
正常に設定されました。
プロンプトのID
プロンプト名
プロンプトの説明文
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
PATCH /webapi/v2/llm_prompts/{llm_prompt_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 160
{
"name": "text",
"description": "text",
"messages": [
{
"role": "system",
"content": "text"
}
],
"dynamicInputs": [
{
"name": "text",
"variableName": "text",
"isClipToken": false
}
]
}{
"llmPromptId": "text",
"name": "text",
"description": "text",
"messages": [
{
"role": "system",
"content": "text"
}
],
"dynamicInputs": [
{
"name": "text",
"variableName": "text",
"isClipToken": false
}
]
}指定されたパスまたはフォルダのディレクトリの統合をトリガーします。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
ディレクトリ統合をトリガーするためのリクエスト内容
統合するディレクトリへのパス
同期するフォルダのID
成功
ディレクトリ統合トリガーのレスポンス内容。
統合が正常に開始されたかどうか
レスポンスメッセージ
操作を追跡するためのタスクID
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/v2/directory_integration/trigger HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"directory_path": "text",
"folder_id": "text"
}{
"success": true,
"message": "text",
"task_id": "text"
}期間別に LLM アプリの会話履歴統計を取得します。
認証用のAPIキー
Start date in YYYY-MM-DD format
End date in YYYY-MM-DD format
LLM app ID
LLM app category
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
取得完了
利用履歴のレスポンスの統計データ
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/analytics/app_statistic_history?startDate=text&endDate=text HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": [
{
"date": "text",
"count": 1
}
]
}期間内のLLMコールの統計を取得します。
認証用のAPIキー
Start date in YYYY-MM-DD format
End date in YYYY-MM-DD format
LLM model
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
成功
利用履歴のレスポンスの統計データ
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/analytics/llm_statistic_history?startDate=text&endDate=text HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": [
{
"date": "text",
"count": 1
}
]
}保存されたメディアアイテムの内容をbase64エンコード文字列で取得します。media_idはupload_mediaエンドポイントが返すIDに対応します。認証済みプロジェクトにメディアが見つからない場合はnullコンテンツを返します。認証のためAPI-KEYヘッダーが必要です。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Request body for retrieving media content.
The ID of the media to retrieve content for.
The type of media to retrieve.
imagePossible values: OK
Response containing base64-encoded media content.
Base64-encoded media content, or null if the media was not found.
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/v2/multimodal/media-content HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"media_id": "text",
"media_type": "image"
}{
"content": "text"
}マークダウンコンテンツをダウンロード可能なドキュメント(PDF、DOCX、PPTX、XLSX)に変換します。成功時はファイル名とダウンロードURLを、失敗時はエラー詳細を返します。認証のためAPI-KEYヘッダーが必要です。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Request body for generating a downloadable file.
ID of the user requesting file generation.
Title of the generated document.
Output file format.
Markdown content to convert into the document.
Whether this file counts toward chat-upload retention. Defaults to false.
falseOK
Response containing the generated file location or error details.
Name of the generated file.
Download URL of the generated file.
Error code, present only on failure.
Human-readable error description.
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/v2/multimodal/generate-file HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 94
{
"userId": "text",
"title": "text",
"fileFormat": "pdf",
"markdownText": "text",
"isChatUpload": false
}{
"fileName": "text",
"fileUrl": "text",
"error": "text",
"errorMessage": "text"
}プロジェクト内の指定された質問に対する同義語ターゲットとその同義語を返します。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/v2/synonyms/ HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"questions": [
"text"
]
}{
"synonyms": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
}
}API-KEYで識別されるプロジェクトを返します。
Ralliはログイン後にプロジェクト情報(id、name、cognitiveSearchApiKey)を取得するために使用します。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OK
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/projects HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
[]This API allows you to retrieve the project's credit balance summary.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Query Parameters
startDate (string, optional): Start date in YYYY-MM-DD format. Must be used together with endDate.
endDate (string, optional): End date in YYYY-MM-DD format. Must be used together with startDate.
Dates are interpreted on the project's timezone, which the response reports as timezone.
認証用のAPIキー
Start date (inclusive) in YYYY-MM-DD, on the project's timezone. Required together with endDate.
2025-04-01Pattern: ^\d{4}-\d{2}-\d{2}$End date (inclusive) in YYYY-MM-DD, on the project's timezone. Required together with startDate.
2025-04-30Pattern: ^\d{4}-\d{2}-\d{2}$任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
OK
Response body for GET /webapi/v2/credits/balance.
Cumulative credit consumed by the project across all time.
1234.5IANA timezone whose calendar every figure below is bucketed on: the startDate/endDate range, byCategory, byService, and the cap month window. Align a local day or month boundary to this value rather than to UTC or to the caller's own timezone. Resolved, not raw — a project whose stored timezone is unset or unparseable reports UTC, which is also what the rollup falls back to, so the two can never disagree.
Asia/TokyoInvalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/v2/credits/balance HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"totalCreditUsage": 1234.5,
"timezone": "Asia/Tokyo",
"trial": {
"maxCredit": 10000,
"remainingCredit": 8765.5
},
"cap": {
"enabled": true,
"limit": 10000,
"currentMonthUsage": 432.1,
"remainingCredit": 9567.9,
"exceeded": false
},
"byCategory": {
"api_integration": 12.5,
"generative_answer": 50
},
"byService": {
"coworker": 900,
"voice_alli": 300
}
}This API allows you to retrieve the configured SDK URL patterns for the project.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Successfully retrieved SDK URL pattern
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/sdk_url_pattern HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": {
"pattern": "text"
}
}This API allows you to retrieve all category elements for a specific category variable.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Successfully retrieved category elements
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/customer_variable/{variable_name}/category_elements HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
{
"result": [
{
"id": "text",
"value": "text"
}
]
}This API allows you to create a new category element for a category variable.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Request Body
value (string, required): The value of the new category element.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Successfully created category element
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/customer_variable/{variable_name}/category_element HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"value": "text"
}{
"result": {
"id": "text",
"value": "text"
}
}Get Category Element
This API allows you to retrieve a specific category element by its ID.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Invalid request parameters.
No content
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/customer_variable/{variable_name}/category_element/{category_element_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
Update Category Element
This API allows you to update the value of a category element.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Request Body
value (string, required): The new value for the category element.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Invalid request parameters.
No content
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/customer_variable/{variable_name}/category_element/{category_element_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
Delete Category Element
This API allows you to delete a category element by its ID.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Invalid request parameters.
No content
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
DELETE /webapi/customer_variable/{variable_name}/category_element/{category_element_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
This API allows you to find the best matching answer from multiple sources (exact match, small talk, Q&A, documents) using a configurable processing order.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Query Parameters
query (string, required): The search query.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Successfully found matches
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/find_match?query=text HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
This API allows you to find the best matching answer from multiple sources (exact match, small talk, Q&A, documents) with advanced configuration options.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Request Body
query (string, required): The search query.
process_order (array[string], optional): Order of matching processes. Values:
exact_match,small_talk,faq,mrc.exact_match_list (array[string], optional): List of strings for exact matching.
faq_hashtags (array[string], optional): Hashtags to filter Q&A search.
faq_count (integer, optional): Number of Q&A results. Defaults to 5.
mrc_count (integer, optional): Number of document results. Defaults to 5.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Successfully found matches
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/find_match HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"query": "text"
}No content
This API allows you to retrieve match results or submit feedback for a previous Find Match result.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Query Parameters
resultId (string, required): The result ID from a prior Find Match response.
feedbackIndex (integer, optional): Index of the result to provide feedback for.
positiveFeedback (boolean, optional): Whether the feedback is positive or negative.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Match feedback processed successfully
No content
Invalid parameters
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/match_feedback?resultId=text HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
This API allows you to submit feedback for a previous Find Match result via POST request.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Request Body
match_id (string, required): The result ID from a prior Find Match response.
feedback_index (integer, optional): Index of the result to provide feedback for.
positive_feedback (boolean, optional): Whether the feedback is positive or negative.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Match feedback processed successfully
No content
Invalid parameters
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/match_feedback HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"match_id": "text",
"feedback_index": 1,
"positive_feedback": true
}No content
This API allows you to create a new knowledge snippet with a provider type and custom properties.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Request Body
provider_type (string, required): The type of the knowledge snippet provider.
properties (object, optional): Key-value pairs of properties for the snippet.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Successfully created knowledge snippet
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
POST /webapi/knowledge_snippet HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"provider_type": "text",
"properties": {}
}No content
This API allows you to retrieve a knowledge snippet by its ID.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Successfully retrieved knowledge snippet
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/knowledge_snippet/{ks_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
This API allows you to update the properties of a knowledge snippet. The eid property cannot be updated.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
Request Body
properties (object, required): Key-value pairs of properties to update.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Successfully updated knowledge snippet
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
PUT /webapi/knowledge_snippet/{ks_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"properties": {}
}No content
This API allows you to delete a knowledge snippet by its ID.
Headers
API-KEY (string, required): Your assigned API key. You can find it in the Settings menu of the dashboard.
AGENT-EMAIL (string, optional): The email address of the agent performing the API call.
USER-EMAIL (string, optional): The email address to associate with the user.
OWN-USER-ID (string, optional): The user ID to identify or create a user.
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
Successfully deleted knowledge snippet
No content
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
DELETE /webapi/knowledge_snippet/{ks_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
No content
プロジェクトの分析情報を取得します。
認証用のAPIキー
任意: このリクエストに使用するメンバーのメールアドレス
任意: このリクエストに使用するユーザーのメールアドレス
任意: このリクエストに使用するユーザーのID
YYYY-MM-DD形式で記入。分析を行う日付の開始日を指定。
YYYY-MM-DD形式で記入。分析を行う日付の終了日を指定。
分析データの取得に成功しました。
Invalid request parameters.
Authentication failed. The API-KEY header is missing or invalid.
Access denied. The project is inactive or the request IP is not allowed.
Internal server error.
GET /webapi/summary_analytics HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37
{
"startDate": "text",
"endDate": "text"
}{
"result": {
"conversations": 1,
"conversationsUpDown": 1,
"participants": 1,
"participantsUpDown": 1,
"uniqueParticipants": 1,
"uniqueParticipantsUpDown": 1,
"queries": 1,
"queriesUpDown": 1,
"queriedUsers": 1,
"queriedUsersUpDown": 1,
"uniqueQueriedUsers": 1,
"uniqueQueriedUsersUpDown": 1,
"instantResolution": 1,
"instantResolutionUpDown": 1,
"aiResponseRate": 1,
"aiResponseRateUpDown": 1,
"uniqueVisitors": 1,
"uniqueVisitorsUpDown": 1,
"totalFaqs": 1,
"totalFaqsUpDown": 1,
"totalDocuments": 1,
"totalDocumentsUpDown": 1,
"feedbacksUpDown": 1
},
"errors": {}
}Last updated