Kennisbanklijst ophalen

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

Haal een lijst op van beschikbare kennisbankdocumenten

Queryparameters

page_sizeintegerOptioneel1-100Standaard 30

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

searchstring or nullOptioneel

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

show_only_owned_documentsbooleanOptioneelStandaard 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_idstring or nullOptioneel

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.

typeslist of enums or nullOptioneel

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

Toegestane waarden:

parent_folder_idstring or nullOptioneel

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

ancestor_folder_idstring or nullOptioneel

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

folders_firstbooleanOptioneelStandaard false

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

sort_directionenumOptioneel

De richting waarin je de resultaten sorteert

Toegestane waarden:

sort_byenum or nullOptioneel

Het veld waarop de resultaten worden gesorteerd

Toegestane waarden:

cursorstring or nullOptioneel

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

Response

Geslaagde response

documentslist of objects

has_moreboolean

next_cursorstring or nullOptioneel

Fouten

422

Unprocessable Entity Error

Headers

Queryparameters

Response

Fouten