> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ubik-agent.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ingestion de documents (fichiers ou URLs)

> Route unifiée pour ingérer des documents depuis diverses sources.

Cette route gère le téléversement de fichiers et le scraping d'URLs en une seule requête (multipart/form-data).

- Pour importer des fichiers, utilisez le champ 'files'.
- Pour scraper des URLs, utilisez le champ 'urls' (liste séparée par des virgules).
- Associez les documents à des espaces de travail via 'workspace_ids'.

**Note:** Les types de fichiers pris en charge dépendent des capacités actives du serveur (par exemple, les fichiers audio/vidéo nécessitent que la transcription soit activée).



## OpenAPI

````yaml /api-reference/openapi.fr.json post /documents
openapi: 3.1.0
info:
  title: UBIK Public API
  description: Publicly accessible API endpoints for UBIK.
  version: '1.0'
servers:
  - url: https://app.ubik-agent.com/api/v1
    description: Production Server
security: []
paths:
  /documents:
    post:
      tags:
        - Public API
        - Public API - Documents
      summary: Ingestion de documents (fichiers ou URLs)
      description: >-
        Route unifiée pour ingérer des documents depuis diverses sources.


        Cette route gère le téléversement de fichiers et le scraping d'URLs en
        une seule requête (multipart/form-data).


        - Pour importer des fichiers, utilisez le champ 'files'.

        - Pour scraper des URLs, utilisez le champ 'urls' (liste séparée par des
        virgules).

        - Associez les documents à des espaces de travail via 'workspace_ids'.


        **Note:** Les types de fichiers pris en charge dépendent des capacités
        actives du serveur (par exemple, les fichiers audio/vidéo nécessitent
        que la transcription soit activée).
      operationId: ingest_documents_documents_post
      parameters:
        - name: X-End-User-ID
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-End-User-Id
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_ingest_documents_documents_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PublicDocument'
                title: Response Ingest Documents Documents Post
        '400':
          description: Bad Request
          content:
            application/json:
              example:
                detail: Either 'files' or 'urls' must be provided.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    Body_ingest_documents_documents_post:
      properties:
        files:
          anyOf:
            - items:
                type: string
                format: binary
              type: array
            - type: 'null'
          title: Files
          description: Une liste de fichiers à importer.
        urls:
          anyOf:
            - type: string
            - type: 'null'
          title: Urls
          description: Une liste d'URLs à scraper, séparées par des virgules.
        workspace_ids:
          anyOf:
            - type: string
            - type: 'null'
          title: Workspace Ids
          description: >-
            Une liste d'IDs d'espaces de travail où ajouter les documents,
            séparées par des virgules.
        api_metadata:
          anyOf:
            - type: string
            - type: 'null'
          title: Api Metadata
          description: Métadonnées API personnalisées (chaîne JSON).
        scraping_mode:
          type: string
          title: Scraping Mode
          description: Mode de scraping ('Simple Scraping' ou 'Crawling').
          default: Simple Scraping
        crawl_depth:
          type: integer
          title: Crawl Depth
          description: La profondeur maximale pour le crawling des liens.
          default: 2
        same_domain_only:
          type: boolean
          title: Same Domain Only
          description: Indique s'il faut uniquement crawler les liens du même domaine.
          default: true
        limit:
          type: integer
          title: Limit
          description: Le nombre maximum de pages à crawler.
          default: 10
        delay:
          type: number
          title: Delay
          description: Le délai en secondes entre les requêtes.
          default: 1
        youtube_download_format:
          type: string
          title: Youtube Download Format
          description: >-
            Le format de téléchargement pour les vidéos YouTube ('audio' ou
            'video').
          default: audio
      type: object
      title: Body_ingest_documents_documents_post
    PublicDocument:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: L'identifiant unique du document.
        name:
          type: string
          title: Name
          description: Le nom d'affichage du document.
        file_type:
          anyOf:
            - type: string
            - type: 'null'
          title: File Type
          description: Le type MIME du fichier du document.
        status:
          type: string
          title: Status
          description: Le statut de traitement actuel du document.
        created_at:
          type: string
          format: date-time
          title: Created At
          description: L'horodatage de la création du document.
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: L'horodatage de la dernière mise à jour du document.
        processing_pipeline:
          anyOf:
            - type: string
            - type: 'null'
          title: Processing Pipeline
          description: Le nom du pipeline de traitement utilisé pour ce document.
        error_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Message
          description: Si le traitement a échoué, ce champ contiendra le message d'erreur.
        api_metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Api Metadata
          description: >-
            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:
          anyOf:
            - type: string
            - type: 'null'
          title: File Name
          description: Le nom de fichier original du document.
        markdown_content:
          anyOf:
            - type: string
            - type: 'null'
          title: Markdown Content
          description: Le contenu complet du document converti au format Markdown.
      type: object
      required:
        - id
        - name
        - status
        - created_at
        - updated_at
      title: PublicDocument
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-KEY

````