Obtenir la liste de la base de connaissances

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

Obtenir la liste des documents de base de connaissances disponibles

Paramètres de requête

page_sizeintegerOptionnel1-100Par défaut 30

Nombre maximal de documents à renvoyer. Ne peut pas dépasser 100 ; 30 par défaut.

searchstring or nullOptionnel

Si spécifié, le point de terminaison renvoie uniquement les documents de la base de connaissances dont le nom commence par cette chaîne.

show_only_owned_documentsbooleanOptionnelPar défaut falseDeprecated

Si défini sur true, le point de terminaison renverra uniquement les documents qui vous appartiennent, et non ceux partagés par une autre personne. Obsolète : utilisez created_by_user_id à la place.

created_by_user_idstring or nullOptionnel

Filtrer les documents par ID de l’utilisateur créateur. Lorsqu’il est défini, seuls les documents créés par cet utilisateur sont renvoyés. Ce paramètre prévaut sur show_only_owned_documents. Utilisez ‘@me’ pour désigner l’utilisateur authentifié.

typeslist of enums or nullOptionnel

S’il est présent, le point de terminaison ne renverra que les documents des types indiqués.

Valeurs autorisées:

parent_folder_idstring or nullOptionnel

Si défini, le point de terminaison renverra uniquement les documents directement contenus dans le dossier indiqué.

ancestor_folder_idstring or nullOptionnel

Si défini, le point de terminaison renverra uniquement les documents descendants du dossier indiqué.

folders_firstbooleanOptionnelPar défaut false

Indique si les dossiers doivent être renvoyés en premier dans la liste des documents.

sort_directionenumOptionnel

L’ordre de tri des résultats

Valeurs autorisées:

sort_byenum or nullOptionnel

Le champ selon lequel trier les résultats

Valeurs autorisées:

cursorstring or nullOptionnel

Utilisé pour récupérer la page suivante. Le curseur est renvoyé dans la réponse.

Réponse

Réponse réussie

documentslist of objects

has_moreboolean

next_cursorstring or nullOptionnel

Erreurs

422

Unprocessable Entity Error

En-têtes

Paramètres de requête

Réponse

Erreurs