Others

FAQ related APIs

Get Audit Logs

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/audit/logs

フィルタリングおよびページネーションを使用して、Alliの操作ログを取得します。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

createdAtstring · date-timeOptional

Base timestamp (UTC)

beforeRangeinteger · min: 1 · max: 31Optional

Days before created_at (max 31 days)

Default: 31

emailany ofOptional

Agent email filter

stringOptional

or

nullOptional

apiRequestTypeany ofOptional

API request type (rest/graphql)

stringOptional

or

nullOptional

offsetintegerOptional

Offset for pagination

Default: 0

limitinteger · min: 1 · max: 1000Optional

Limit for pagination

Default: 10

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

成功

application/json

Audit logのリスト応答。

countintegerRequired

総数

get

/webapi/v2/audit/logs

HTTPcURLJavaScriptPython

GET /webapi/v2/audit/logs HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

成功

{
  "result": [
    {
      "id": "text",
      "createdAt": "2026-05-12T08:51:45.316Z",
      "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
}

Download Audit Logs

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/audit/logs/download

すべての操作ログを CSV ファイルとしてダウンロードします。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

createdAtstring · date-timeOptional

Base timestamp (UTC)

beforeRangeinteger · min: 1 · max: 31Optional

Days before created_at (max 31 days)

Default: 31

emailany ofOptional

Agent email filter

stringOptional

or

nullOptional

apiRequestTypeany ofOptional

API request type (rest/graphql)

stringOptional

or

nullOptional

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

成功

No content

get

/webapi/v2/audit/logs/download

HTTPcURLJavaScriptPython

GET /webapi/v2/audit/logs/download HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

成功

No content

シングルプロンプトを取得する

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/llm_prompts

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

offsetintegerOptional

シングルプロンプトのオフセット

Default: 0

limitintegerOptional

シングルプロンプトの制限

Default: 100

orderstring · enumOptionalPossible values:

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

正常に取得しました。

application/json

llmPromptIdstringRequired

プロンプトのID

namestringRequired

プロンプト名

descriptionany ofOptional

プロンプトの説明文

stringOptional

or

nullOptional

get

/webapi/v2/llm_prompts

HTTPcURLJavaScriptPython

GET /webapi/v2/llm_prompts HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

正常に取得しました。

[
  {
    "llmPromptId": "text",
    "name": "text",
    "description": "text",
    "messages": [
      {
        "role": "system",
        "content": "text"
      }
    ],
    "dynamicInputs": [
      {
        "name": "text",
        "variableName": "text",
        "isClipToken": false
      }
    ]
  }
]

シングルプロンプトを作成する

post

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/llm_prompts

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

nameany ofRequired

プロンプト名

stringOptional

or

nullOptional

descriptionany ofOptional

プロンプトの説明文

stringOptional

or

nullOptional

messagesany ofOptional

プロンプトの内容

or

nullOptional

dynamicInputsany ofOptional

プロンプトの動的入力

or

nullOptional

Responses

200

正常に作成しました。

application/json

llmPromptIdstringRequired

プロンプトのID

namestringRequired

プロンプト名

descriptionany ofOptional

プロンプトの説明文

stringOptional

or

nullOptional

post

/webapi/v2/llm_prompts

HTTPcURLJavaScriptPython

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
    }
  ]
}

200

正常に作成しました。

{
  "llmPromptId": "text",
  "name": "text",
  "description": "text",
  "messages": [
    {
      "role": "system",
      "content": "text"
    }
  ],
  "dynamicInputs": [
    {
      "name": "text",
      "variableName": "text",
      "isClipToken": false
    }
  ]
}

IDでシングルプロンプトを取得する

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/llm_prompts/{llm_prompt_id}

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

llm_prompt_idstringRequired

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

正常に取得しました。

application/json

llmPromptIdstringRequired

プロンプトのID

namestringRequired

プロンプト名

descriptionany ofOptional

プロンプトの説明文

stringOptional

or

nullOptional

get

/webapi/v2/llm_prompts/{llm_prompt_id}

HTTPcURLJavaScriptPython

GET /webapi/v2/llm_prompts/{llm_prompt_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

正常に取得しました。

{
  "llmPromptId": "text",
  "name": "text",
  "description": "text",
  "messages": [
    {
      "role": "system",
      "content": "text"
    }
  ],
  "dynamicInputs": [
    {
      "name": "text",
      "variableName": "text",
      "isClipToken": false
    }
  ]
}

IDでシングルプロンプトを削除する

delete

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/llm_prompts/{llm_prompt_id}

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

llm_prompt_idstringRequired

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

正常に削除されました。

No content

delete

/webapi/v2/llm_prompts/{llm_prompt_id}

HTTPcURLJavaScriptPython

DELETE /webapi/v2/llm_prompts/{llm_prompt_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

正常に削除されました。

No content

IDでシングルプロンプトを設定する

patch

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/llm_prompts/{llm_prompt_id}

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

llm_prompt_idstringRequired

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

nameany ofRequired

プロンプト名

stringOptional

or

nullOptional

descriptionany ofOptional

プロンプトの説明文

stringOptional

or

nullOptional

messagesany ofOptional

プロンプトの内容

or

nullOptional

dynamicInputsany ofOptional

プロンプトの動的入力

or

nullOptional

Responses

200

正常に設定されました。

application/json

llmPromptIdstringRequired

プロンプトのID

namestringRequired

プロンプト名

descriptionany ofOptional

プロンプトの説明文

stringOptional

or

nullOptional

patch

/webapi/v2/llm_prompts/{llm_prompt_id}

HTTPcURLJavaScriptPython

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
    }
  ]
}

200

正常に設定されました。

{
  "llmPromptId": "text",
  "name": "text",
  "description": "text",
  "messages": [
    {
      "role": "system",
      "content": "text"
    }
  ],
  "dynamicInputs": [
    {
      "name": "text",
      "variableName": "text",
      "isClipToken": false
    }
  ]
}

Trigger Directoryの統合。

post

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/directory_integration/trigger

指定されたパスまたはフォルダのディレクトリの統合をトリガーします。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

ディレクトリ統合をトリガーするためのリクエスト内容

directory_pathany ofOptional

統合するディレクトリへのパス

stringOptional

or

nullOptional

folder_idany ofOptional

同期するフォルダのID

stringOptional

or

nullOptional

Responses

200

成功

application/json

ディレクトリ統合トリガーのレスポンス内容。

successbooleanRequired

統合が正常に開始されたかどうか

messagestringRequired

レスポンスメッセージ

task_idany ofOptional

操作を追跡するためのタスクID

stringOptional

or

nullOptional

post

/webapi/v2/directory_integration/trigger

HTTPcURLJavaScriptPython

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"
}

200

成功

{
  "success": true,
  "message": "text",
  "task_id": "text"
}

会話履歴統計の取得

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/analytics/app_statistic_history

期間別に LLM アプリの会話履歴統計を取得します。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

startDatestringRequired

Start date in YYYY-MM-DD format

endDatestringRequired

End date in YYYY-MM-DD format

metricNamestring · enumOptionalPossible values:

llmAppIdany ofOptional

LLM app ID

stringOptional

or

nullOptional

llmAppCategoryany ofOptional

LLM app category

stringOptional

or

nullOptional

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

取得完了

application/json

利用履歴のレスポンスの統計データ

get

/webapi/v2/analytics/app_statistic_history

HTTPcURLJavaScriptPython

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: */*

200

取得完了

{
  "result": [
    {
      "date": "text",
      "count": 1
    }
  ]
}

LLM実行統計の取得

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/analytics/llm_statistic_history

期間内のLLMコールの統計を取得します。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

startDatestringRequired

Start date in YYYY-MM-DD format

endDatestringRequired

End date in YYYY-MM-DD format

metricNamestring · enumOptionalPossible values:

llmModelany ofOptional

LLM model

stringOptional

or

nullOptional

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

成功

application/json

利用履歴のレスポンスの統計データ

get

/webapi/v2/analytics/llm_statistic_history

HTTPcURLJavaScriptPython

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: */*

200

成功

{
  "result": [
    {
      "date": "text",
      "count": 1
    }
  ]
}

メディアコンテンツを取得

post

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/multimodal/media-content

保存されたメディアアイテムの内容をbase64エンコード文字列で取得します。media_idはupload_mediaエンドポイントが返すIDに対応します。認証済みプロジェクトにメディアが見つからない場合はnullコンテンツを返します。認証のためAPI-KEYヘッダーが必要です。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

Request body for retrieving media content.

media_idstringRequired

The ID of the media to retrieve content for.

media_typestring · enumOptional

The type of media to retrieve.

Default: imagePossible values:

Responses

200

OK

application/json

Response containing base64-encoded media content.

contentany ofRequired

Base64-encoded media content, or null if the media was not found.

stringOptional

or

nullOptional

post

/webapi/v2/multimodal/media-content

HTTPcURLJavaScriptPython

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"
}

200

OK

{
  "content": "text"
}

ファイルを生成

post

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/multimodal/generate-file

マークダウンコンテンツをダウンロード可能なドキュメント（PDF、DOCX、PPTX、XLSX）に変換します。成功時はファイル名とダウンロードURLを、失敗時はエラー詳細を返します。認証のためAPI-KEYヘッダーが必要です。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

Request body for generating a downloadable file.

userIdstringRequired

ID of the user requesting file generation.

titlestringRequired

Title of the generated document.

fileFormatstring · enumRequired

Output file format.

Possible values:

markdownTextstringRequired

Markdown content to convert into the document.

Responses

200

OK

application/json

Response containing the generated file location or error details.

fileNameany ofOptional

Name of the generated file.

stringOptional

or

nullOptional

fileUrlany ofOptional

Download URL of the generated file.

stringOptional

or

nullOptional

errorany ofOptional

Error code, present only on failure.

stringOptional

or

nullOptional

errorMessageany ofOptional

Human-readable error description.

stringOptional

or

nullOptional

post

/webapi/v2/multimodal/generate-file

HTTPcURLJavaScriptPython

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: 73

{
  "userId": "text",
  "title": "text",
  "fileFormat": "pdf",
  "markdownText": "text"
}

200

OK

{
  "fileName": "text",
  "fileUrl": "text",
  "error": "text",
  "errorMessage": "text"
}

同義語を取得

post

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/synonyms/

プロジェクト内の指定された質問に対する同義語ターゲットとその同義語を返します。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

questionsstring[]Required

Responses

200

OK

application/json

post

/webapi/v2/synonyms/

HTTPcURLJavaScriptPython

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"
  ]
}

200

OK

{
  "synonyms": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

プロジェクトを取得

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/v2/projects

API-KEYで識別されるプロジェクトを返します。

Ralliはログイン後にプロジェクト情報（id、name、cognitiveSearchApiKey）を取得するために使用します。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

OK

application/json

itemsanyOptional

get

/webapi/v2/projects

HTTPcURLJavaScriptPython

GET /webapi/v2/projects HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

OK

[]

サマリー分析

get

https://backend-ja.alli.aihttps://backend.alli.ai

/webapi/summary_analytics

プロジェクトの分析情報を取得します。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

startDatestringOptional

YYYY-MM-DD形式で記入。分析を行う日付の開始日を指定。

endDatestringOptional

YYYY-MM-DD形式で記入。分析を行う日付の終了日を指定。

Responses

200

分析データの取得に成功しました。

application/json

errorsobject · nullableOptional

get

/webapi/summary_analytics

HTTPcURLJavaScriptPython

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"
}

200

分析データの取得に成功しました。

{
  "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": {}
}