Hämta lista över kunskapsbaser

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

Hämta en lista över tillgängliga kunskapsbasdokument

Frågeparametrar

page_sizeintegerValfri1-100Standard är 30

Maximalt antal dokument att returnera. Får inte överstiga 100, standardvärdet är 30.

searchstringValfri

Om angivet returnerar endpointen endast kunskapsbasdokument vars namn börjar med denna sträng.

show_only_owned_documentsbooleanValfriStandard är falseDeprecated

Om värdet är true returnerar endpointen endast dokument som du äger, och inte sådana som delats av någon annan. Föråldrat: använd created_by_user_id i stället.

created_by_user_idstringValfri

Filtrera dokument efter användar-ID för skaparen. När detta anges returneras endast dokument som skapats av denna användare. Har företräde framför show_only_owned_documents. Använd '@me' för att hänvisa till den autentiserade användaren.

typesenumValfri

Om angivet returnerar endpointen endast dokument av de angivna typerna.

Tillåtna värden:

parent_folder_idstringValfri

Om angivet returnerar endpointen endast dokument som är direkta underobjekt till den angivna mappen.

ancestor_folder_idstringValfri

Om angivet returnerar endpointen endast dokument som är underordnade den angivna mappen.

folders_firstbooleanValfriStandard är false

Om mappar ska returneras först i dokumentlistan.

sort_directionenumValfri

Riktningen för att sortera resultaten

Tillåtna värden:

sort_byenumValfri

Fältet att sortera resultaten efter

Tillåtna värden:

cursorstringValfri

Används för att hämta nästa sida. Markören returneras i svaret.

Svar

Lyckat svar

documentslist of objects

has_moreboolean

next_cursorstringValfri

Fel

422

Knowledge Base List Request Unprocessable Entity Error

Headers

Frågeparametrar

Svar

Fel