Passer au contenu principal

​
Prérequis

  • Une clé API Paradigm : si vous n’en avez pas, rendez-vous sur votre profil Paradigm (/settings/api-key dans votre instance) et générez une nouvelle clé API.
  • Le document désiré à télécharger : Le fichier à télécharger ne peut pas avoir une taille supérieure à 100MB.

​
Méthodes d’utilisation

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

​
Package python requests

Vous pouvez envoyer directement une requête à l’endpoint API via le package requests. 
import requests
import os

# Récupérer la clé API depuis l'environnement
api_key = os.getenv("PARADIGM_API_KEY")
# Chemin du fichier à télécharger
file_path = "/chemin/vers/test_upload_file.pdf"

response = requests.request(
    method="POST",
    url=f"{base_url}/files",
    headers={
        'Authorization': f"Bearer {api_key}"
    },
    data={"purpose": "documents"},
    files={
        "file": open(file_path, "rb"),
    }
)

print(response.json())
Vous obtiendriez alors une réponse JSON sous forme de dictionnaire : 
{
    "id": 1,
    "object": "file",
    "bytes": 9626,
    "created_at": 1714659874,
    "filename": "test_upload_file.pdf",
    "purpose": "documents",
    "status": "success"
}

​
Requête cURL

Si vous préférez envoyer une requête à Paradigm avec une simple commande cURL, voici un exemple : 
curl $PARADIGM_BASE_URL/files \
  -H "Authorization: Bearer $PARADIGM_API_KEY" \
  -F purpose="documents" \
  -F file="@/chemin/vers/test_upload_file.pdf"
⌘I