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

# Ajouter des valeurs (upsert)

> 1 000 valeurs max par appel. Renvoyer une valeur existante ne fait
rien. Les valeurs invalides sont listées dans `invalid` sans faire
échouer la requête.




## OpenAPI

````yaml /openapi.yaml post /v1/exclusions/{kind}
openapi: 3.1.0
info:
  title: Retriever Public API
  version: 1.0.0
  description: >
    API publique de Retriever : lancer l'agent de prospection (runs), lire et

    exporter des tables, importer des données, synchroniser des listes

    d'exclusion, lancer des recherches structurées (Go) et appeler des services

    atomiques.


    **Authentification** : `Authorization: Bearer ret_live_…`. Créez la clé dans

    l'application : Paramètres → **Clés API** → **Créer une clé API**. La clé
    donne accès aux ressources de

    l'organisation de son propriétaire.


    **Erreurs** : toutes les erreurs HTTP ont la forme

    `{ "error": { "code": "…", "message": "…", "details": … } }`.

    Branchez votre code sur `error.code` (stable), jamais sur `message`.


    **Limites de débit** : les réponses authentifiées par clé portent

    `RateLimit-Limit`, `RateLimit-Remaining` et `RateLimit-Reset` (secondes).

    Une réponse `429` porte aussi `Retry-After` (secondes).


    Les messages d'erreur de l'API sont en anglais.
  contact:
    name: Retriever
servers:
  - url: https://api.retriever.run
    description: Production
  - url: http://localhost:4320
    description: Serveur local
security:
  - bearerAuth: []
tags:
  - name: Runs
    description: Agent de prospection « prompt in, table out ». Asynchrone.
  - name: Tables
    description: Lecture des tables vivantes d'un workspace.
  - name: Workspaces
    description: Créer des workspaces et importer des tables.
  - name: Exclusions
    description: Listes d'entreprises et de personnes à ne jamais sourcer.
  - name: Go
    description: Recherche web autonome et extraction structurée.
  - name: Services
    description: Services atomiques (recherche, scraping, email…).
  - name: Credits
    description: Solde de crédits.
paths:
  /v1/exclusions/{kind}:
    post:
      tags:
        - Exclusions
      summary: Ajouter des valeurs (upsert)
      description: |
        1 000 valeurs max par appel. Renvoyer une valeur existante ne fait
        rien. Les valeurs invalides sont listées dans `invalid` sans faire
        échouer la requête.
      operationId: upsertExclusions
      parameters:
        - $ref: '#/components/parameters/ExclusionKind'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExclusionValues'
            examples:
              companies:
                value:
                  domains:
                    - stripe.com
                    - https://www.salesforce.com
              people:
                value:
                  linkedin_urls:
                    - https://www.linkedin.com/in/johndoe
      responses:
        '200':
          description: Résumé.
          content:
            application/json:
              schema:
                type: object
                required:
                  - inserted
                  - existing
                  - invalid
                properties:
                  inserted:
                    type: integer
                  existing:
                    type: integer
                  invalid:
                    type: array
                    items:
                      $ref: '#/components/schemas/InvalidExclusionValue'
              example:
                inserted: 1
                existing: 1
                invalid:
                  - value: not a domain
                    reason: company_domain_required
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  parameters:
    ExclusionKind:
      name: kind
      in: path
      required: true
      schema:
        type: string
        enum:
          - companies
          - people
  schemas:
    ExclusionValues:
      oneOf:
        - type: object
          additionalProperties: false
          required:
            - domains
          properties:
            domains:
              type: array
              minItems: 1
              maxItems: 1000
              items:
                type: string
        - type: object
          additionalProperties: false
          required:
            - linkedin_urls
          properties:
            linkedin_urls:
              type: array
              minItems: 1
              maxItems: 1000
              items:
                type: string
                description: URL `linkedin.com/in/…`. Un handle seul est invalide.
    InvalidExclusionValue:
      type: object
      required:
        - value
        - reason
      properties:
        value:
          type: string
        reason:
          type: string
          enum:
            - company_domain_required
            - linkedin_url_required
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Code stable, à utiliser dans votre code.
            message:
              type: string
              description: Explication lisible. Peut changer.
            details:
              description: Détails optionnels (ex. liste des champs invalides).
  responses:
    BadRequest:
      description: >-
        `invalid_request` : JSON illisible, champ ou paramètre de requête
        inconnu, type incorrect, `limit` hors bornes, `Idempotency-Key` vide,
        contrat `output` invalide. `message` nomme chaque champ en faute,
        `details` les liste sous forme `{ path, message }`. Sur `POST /v1/runs`,
        `workspace_mismatch` : la conversation n'appartient pas au workspace
        fourni.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_request
              message: 'prompt: prompt must not be blank'
              details:
                - path: prompt
                  message: prompt must not be blank
    Unauthorized:
      description: >-
        `not_authenticated` : header absent, mal formé (attendu `Bearer <clé>`),
        clé révoquée ou inconnue.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_authenticated
              message: A valid API key is required.
    UnsupportedMediaType:
      description: '`invalid_request` : ajoutez `Content-Type: application/json`.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_request
              message: Content-Type must be application/json.
    TooManyRequests:
      description: '`rate_limited` : attendez `Retry-After` secondes puis réessayez.'
      headers:
        Retry-After:
          schema:
            type: integer
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: rate_limited
              message: Rate limit exceeded. Retry later.
  headers:
    RateLimit-Limit:
      schema:
        type: integer
      description: Budget de la fenêtre.
    RateLimit-Remaining:
      schema:
        type: integer
      description: Requêtes restantes.
    RateLimit-Reset:
      schema:
        type: integer
      description: Secondes avant la remise à zéro.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Clé API `ret_live_…` créée dans Settings → API keys.

````