Knowledge_bases

Knowledge base related APIs

ナレッジベースの差分を取得する

post

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

leftIdstringRequired

左のナレッジベースID

rightIdstringRequired

正しいナレッジベースID

Responses

200

正常に取得しました。

application/json

post

/webapi/v2/knowledge_base_diff

HTTPcURLJavaScriptPython

POST /webapi/v2/knowledge_base_diff HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "leftId": "text",
  "rightId": "text"
}

200

正常に取得しました。

{
  "result": [
    {
      "left": {
        "status": "text",
        "page": 1,
        "line": 1,
        "text": "text",
        "highlight": "text"
      },
      "right": {
        "status": "text",
        "page": 1,
        "line": 1,
        "text": "text",
        "highlight": "text"
      },
      "row": 1,
      "comment": "text"
    }
  ]
}

ファイル名でドキュメントをダウンロード

get

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Path parameters

project_idstringRequired

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

filenamestringOptional

ダウンロードするドキュメント名

Responses

200

ドキュメントファイルが正常にダウンロードされました。

application/octet-stream

Responsestring · binary

400

複数のドキュメントが見つかりました。

401

無許可

403

禁止された

404

ドキュメントが見つかりませんでした。

500

内部サーバーエラー

get

/download_document_by_name/{project_id}

HTTPcURLJavaScriptPython

GET /download_document_by_name/{project_id} HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "filename": "text"
}

binary

単一のドキュメントを取得

get

これは、単一のドキュメントの詳細を取得する方法です。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

idstringRequired

ドキュメントのID。

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

ドキュメントの詳細を正常に取得しました。

application/json

get

/webapi/single_document

HTTPcURLJavaScriptPython

GET /webapi/single_document?id=text HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

ドキュメントの詳細を正常に取得しました。

{
  "result": {
    "id": "text",
    "documentName": "text",
    "createdDate": "2025-12-17",
    "hashtags": [
      "text"
    ],
    "agentFeedback": {
      "positiveCount": 1,
      "negativeCount": 1
    },
    "userFeedback": {
      "positiveCount": 1,
      "negativeCount": 1
    }
  }
}

ドキュメントをアップロード

post

このAPIを使用して、ドキュメントメニューにドキュメントをアップロードすることが可能です。 アップロード可能なファイル形式は、下記になります。 ファイル形式：.txt, .docx, .csv, .xls, .xlsx, .xlsm, .jpg, .jpeg, .png, .hwp, .hwpx, .pdf, .ppt, .pptx, .doc 外部リンクが含まれるHTMLファイルをアップロードするには、アップロードする前に関連するリンク先のHTMLも含め、zipファイルに圧縮の上、アップロードしてください。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

multipart/form-data

filestring · binaryOptional

ローカルファイルの場所

hashtagsstring[]Optional

アップロードファイルのためのハッシュタグ

footerTitlestringOptional

アップロードされたファイルからの検索結果のフッターとして答えの情報源を入力できます。フッターテキストは検索結果の『From』の隣に表示されます。

footerUrlstringOptional

リンクしたいURLをfooterTitleに入れることができます。

parentFolderIdstringOptional

アップロードする対象フォルダID。最上位レベルに挿入するにはヌル。

allowOtherAgentsViewbooleanOptional

このドキュメントを他のエージェントが閲覧できるようにするかどうか

allowOtherUsersViewbooleanOptional

他のユーザーがこのドキュメントを閲覧することを許可するかどうか

useLayoutbooleanOptional

ドキュメントの解析処理を向上させるためにレイアウト処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。

useImageDescriptionbooleanOptional

ドキュメントの解析処理を向上させるためにimage description処理を使用するかどうかを指定します。プロジェクトでこの機能が許可されている場合にのみ使用されます。 機能の有効化が必要な場合は担当のカスタマーサクセスまでお問い合わせください。

Responses

200

ファイルのアップロードが成功しました。

application/json

400

無効なリクエストまたはファイル形式

413

ファイルサイズが制限を超えています。

post

/webapi/upload_file

HTTPcURLJavaScriptPython

POST /webapi/upload_file HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 248

{
  "file": "binary",
  "hashtags": [
    "text"
  ],
  "footerTitle": "text",
  "footerUrl": "text",
  "parentFolderId": "text",
  "allowOtherAgentsView": true,
  "allowOtherUsersView": true,
  "useLayout": true,
  "useImageDescription": true,
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "result": {
    "id": "text",
    "file_name": "text",
    "hashtags": [
      "text"
    ],
    "footer": "text"
  }
}

S3からドキュメントをアップロードする

post

このAPIを使用すると、S3に保存されているドキュメントをAlliのドキュメントメニューに転送できます。利用可能なファイル形式は、アップロードドキュメントセクションと同じです。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

pathstringOptional

ファイルのS3パス。ファイル名で終わる必要があります。バケット名を含めないでください。

secretKeystringOptional

あなたのS3シークレットキー。

accessKeystringOptional

あなたのS3アクセスキー。

bucketstringOptional

ファイルを含むS3バケットの名前。

footerTitlestringOptional

検索結果でのフッターテキストとして回答の出典を入力できます。フッターテキストは、検索結果の「出典」の横に表示されます。

footerUrlstringOptional

リンクしたいURLをfooterTitleに入れることができます。

hashtagsstring[]Optional

ドキュメントのハッシュタグ。

parentFolderIdstringOptional

アップロード先のターゲットフォルダーID。最上位に挿入する場合は空にして下さい。

Responses

200

S3からファイルが正常にアップロードされました。

application/json

400

無効なリクエストパラメーター

404

S3でファイルが見つかりません。

post

/webapi/upload_from_s3

HTTPcURLJavaScriptPython

POST /webapi/upload_from_s3 HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "path": "text",
  "secretKey": "text",
  "accessKey": "text",
  "bucket": "text",
  "footerTitle": "text",
  "footerUrl": "text",
  "hashtags": [
    "text"
  ],
  "parentFolderId": "text",
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "result": {
    "id": "text",
    "file_name": "text",
    "hashtags": [
      "text"
    ],
    "footer": "text"
  }
}

ドキュメントのステータスを確認

get

APIを介してドキュメントをアップロードすると、変換、解析され、ベクトルとして埋め込まれます。このAPIは、アップロードされるドキュメントの処理状況を表示します。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

idstringRequired

ステータスを確認するためのドキュメントID

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

ファイルのステータスを正常に取得しました。

application/json

400

無効なタスクIDまたはファイルが見つかりません

get

/webapi/check_file_status

HTTPcURLJavaScriptPython

GET /webapi/check_file_status?id=text HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

{
  "result": {
    "id": "text",
    "status": "text",
    "errorName": "text"
  }
}

ドキュメントの名前を変更 (ナレッジベース)

post

このAPIを使用すると、ドキュメントメニューにアップロードされたドキュメントの名前を更新できます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

idstringOptional

変更したいファイルのID。

filenamestringOptional

指定したファイルの新しい名前を入力。

Responses

200

ファイルの名前が正常に更新されました。

application/json

400

無効なパラメータ

post

/webapi/update_kb_name

HTTPcURLJavaScriptPython

POST /webapi/update_kb_name HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "id": "text",
  "filename": "text"
}

{
  "result": {
    "id": "text",
    "filename": "text"
  }
}

タイトルでドキュメントを検索

get

このAPIでは、ドキュメント名でドキュメントを検索することができます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

querystringRequired

ドキュメントタイトルの検索用語。

hashtagsstringOptional

ドキュメントをフィルターするためのカンマ区切りのハッシュタグのリスト。

combinedHashtagsstringOptional

グループをセミコロンで区切り、グループ内のタグをカンマで区切る複雑なハッシュタグフィルタリング(例:"a,b;c,d")。

excludingHashtagsstringOptional

ドキュメントを除外するためのカンマ区切りのハッシュタグのリスト。

useVectorstringOptional

セマンティックマッチングにベクトル検索を使用するには「true」、テキストベースの検索には「false」に設定します。

sortKeystringOptional

結果を並べ替えるプロパティフィールド。

sortDirectionstring · enumOptional

結果をソートする方向(昇順または降順)。

Possible values:

offsetintegerOptional

ページネーションのためにスキップする結果の数。

limitintegerOptional

返す結果の最大数。

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

検索に成功しました

application/json

get

/webapi/search_document_by_title

HTTPcURLJavaScriptPython

GET /webapi/search_document_by_title?query=text HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

検索に成功しました

{
  "result": [
    {
      "id": "text",
      "file_name": "text",
      "page_count": 1,
      "download_url": "text",
      "hashtags": [
        "text"
      ],
      "score": 1,
      "folder": "text",
      "agentEditor": [
        "text"
      ],
      "agentViewer": [
        "text"
      ]
    }
  ]
}

ドキュメントを削除

post

このAPIを使用すると、アップロードされたドキュメントを削除できます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

idsstring[]Optional

配列形式で削除したいドキュメントIDを指定します。

Responses

200

ドキュメントが正常に削除されました。

application/json

post

/webapi/delete_file

HTTPcURLJavaScriptPython

POST /webapi/delete_file HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "ids": [
    "text"
  ]
}

200

ドキュメントが正常に削除されました。

{
  "result": {
    "ok": true
  },
  "errors": {}
}

ドキュメントリストを取得

get

アップロードされているドキュメントをリスト形式で取得します

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

hashtagsSearchOperatorstring · enumOptional

複数のハッシュタグを照合するために使用される論理演算子。AND または OR のいずれかを指定できます。デフォルトは OR です。

Default: ORPossible values:

statusbooleanOptional

リストをフィルタリングする対象ドキュメントのON/OFF状態

searchTermstringOptional

リストを絞り込むためのキーワード検索クエリ。演算子を使用して高度な検索を実行できます。 AND検索には「TERM1 TERM2」、OR検索には「TERM1 OR TERM2」、完全一致検索には「TERM\」を使用します。

hashtagsstring[]Optional

リストをフィルタリングするためのハッシュタグ情報。

orderstring · enumOptional

リストの並べ替え順。ファイル名にはFILE_NAME_ASC/DESC、ファイルタイプにはTYPE_ASC/DESC、オン/オフ状態にはSTATUS_ASC/DESC、アップロード日時にはCREATED_AT_ASC/DESCを使用します。

Possible values:

offsetintegerOptional

オフセットを使用すると、ページ上の最初の項目の順位番号を指定できます。

limitinteger · min: 1 · max: 100Optional

limit を使用すると、1ページに表示されるオブジェクト数を設定できます。 最大値は100です。

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

ドキュメントリストの取得に成功

application/json

get

/webapi/knowledge_bases

HTTPcURLJavaScriptPython

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

200

ドキュメントリストの取得に成功

{
  "result": {
    "items": [
      {
        "id": "text",
        "fileName": "text",
        "hashtags": [
          "text"
        ],
        "autoHashtags": [
          {}
        ],
        "folder": "text",
        "agentEditor": [
          "text"
        ],
        "agentViewer": [
          "text"
        ],
        "userViewer": {
          "variables": {}
        },
        "allowOtherAgentsView": true,
        "allowOtherUsersView": true
      }
    ]
  },
  "errors": {}
}

ドキュメントのプレビューを確認

get

アップロードされたドキュメントのプレビューを確認できます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Query parameters

idstringRequired

APIキーは、ダッシュボードの「設定」メニューの「一般」タブで確認できます。

pageNostringRequired

プレビューを行うドキュメントID

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Responses

200

ドキュメントプレビューの取得に成功

application/json

get

/webapi/knowledge_base_preview

HTTPcURLJavaScriptPython

GET /webapi/knowledge_base_preview?id=text&pageNo=text HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

200

ドキュメントプレビューの取得に成功

{
  "result": {
    "totalPageCount": 1,
    "pageNo": 1,
    "css": "text",
    "body": "text",
    "highlightIndexes": [
      1
    ],
    "exactAnswer": "text",
    "pdf": "text",
    "draftjs": "text",
    "highlights": {
      "indexes": [
        1
      ],
      "pageIndexes": [
        1
      ],
      "__typename": "text"
    },
    "knowledgeBase": {
      "id": "text",
      "title": "text",
      "__typename": "text"
    },
    "__typename": "text"
  },
  "errors": {}
}

ドキュメント情報の更新

post

このAPIでは、ドキュメントのハッシュタグ・フッタータイトル・フッターリンクを更新できます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

idstringRequired

更新したいドキュメントのID

footerTitlestringOptional

アップロードしたファイルから生成された検索結果に出典(ソース)として表示されるフッターテキストを設定できます。検索結果の「From」の右側に表示されます。

footerUrlstringOptional

footerTitleにリンクさせたいURLを指定します。

folderstringOptional

ドキュメントをアップロードするときの保存先フォルダーを指定します。

followFolderPermissionbooleanOptional

フォルダの権限設定を引き継ぐかどうかを指定します。

agentsEditorstring[]Optional

このドキュメントに対して編集権限を持つメンバーを指定します。

agentsViewerstring[]Optional

このファイルに対して閲覧権限を持つメンバーを指定します。

allowOtherAgentsViewbooleanOptional

閲覧者や編集者に指定されていないメンバーにも、このドキュメントの閲覧を許可するかどうかを指定します。

allowOtherUsersViewbooleanOptional

閲覧者や編集者として指定されていない一般ユーザーにも、このドキュメントの閲覧を許可するかどうかを指定します。

hashtagsstring[]Optional

ドキュメントに追加したいハッシュタグ(文字列)の一覧です。

Responses

200

ドキュメントが正常に更新されました。

application/json

post

/webapi/update_document

HTTPcURLJavaScriptPython

POST /webapi/update_document HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 334

{
  "id": "text",
  "footerTitle": "text",
  "footerUrl": "text",
  "folder": "text",
  "followFolderPermission": true,
  "agentsEditor": [
    "text"
  ],
  "agentsViewer": [
    "text"
  ],
  "userViewer": {
    "customer_id": [
      "text"
    ],
    "customer_group": [
      "text"
    ]
  },
  "allowOtherAgentsView": true,
  "allowOtherUsersView": true,
  "hashtags": [
    "text"
  ],
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

200

ドキュメントが正常に更新されました。

{
  "result": {
    "knowledgeBase": {
      "id": "text",
      "hashtags": [
        "text"
      ],
      "footer": "text"
    }
  },
  "errors": {}
}

ナレッジベースのステータス変更

post

このAPIでは、ナレッジベースの複数のドキュメントの 公開・非公開(ON/OFF)ステータスをまとめて変更できます。

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

認証用のAPIキー

Header parameters

AGENT-EMAILstringOptional

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

USER-EMAILstringOptional

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

OWN-USER-IDstringOptional

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

Body

application/json

usebooleanRequired

全ての指定ドキュメントのステータスをON(true) にするか、OFF(false) にするかを指定します。true → すべて「ON」、false → すべて「OFF」

idsstring[]Required

ステータスを切り替えたいドキュメントIDのリスト。

Responses

200

ナレッジベースのステータスが正常に切り替えられました。

application/json

post

/webapi/toggle_documents

HTTPcURLJavaScriptPython

POST /webapi/toggle_documents HTTP/1.1
Host: backend-ja.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "use": true,
  "ids": [
    "text"
  ]
}

200

ナレッジベースのステータスが正常に切り替えられました。

{
  "result": {
    "knowledgeBases": [
      {
        "id": "text",
        "status": true
      }
    ]
  },
  "errors": {}
}