Passer au contenu principal
Récupérez une liste paginée de tous les documents auxquels vous avez accès dans votre instance Paradigm. Cet endpoint supporte le filtrage par espace de travail, la pagination, et la gestion des portées.

​
Prérequis

  • Une clé API Paradigm : si vous n’en avez pas, accédez à votre profil Paradigm et générez une nouvelle clé API.
  • Accès aux documents : Vous devez disposer des permissions appropriées pour consulter les documents de votre instance.

​
Méthodes d’utilisation

Il existe plusieurs façons d’appeler cet endpoint :
  1. Avec le package python requests (recommandé)
  2. Via une requête curl : pour des tests rapides ou une première utilisation

​
Package python requests

Vous pouvez envoyer directement des requêtes aux endpoints de l’API via le package requests. 
import requests
import os

# Récupérer la clé API et l'URL de base depuis l'environnement
api_key = os.getenv("PARADIGM_API_KEY")
base_url = os.getenv("PARADIGM_BASE_URL", "https://paradigm.lighton.ai/api/v2")

response = requests.get(
    url=f"{base_url}/files",
    headers={
        'Authorization': f"Bearer {api_key}"
    },
)

print(response.json())
La clé API Paradigm et l’URL de base sont configurées via des variables d’environnement. Pour les instances privées, définissez PARADIGM_BASE_URL avec l’URL de votre instance. Consultez Configuration de l’instance pour plus de détails.

​
Format de réponse

La méthode renvoie un objet json contenant la liste paginée des documents : 
{
  "next": null,
  "previous": null,
  "count": 1,
  "data": [
    {
      "id": <file_id: int>,
      "object": "file",
      "created_at": <epoch_time: int>,
      "filename": <file_name: str>,
      "purpose": "documents",
      "status": "embedded"
    }
  ],
  "object": "list"
}

​
Pagination

Le nombre de documents par page est fixé à 20 et ne peut pas être modifié. Pour obtenir les documents d’une page spécifique, utilisez le paramètre extra_query : 
# Obtenir la deuxième page de documents
response = requests.get(
    url=f"{base_url}/files",
    headers={
        'Authorization': f"Bearer {api_key}"
    },
    params={"page":"2"}
)

​
Filtrage par périmètre de document

Les documents peuvent être stockés dans trois espaces différents :
  • Espace privé : Accessible uniquement à l’utilisateur
  • Espace entreprise : Accessible à tous les membres de l’entreprise
  • Workspace : Accessible aux membres spécifiques du workspace
Filtrez les documents en utilisant les paramètres de périmètre : 
# Filtrer pour les documents privés et le workspace #2
response = requests.get(
    url=f"{base_url}/files",
    headers={
        'Authorization': f"Bearer {api_key}"
    },
    params={
        "company_scope": False,
        "private_scope": True,
        "workspace_scope": 2,
    }
)
Par défaut, les documents de tous les périmètres accessibles sont renvoyés. Utilisez les filtres de périmètre pour affiner les résultats vers des collections de documents spécifiques.

​
Requête cURL

Si vous préférez envoyer une requête à Paradigm avec une simple commande cURL, voici un exemple : 
curl --request GET \
  --url $PARADIGM_BASE_URL/files \
  --header 'Authorization: Bearer <token>'
⌘I