Others

FAQ related APIs

Get Audit Logs

get
/webapi/v2/audit/logs

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

Authorizations
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
chevron-right
200

成功

application/json

Audit logのリスト応答。

countintegerRequired

総数

get
/webapi/v2/audit/logs
200

成功

Download Audit Logs

get
/webapi/v2/audit/logs/download

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

Authorizations
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
chevron-right
200

成功

No content

get
/webapi/v2/audit/logs/download
200

成功

No content

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

get
/webapi/v2/llm_prompts
Authorizations
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
chevron-right
200

正常に取得しました。

application/json
llmPromptIdstringRequired

プロンプトのID

namestringRequired

プロンプト名

descriptionany ofOptional

プロンプトの説明文

stringOptional
or
nullOptional
get
/webapi/v2/llm_prompts
200

正常に取得しました。

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

post
/webapi/v2/llm_prompts
Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body
nameany ofRequired

プロンプト名

stringOptional
or
nullOptional
descriptionany ofOptional

プロンプトの説明文

stringOptional
or
nullOptional
messagesany ofOptional

プロンプトの内容

or
nullOptional
dynamicInputsany ofOptional

プロンプトの動的入力

or
nullOptional
Responses
chevron-right
200

正常に作成しました。

application/json
llmPromptIdstringRequired

プロンプトのID

namestringRequired

プロンプト名

descriptionany ofOptional

プロンプトの説明文

stringOptional
or
nullOptional
post
/webapi/v2/llm_prompts
200

正常に作成しました。

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

get
/webapi/v2/llm_prompts/{llm_prompt_id}
Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
llm_prompt_idstringRequired
Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses
chevron-right
200

正常に取得しました。

application/json
llmPromptIdstringRequired

プロンプトのID

namestringRequired

プロンプト名

descriptionany ofOptional

プロンプトの説明文

stringOptional
or
nullOptional
get
/webapi/v2/llm_prompts/{llm_prompt_id}
200

正常に取得しました。

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

delete
/webapi/v2/llm_prompts/{llm_prompt_id}
Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
llm_prompt_idstringRequired
Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses
chevron-right
200

正常に削除されました。

No content

delete
/webapi/v2/llm_prompts/{llm_prompt_id}
200

正常に削除されました。

No content

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

patch
/webapi/v2/llm_prompts/{llm_prompt_id}
Authorizations
API-KEYstringRequired

認証用のAPIキー

Path parameters
llm_prompt_idstringRequired
Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body
nameany ofRequired

プロンプト名

stringOptional
or
nullOptional
descriptionany ofOptional

プロンプトの説明文

stringOptional
or
nullOptional
messagesany ofOptional

プロンプトの内容

or
nullOptional
dynamicInputsany ofOptional

プロンプトの動的入力

or
nullOptional
Responses
chevron-right
200

正常に設定されました。

application/json
llmPromptIdstringRequired

プロンプトのID

namestringRequired

プロンプト名

descriptionany ofOptional

プロンプトの説明文

stringOptional
or
nullOptional
patch
/webapi/v2/llm_prompts/{llm_prompt_id}
200

正常に設定されました。

Trigger Directoryの統合。

post
/webapi/v2/directory_integration/trigger

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

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

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

directory_pathany ofOptional

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

stringOptional
or
nullOptional
folder_idany ofOptional

同期するフォルダのID

stringOptional
or
nullOptional
Responses
chevron-right
200

成功

application/json

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

successbooleanRequired

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

messagestringRequired

レスポンスメッセージ

task_idany ofOptional

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

stringOptional
or
nullOptional
post
/webapi/v2/directory_integration/trigger
200

成功

会話履歴統計の取得

get
/webapi/v2/analytics/app_statistic_history

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

Authorizations
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
chevron-right
200

取得完了

application/json

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

get
/webapi/v2/analytics/app_statistic_history
200

取得完了

LLM実行統計の取得

get
/webapi/v2/analytics/llm_statistic_history

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

Authorizations
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
chevron-right
200

成功

application/json

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

get
/webapi/v2/analytics/llm_statistic_history
200

成功

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

post
/webapi/v2/multimodal/media-content

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

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

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
chevron-right
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
200

OK

ファイルを生成

post
/webapi/v2/multimodal/generate-file

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

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

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
chevron-right
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
200

OK

同義語を取得

post
/webapi/v2/synonyms/

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

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body
questionsstring[]Required
Responses
chevron-right
200

OK

application/json
post
/webapi/v2/synonyms/
200

OK

プロジェクトを取得

get
/webapi/v2/projects

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

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

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses
chevron-right
200

OK

application/json
itemsanyOptional
get
/webapi/v2/projects
200

OK

サマリー分析

get
/webapi/summary_analytics

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

Authorizations
API-KEYstringRequired

認証用のAPIキー

Header parameters
AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body
startDatestringOptional

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

endDatestringOptional

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

Responses
chevron-right
200

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

application/json
errorsobject · nullableOptional
get
/webapi/summary_analytics
200

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

Last updated