ナレッジベースリストを取得

GET

/v1/convai/knowledge-base

GET

/v1/convai/knowledge-base

curl https://api.elevenlabs.io/v1/convai/knowledge-base

{
  "documents": [
    {
      "access_info": {
        "access_source": "creator",
        "creator_email": "john.doe@example.com",
        "creator_name": "John Doe",
        "is_creator": true,
        "role": "admin"
      },
      "auto_sync_info": {
        "auto_discover": false,
        "auto_remove": false,
        "consec_failures": 0,
        "minimum_frequency_days": 7,
        "next_refresh_by": 1
      },
      "dependent_agents": [
        {
          "access_level": "admin",
          "created_at_unix_secs": 1,
          "id": "string",
          "name": "string",
          "referenced_resource_ids": [
            "string"
          ],
          "type": "available"
        }
      ],
      "folder_parent_id": "string",
      "folder_path": [
        {
          "id": "string"
        }
      ],
      "id": "string",
      "metadata": {
        "created_at_unix_secs": 1,
        "last_updated_at_unix_secs": 1,
        "size_bytes": 1
      },
      "name": "string",
      "supported_usages": [
        "auto"
      ],
      "type": "string",
      "url": "string"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

利用可能なナレッジベースドキュメントのリストを取得します

クエリパラメータ

page_sizeintegerオプション1-100デフォルト値 30

返すドキュメントの最大数です。100を超えることはできず、デフォルトは30です。

searchstring or nullオプション

指定すると、エンドポイントは名前がこの文字列で始まるナレッジベースドキュメントのみを返します。

show_only_owned_documentsbooleanオプションデフォルト値 falseDeprecated

trueに設定すると、エンドポイントは自分が所有するドキュメントのみを返します（他者から共有されたものは含みません）。非推奨：代わりにcreated_by_user_idを使用してください。

created_by_user_idstring or nullオプション

作成者ユーザーIDでドキュメントをフィルタリングします。設定すると、このユーザーが作成したドキュメントのみを返します。show_only_owned_documentsより優先されます。認証済みユーザーを指定するには’@me’を使用してください。

作成者ユーザーIDでドキュメントをフィルタリングします。設定すると、このユーザーが作成したドキュメントのみを返します。show_only_owned_documentsより優先されます。認証済みユーザーを指定するには'@me'を使用してください。

typeslist of enums or nullオプション

指定した場合、エンドポイントは指定された種類のドキュメントのみを返します。

許可された値:

parent_folder_idstring or nullオプション

設定すると、エンドポイントは指定したフォルダの直接の子であるドキュメントのみを返します。

ancestor_folder_idstring or nullオプション

設定すると、エンドポイントは指定したフォルダの子孫であるドキュメントのみを返します。

folders_firstbooleanオプションデフォルト値 false

ドキュメント一覧でフォルダーを先に返すかどうか。

sort_directionenumオプション

結果の並べ替え方向

許可された値:

sort_byenum or nullオプション

結果の並べ替えに使用するフィールド

許可された値:

cursorstring or nullオプション

次のページを取得するために使用します。カーソルはレスポンスで返されます。

レスポンス

成功レスポンス。

documentslist of objects

has_moreboolean

next_cursorstring or nullオプション

エラー

422

Unprocessable Entity Error

ヘッダー

クエリパラメータ

レスポンス

エラー