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

# Prévisualiser les recommandations d'automatisation

> Calcule une vue de recommandations sans persister d'état serveur.

**Scope requis :** `workflows:read`. [Scopes et délégation](/scopes-and-delegation).

[Workflows et extraction IA](/workflows-guide).



## OpenAPI

````yaml /openapi.json post /workflows/recommendations/preview
openapi: 3.1.0
info:
  title: MARKO External Partner API
  version: v1
  description: >-
    Stable external API contract for the live environment.


    Authentication flow for partner integrations:

    1. Generate an API key from the MARKO entity admin API section.

    2. Keep the raw API secret server-side and use it only to sign `POST
    /v1/auth/token`.

    3. Build the canonical message
    `MARKO-EXTERNAL-API-TOKEN-V1\n{key_id}\n{timestamp}\n{nonce}`.

    4. Sign that message with HMAC-SHA256 and send the hex signature with
    `key_id`, `timestamp` and `nonce`.

    5. Use the returned short-lived bearer on business endpoints as
    `Authorization: Bearer <access_token>`.

    The raw API secret must never be sent on business endpoints.


    This public contract intentionally excludes beta endpoints.


    Référence enrichie pour les développeurs et les assistants IA. Exemples
    synthétiques; les champs sont extraits des modèles et sérialiseurs de la
    version indiquée dans x-documentation-provenance.
servers:
  - url: https://partner-api.marko.fr/v1
security:
  - BearerAuth: []
tags:
  - name: auth
    x-group: Authentification
  - name: entity
    x-group: Entité
  - name: portfolio
    x-group: Portefeuille
  - name: deals
    x-group: Deals
  - name: fonds
    x-group: Fonds
  - name: spvs
    x-group: SPV
  - name: operations
    x-group: Opérations
  - name: taxonomies
    x-group: Taxonomies
  - name: import-jobs
    x-group: Imports par lot
  - name: comments
    x-group: Commentaires
  - name: documents
    x-group: Documents
  - name: users
    x-group: Utilisateurs
  - name: settings
    x-group: Paramètres
  - name: rcci
    x-group: Conformité RCCI
  - name: field-definitions
    x-group: Champs métier
  - name: search
    x-group: Recherche
  - name: operateurs
    x-group: Opérateurs
  - name: alerts
    x-group: Alertes
  - name: notifications
    x-group: Notifications
  - name: calendar
    x-group: Calendrier
  - name: enrichment
    x-group: Enrichissement SIREN
  - name: reports
    x-group: Exports
  - name: reporting
    x-group: Templates de reporting
  - name: workflows
    x-group: Workflows et extraction IA
  - name: tasks
    x-group: Tâches
externalDocs:
  description: Download the matching Postman collection.
  url: /v1/postman.json
paths:
  /workflows/recommendations/preview:
    post:
      tags:
        - workflows
      summary: Prévisualiser les recommandations d'automatisation
      description: >-
        Calcule une vue de recommandations sans persister d'état serveur.


        **Scope requis :** `workflows:read`. [Scopes et
        délégation](/scopes-and-delegation).


        [Workflows et extraction IA](/workflows-guide).
      operationId: workflows_recommendations-preview
      parameters:
        - in: header
          name: X-Request-ID
          required: false
          description: >-
            Partner-generated correlation identifier echoed in logs and error
            payloads.
          schema:
            type: string
          example: marko-workflows-recommendations-preview
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkflowRecommendationPreviewRequest'
            example:
              scope_type: entity
              scope_id: null
              only_high_priority: false
              include_dismissed: false
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRecommendations'
              example:
                scope_type: entity
                scope_id: null
                scope_label: Entity
                generated_at: '2026-10-01T10:00:00Z'
                items: []
                bundles: []
                kpis:
                  recommendations_total: 0
                  recommendation_acceptance_rate: 0
                  recommendation_dismiss_rate: 0
                  recommendation_snooze_rate: 0
                  time_to_activation_after_recommendation_hours: null
                  prefill_edit_rate: 0
                  workflow_disabled_soon_after_activation_rate: 0
                  workflow_utility_score: 0
                  monthly_false_positive_count: 0
                  monthly_false_negative_proxy_count: 0
        '401':
          description: Authentication required
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Unauthorized
                status: 401
                detail: A valid bearer token is required.
                request_id: req_example_partner_call
        '403':
          description: Scope, route or IP restriction
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Forbidden
                status: 403
                detail: The API key does not allow this operation.
                request_id: req_example_partner_call
        '422':
          description: Validation failed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Unprocessable Content
                status: 422
                detail: The request payload or parameters are invalid.
                request_id: req_example_partner_call
        '429':
          description: Rate limit or progressive ban
          headers:
            Retry-After:
              description: Cooldown in seconds before retrying the request.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Too Many Requests
                status: 429
                detail: The request rate limit was exceeded.
                request_id: req_example_partner_call
        '500':
          description: Unexpected server error
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
              example:
                type: about:blank
                title: Internal Server Error
                status: 500
                detail: An unexpected server error occurred.
                request_id: req_example_partner_call
      deprecated: false
      security:
        - BearerAuth: []
components:
  schemas:
    WorkflowRecommendationPreviewRequest:
      properties:
        scope_type:
          type: string
          maxLength: 20
          title: Scope Type
          default: entity
          description: Périmètre auquel la recommandation ou l'objet se rapporte.
        scope_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Scope Id
          description: >-
            Identifiant de la ressource du périmètre; il peut être absent pour
            le périmètre entité.
        only_high_priority:
          type: boolean
          title: Only High Priority
          default: false
          description: Limiter aux recommandations de priorité élevée.
        include_dismissed:
          type: boolean
          title: Include Dismissed
          default: false
          description: Inclure les recommandations classées comme non pertinentes.
      type: object
      title: WorkflowRecommendationPreviewRequest
    WorkflowRecommendations:
      type: object
      properties:
        scope_type:
          type: string
          description: Périmètre auquel la recommandation ou l'objet se rapporte.
        scope_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          description: >-
            Identifiant de la ressource du périmètre; il peut être absent pour
            le périmètre entité.
        scope_label:
          type: string
          description: Nom lisible du périmètre des recommandations.
        generated_at:
          type: string
          format: date-time
          description: Date de génération des recommandations.
        items:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowRecommendation'
          description: Résultats de la page courante.
        bundles:
          type: array
          items:
            $ref: '#/components/schemas/RecommendationBundle'
          description: >-
            Recommandations regroupées par thème et accompagnées de leurs
            compteurs.
        kpis:
          $ref: '#/components/schemas/RecommendationKPIs'
          description: >-
            Indicateurs de suivi des recommandations, distincts des KPI
            financiers d'une opération.
      required:
        - scope_type
        - scope_id
        - scope_label
        - generated_at
        - items
        - bundles
        - kpis
    ProblemDetails:
      type: object
      required:
        - title
        - status
        - detail
      properties:
        type:
          type: string
          default: about:blank
          description: >-
            URI identifiant le type de problème; about:blank lorsque seul le
            statut HTTP le caractérise.
        title:
          type: string
          description: Titre affiché pour l'événement ou le problème.
        status:
          type: integer
          description: Statut HTTP de la réponse d'erreur.
        detail:
          type: string
          description: Informations détaillées sur le problème ou le dossier.
        request_id:
          type: string
          description: Identifiant de corrélation pour le diagnostic de la requête.
        scope:
          type: string
          description: Scope concerné par le refus d'accès, lorsqu'il est renseigné.
        route_id:
          type: string
          description: Identifiant de la route concernée par le problème.
        reason_code:
          type: string
          description: >-
            Code structuré du motif de refus; préférable au texte du message
            pour le diagnostic.
    WorkflowRecommendation:
      type: object
      properties:
        id:
          type: string
          description: >-
            UUID après matérialisation; identifiant preview-* dans une
            prévisualisation.
        scope_type:
          type: string
          description: Périmètre auquel la recommandation ou l'objet se rapporte.
        scope_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          description: >-
            Identifiant de la ressource du périmètre; il peut être absent pour
            le périmètre entité.
        bundle_key:
          type: string
          description: Clé du groupe de recommandations à matérialiser.
        bundle_label:
          type: string
          description: Libellé du groupe de recommandations.
        workflow_key:
          type: string
          description: Clé du workflow proposé dans le groupe de recommandations.
        workflow_label:
          type: string
          description: Nom du workflow proposé par la recommandation.
        workflow_type:
          type: string
          description: Type de traitement du workflow proposé.
        title:
          type: string
          description: Titre affiché pour l'événement ou le problème.
        description:
          type: string
          description: Description libre de la ressource.
        expected_impact:
          type: string
          description: Effet métier attendu de la recommandation.
        score:
          type: number
          description: Score de classement de la recommandation.
        confidence:
          type: number
          description: >-
            Confiance associée à la recommandation, distincte de son score de
            classement.
        priority:
          type: string
          enum:
            - critical
            - recommended
            - optional
          description: >-
            Priorité de l'élément; les valeurs acceptées figurent dans le
            schéma.
        priority_label:
          type: string
          description: Libellé de la priorité de la recommandation.
        reason_codes:
          type: array
          items:
            type: string
          description: Codes des motifs ayant conduit à cette recommandation.
        evidence:
          type: array
          items:
            type: object
            additionalProperties: true
            description: Éléments de preuve spécifiques au générateur de la recommandation.
          description: >-
            Données utilisées pour établir la recommandation; ne constituent pas
            à elles seules une autorisation d'écriture.
        prefill:
          type: object
          additionalProperties: true
          description: Objet JSON métier; les clés dépendent de la source ou du preset.
        status:
          type: string
          description: >-
            État de la recommandation: proposed, accepted, dismissed, snoozed ou
            created. created indique qu'un workflow a été créé depuis cette
            recommandation.
        accepted_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: Date d'acceptation de la demande ou de la recommandation.
        dismissed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: Date à laquelle la recommandation a été classée non pertinente.
        snoozed_until:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: Date jusqu'à laquelle l'alerte ou la recommandation est reportée.
        created_workflow_key:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Clé du workflow créé depuis la recommandation, si cette création a
            eu lieu.
        workflow_created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: Date de création du workflow issu de cette recommandation.
        feedback:
          type: object
          additionalProperties: true
          description: Objet JSON métier; les clés dépendent de la source ou du preset.
        impact_metrics:
          type: object
          additionalProperties: true
          description: Objet JSON métier; les clés dépendent de la source ou du preset.
        note:
          anyOf:
            - type: string
            - type: 'null'
          description: Commentaire associé à la décision sur la recommandation.
      required:
        - id
        - scope_type
        - scope_id
        - bundle_key
        - bundle_label
        - workflow_key
        - workflow_label
        - workflow_type
        - title
        - description
        - expected_impact
        - score
        - confidence
        - priority
        - priority_label
        - reason_codes
        - evidence
        - prefill
        - status
        - feedback
        - impact_metrics
    RecommendationBundle:
      type: object
      properties:
        key:
          type: string
          description: Clé stable du preset ou du groupe de recommandations.
        label:
          type: string
          description: Libellé à afficher pour cette option, ce groupe ou ce preset.
        summary:
          type: string
          description: Résumé du groupe de recommandations.
        items:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowRecommendation'
          description: Résultats de la page courante.
        critical_count:
          type: integer
          description: Nombre d'éléments classés critiques dans ce groupe.
        recommended_count:
          type: integer
          description: Nombre de recommandations de priorité recommended dans ce groupe.
        optional_count:
          type: integer
          description: Nombre de recommandations optionnelles dans ce groupe.
      required:
        - key
        - label
        - summary
        - items
        - critical_count
        - recommended_count
        - optional_count
    RecommendationKPIs:
      type: object
      properties:
        recommendations_total:
          type: integer
          description: Nombre total de recommandations du périmètre.
        recommendation_acceptance_rate:
          type: number
          description: Taux d'acceptation des recommandations du périmètre.
        recommendation_dismiss_rate:
          type: number
          description: Taux de recommandations classées non pertinentes.
        recommendation_snooze_rate:
          type: number
          description: Taux de recommandations reportées.
        time_to_activation_after_recommendation_hours:
          anyOf:
            - type: number
            - type: 'null'
          description: Délai d'activation après recommandation, exprimé en heures.
        prefill_edit_rate:
          type: number
          description: Taux de modification des valeurs préremplies des recommandations.
        workflow_disabled_soon_after_activation_rate:
          type: number
          description: Taux de workflows désactivés peu après leur activation.
        workflow_utility_score:
          type: number
          description: >-
            Indicateur d'utilité des workflows dans le périmètre de
            recommandations.
        monthly_false_positive_count:
          type: integer
          description: Nombre mensuel de recommandations déclarées comme faux positifs.
        monthly_false_negative_proxy_count:
          type: integer
          description: >-
            Nombre mensuel d'événements utilisés comme indicateur indirect de
            faux négatifs; ce n'est pas un décompte exhaustif des erreurs.
      required:
        - recommendations_total
        - recommendation_acceptance_rate
        - recommendation_dismiss_rate
        - recommendation_snooze_rate
        - time_to_activation_after_recommendation_hours
        - prefill_edit_rate
        - workflow_disabled_soon_after_activation_rate
        - workflow_utility_score
        - monthly_false_positive_count
        - monthly_false_negative_proxy_count
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: MARKO short-lived bearer
      description: >-
        Use the `access_token` returned by `POST /v1/auth/token`. Do not send
        the raw API secret on business endpoints.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.