Obtener lista de la base de conocimiento | ElevenLabs Documentation

{
  "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_discover": false,
        "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"
}

Obtén una lista de documentos disponibles de la base de conocimiento

Parámetros de consulta

page_sizeintegerOpcional1-100Valor predeterminado: 30

Número máximo de documentos que se devolverán. No puede superar 100; el valor predeterminado es 30.

searchstring or nullOpcional

Si se especifica, la ruta de API devuelve solo los documentos de la base de conocimientos cuyos nombres comiencen con esta cadena.

show_only_owned_documentsbooleanOpcionalValor predeterminado: falseDeprecated

Si se establece en true, la ruta de API devolverá solo los documentos que te pertenecen (y que no hayan sido compartidos por otra persona). Obsoleto: usa created_by_user_id en su lugar.

created_by_user_idstring or nullOpcional

Filtra documentos por ID del usuario creador. Cuando se especifica, solo se devuelven los documentos creados por este usuario. Tiene prioridad sobre show_only_owned_documents. Usa ‘@me’ para referirte al usuario autenticado.

typeslist of enums or nullOpcional

Si está presente, la ruta de API devolverá solo documentos de los tipos indicados.

Valores permitidos:

parent_folder_idstring or nullOpcional

Si se establece, la ruta de API devolverá solo documentos que sean elementos secundarios directos de la carpeta indicada.

ancestor_folder_idstring or nullOpcional

Si se establece, la ruta de API devolverá solo documentos que sean descendientes de la carpeta indicada.

folders_firstbooleanOpcionalValor predeterminado: false

Indica si las carpetas deben aparecer primero en la lista de documentos.

sort_directionenumOpcional

La dirección para ordenar los resultados

Valores permitidos:

sort_byenum or nullOpcional

El campo por el que se ordenarán los resultados

Valores permitidos:

cursorstring or nullOpcional

Se usa para obtener la página siguiente. El cursor se devuelve en la respuesta.

Respuesta

Respuesta correcta.

documentslist of objects

has_moreboolean

next_cursorstring or nullOpcional

Errores

422

Unprocessable Entity Error

Encabezados

Parámetros de consulta

Respuesta

Errores