Obter lista da base de conhecimento

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

Obtenha uma lista de documentos disponíveis na base de conhecimento

Parâmetros de consulta

page_sizeintegerOpcional1-100Padrão é 30

Quantidade máxima de documentos a retornar. Não pode exceder 100; o padrão é 30.

searchstring or nullOpcional

Se especificado, o endpoint retorna somente documentos da base de conhecimento cujos nomes começam com esta string.

show_only_owned_documentsbooleanOpcionalPadrão é falseDeprecated

Se definido como true, o endpoint retornará apenas documentos que pertencem a você, e não compartilhados por outras pessoas. Obsoleto: use created_by_user_id.

created_by_user_idstring or nullOpcional

Filtre documentos pelo ID do usuário criador. Quando definido, retorna apenas documentos criados por esse usuário. Tem precedência sobre show_only_owned_documents. Use ‘@me’ para se referir ao usuário autenticado.

typeslist of enums or nullOpcional

Se presente, o endpoint retornará apenas documentos dos tipos informados.

Valores permitidos:

parent_folder_idstring or nullOpcional

Se definido, o endpoint retornará somente documentos que sejam filhos diretos da pasta informada.

ancestor_folder_idstring or nullOpcional

Se definido, o endpoint retornará somente documentos que sejam descendentes da pasta informada.

folders_firstbooleanOpcionalPadrão é false

Se as pastas devem ser retornadas primeiro na lista de documentos.

sort_directionenumOpcional

A direção para ordenar os resultados

Valores permitidos:

sort_byenum or nullOpcional

O campo pelo qual ordenar os resultados

Valores permitidos:

cursorstring or nullOpcional

Usado para buscar a próxima página. O cursor é retornado na resposta.

Resposta

Resposta bem-sucedida

documentslist of objects

has_moreboolean

next_cursorstring or nullOpcional

Erros

422

Unprocessable Entity Error

Cabeçalhos

Parâmetros de consulta

Resposta

Erros