Recupera elenco della knowledge base

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

Ottieni un elenco dei documenti disponibili nella knowledge base

Parametri di query

page_sizeintegerOpzionale1-100Predefinito a 30

Numero massimo di documenti da restituire. Non può superare 100; il valore predefinito è 30.

searchstringOpzionale

Se specificato, l'endpoint restituisce solo i documenti della knowledge base i cui nomi iniziano con questa stringa.

show_only_owned_documentsbooleanOpzionalePredefinito a falseDeprecated

Se impostato su true, l'endpoint restituirà solo i documenti di tua proprietà, non condivisi da altri. Deprecato: usa invece created_by_user_id.

created_by_user_idstringOpzionale

Filtra i documenti in base all'ID dell'utente creatore. Se impostato, vengono restituiti solo i documenti creati da questo utente. Ha la precedenza su show_only_owned_documents. Usa '@me' per fare riferimento all'utente autenticato.

typesenumOpzionale

Se presente, l'endpoint restituirà solo documenti dei tipi specificati.

Valori consentiti:

parent_folder_idstringOpzionale

Se impostato, l'endpoint restituirà solo i documenti figli diretti della cartella specificata.

ancestor_folder_idstringOpzionale

Se impostato, l'endpoint restituirà solo i documenti discendenti della cartella specificata.

folders_firstbooleanOpzionalePredefinito a false

Se le cartelle devono essere restituite per prime nell'elenco dei documenti.

sort_directionenumOpzionale

La direzione per ordinare i risultati

Valori consentiti:

sort_byenumOpzionale

Il campo in base al quale ordinare i risultati

Valori consentiti:

cursorstringOpzionale

Usato per recuperare la pagina successiva. Il cursore viene restituito nella risposta.

Risposta

Risposta riuscita

documentslist of objects

has_moreboolean

next_cursorstringOpzionale

Errori

422

Knowledge Base List Request Unprocessable Entity Error

Header

Parametri di query

Risposta

Errori