Kennisbanklijst ophalen

GET

/v1/convai/knowledge-base

GET

/v1/convai/knowledge-base

curl -G https://api.elevenlabs.io/v1/convai/knowledge-base \
     -d ancestor_folder_id=ancestor_folder_id \
     -d created_by_user_id=created_by_user_id \
     -d cursor=cursor \
     -d folders_first=true \
     -d page_size=1 \
     -d parent_folder_id=parent_folder_id \
     -d search=search \
     -d show_only_owned_documents=true \
     -d sort_by=name \
     -d sort_direction=asc \
     -d types=file

{
  "documents": [
    {
      "type": "file",
      "access_info": {
        "is_creator": true,
        "creator_name": "John Doe",
        "creator_email": "john.doe@example.com",
        "role": "admin",
        "access_source": "creator"
      },
      "id": "id",
      "metadata": {
        "created_at_unix_secs": 1,
        "last_updated_at_unix_secs": 1,
        "size_bytes": 1
      },
      "name": "name",
      "supported_usages": [
        "prompt"
      ],
      "dependent_agents": [
        {
          "type": "available",
          "access_level": "admin",
          "created_at_unix_secs": 1,
          "id": "id",
          "name": "name"
        }
      ],
      "external_sync_info": {
        "type": "google_drive",
        "source_entity_id": "source_entity_id",
        "integration_connection_id": "integration_connection_id",
        "source_parent_entity_id": "source_parent_entity_id",
        "source_mime_type": "source_mime_type",
        "source_modified_time": "2024-01-15T09:30:00Z"
      },
      "folder_parent_id": "folder_parent_id",
      "folder_path": [
        {
          "id": "id"
        }
      ],
      "is_frozen": true
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}

Haal een lijst op van beschikbare kennisbankdocumenten

Query parameters

page_sizeintegerOptional1-100Defaults to 30

Het maximale aantal documenten dat moet worden geretourneerd. Mag niet meer zijn dan 100; standaard is dit 30.

searchstringOptional

Als dit wordt opgegeven, retourneert het endpoint alleen kennisbankdocumenten waarvan de naam met deze string begint.

show_only_owned_documentsbooleanOptionalDefaults to falseDeprecated

Als dit is ingesteld op true, retourneert het endpoint alleen documenten waarvan jij de eigenaar bent, en niet documenten die iemand anders heeft gedeeld. Verouderd: gebruik in plaats daarvan created_by_user_id.

created_by_user_idstringOptional

Filter documenten op gebruikers-ID van de maker. Wanneer ingesteld, worden alleen documenten geretourneerd die door deze gebruiker zijn gemaakt. Dit heeft voorrang op show_only_owned_documents. Gebruik ‘@me’ om te verwijzen naar de geverifieerde gebruiker.

typesenumOptional

Als dit aanwezig is, retourneert het endpoint alleen documenten van de opgegeven typen.

Allowed values:

parent_folder_idstringOptional

Als dit is ingesteld, retourneert het endpoint alleen documenten die direct onder de opgegeven map vallen.

ancestor_folder_idstringOptional

Als dit is ingesteld, retourneert het endpoint alleen documenten die onder de opgegeven map vallen.

folders_firstbooleanOptionalDefaults to false

Of mappen als eerste moeten worden geretourneerd in de lijst met documenten.

sort_directionenumOptional

De richting waarin je de resultaten sorteert

Allowed values:

sort_byenumOptional

Het veld waarop de resultaten worden gesorteerd

Allowed values:

cursorstringOptional

Gebruikt om de volgende pagina op te halen. De cursor wordt teruggegeven in de response.

Response

Geslaagde response

documentslist of objects

has_moreboolean

next_cursorstringOptional

Errors

422

Knowledge Base List Request Unprocessable Entity Error

Headers

Query parameters

Response

Errors