Skip to main content
POST
Ingestion de documents (fichiers ou URLs)

Autorisations

X-API-KEY
string
header
requis

En-têtes

X-End-User-ID
string | null

Corps

multipart/form-data
files
file[] | null

Une liste de fichiers à importer.

urls
string | null

Une liste d'URLs à scraper, séparées par des virgules.

workspace_ids
string | null

Une liste d'IDs d'espaces de travail où ajouter les documents, séparées par des virgules.

api_metadata
string | null

Métadonnées API personnalisées (chaîne JSON).

scraping_mode
string
défaut:Simple Scraping

Mode de scraping ('Simple Scraping' ou 'Crawling').

crawl_depth
integer
défaut:2

La profondeur maximale pour le crawling des liens.

same_domain_only
boolean
défaut:true

Indique s'il faut uniquement crawler les liens du même domaine.

limit
integer
défaut:10

Le nombre maximum de pages à crawler.

delay
number
défaut:1

Le délai en secondes entre les requêtes.

youtube_download_format
string
défaut:audio

Le format de téléchargement pour les vidéos YouTube ('audio' ou 'video').

Réponse

Successful Response

id
string<uuid>
requis

L'identifiant unique du document.

name
string
requis

Le nom d'affichage du document.

status
string
requis

Le statut de traitement actuel du document.

created_at
string<date-time>
requis

L'horodatage de la création du document.

updated_at
string<date-time>
requis

L'horodatage de la dernière mise à jour du document.

file_type
string | null

Le type MIME du fichier du document.

processing_pipeline
string | null

Le nom du pipeline de traitement utilisé pour ce document.

error_message
string | null

Si le traitement a échoué, ce champ contiendra le message d'erreur.

api_metadata
Api Metadata · object | null

Métadonnées API personnalisées résolues pour l'utilisateur actuel. Utile pour récupérer des références externes stockées (par exemple {'internal_app_ref': 'REF-123'}). Note : Cette valeur est résolue en fonction de l'external_user_id de la requête. Un document partagé globalement mais aussi limité à un utilisateur spécifique peut renvoyer des métadonnées différentes selon qui demande.

file_name
string | null

Le nom de fichier original du document.

markdown_content
string | null

Le contenu complet du document converti au format Markdown.