Wissensdatenbankliste abrufen

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

Liste der verfügbaren Wissensbasisdokumente abrufen

Abfrageparameter

page_sizeintegerOptional1-100Standardwert ist 30

Maximale Anzahl zurückzugebender Dokumente. Darf 100 nicht überschreiten, Standardwert ist 30.

searchstringOptional

Falls angegeben, gibt der Endpunkt nur Wissensbasisdokumente zurück, deren Namen mit dieser Zeichenfolge beginnen.

show_only_owned_documentsbooleanOptionalStandardwert ist falseDeprecated

Wenn auf true gesetzt, gibt der Endpunkt nur Dokumente zurück, die Ihnen gehören und nicht von anderen freigegeben wurden. Veraltet: Verwenden Sie stattdessen created_by_user_id.

created_by_user_idstringOptional

Dokumente nach der Nutzer-ID des Erstellers filtern. Wenn festgelegt, werden nur von diesem Nutzer erstellte Dokumente zurückgegeben. Hat Vorrang vor show_only_owned_documents. Verwenden Sie ‘@me’ für den authentifizierten Nutzer.

typesenumOptional

Falls vorhanden, gibt der Endpunkt nur Dokumente der angegebenen Typen zurück.

Erlaubte Werte:

parent_folder_idstringOptional

Falls gesetzt, gibt der Endpunkt nur Dokumente zurück, die direkte Unterelemente des angegebenen Ordners sind.

ancestor_folder_idstringOptional

Falls gesetzt, gibt der Endpunkt nur Dokumente zurück, die Unterelemente des angegebenen Ordners sind.

folders_firstbooleanOptionalStandardwert ist false

Gibt an, ob Ordner zuerst in der Dokumentliste zurückgegeben werden sollen.

sort_directionenumOptional

Die Richtung zum Sortieren der Ergebnisse

Erlaubte Werte:

sort_byenumOptional

Das Feld, nach dem die Ergebnisse sortiert werden

Erlaubte Werte:

cursorstringOptional

Wird zum Abrufen der nächsten Seite verwendet. Der Cursor wird in der Antwort zurückgegeben.

Antwort

Erfolgreiche Antwort

documentslist of objects

has_moreboolean

next_cursorstringOptional

Fehler

422

Knowledge Base List Request Unprocessable Entity Error

Header

Abfrageparameter

Antwort

Fehler