Pobierz listę bazy wiedzy

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

Pobierz listę dostępnych dokumentów bazy wiedzy

Parametry zapytania

page_sizeintegerOpcjonalny1-100Domyślnie 30

Maksymalna liczba dokumentów do zwrócenia. Nie może przekraczać 100, domyślnie 30.

searchstring or nullOpcjonalny

Jeśli podano, endpoint zwraca tylko dokumenty bazy wiedzy, których nazwy zaczynają się od tego ciągu.

show_only_owned_documentsbooleanOpcjonalnyDomyślnie falseDeprecated

Jeśli ustawiono true, endpoint zwróci tylko dokumenty należące do ciebie, a nie udostępnione przez inne osoby. Przestarzałe: użyj zamiast tego created_by_user_id.

created_by_user_idstring or nullOpcjonalny

Filtruj dokumenty według ID użytkownika, który je utworzył. Po ustawieniu zwracane są tylko dokumenty utworzone przez tego użytkownika. Ma pierwszeństwo przed show_only_owned_documents. Użyj „@me”, aby wskazać uwierzytelnionego użytkownika.

typeslist of enums or nullOpcjonalny

Jeśli podano, endpoint zwróci tylko dokumenty danych typów.

Dozwolone wartości:

parent_folder_idstring or nullOpcjonalny

Jeśli ustawione, endpoint zwróci tylko dokumenty będące bezpośrednimi elementami podanego folderu.

ancestor_folder_idstring or nullOpcjonalny

Jeśli ustawione, endpoint zwróci tylko dokumenty będące potomkami podanego folderu.

folders_firstbooleanOpcjonalnyDomyślnie false

Czy foldery powinny być zwracane jako pierwsze na liście dokumentów.

sort_directionenumOpcjonalny

Kierunek sortowania wyników

Dozwolone wartości:

sort_byenum or nullOpcjonalny

Pole, według którego sortować wyniki

Dozwolone wartości:

cursorstring or nullOpcjonalny

Służy do pobrania następnej strony. Kursor jest zwracany w odpowiedzi.

Odpowiedź

Pomyślna odpowiedź

documentslist of objects

has_moreboolean

next_cursorstring or nullOpcjonalny

Błędy

422

Unprocessable Entity Error

Nagłówki

Parametry zapytania

Odpowiedź

Błędy