Mirakl · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Mirakl Connect Conversations API

7 actions 7 updates phrasing extends openapi/mirakl-conversations-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Mirakl's API. It is a proposal applied on top of the contract, not a document Mirakl publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/conversations'].get

$.paths['/conversations'].post

$.paths['/conversations/{conversationId}/messages'].post

$.paths['/conversations/{conversationId}/attachments'].get

$.paths['/conversations/actions/{actionId}'].get

$.paths['/conversations/{conversationId}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mirakl Connect Conversations API
  version: 1.0.0
extends: openapi/mirakl-conversations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/conversations'].get
  update:
    x-apievangelist-phrasing:
      intent: List order conversations
      effect: read
      questions:
      - Which customer conversations have changed since my last sync?
      - Can I list conversations for specific orders in Mirakl Connect?
      instructions:
      - text: List conversations updated since {updated_from}.
        slots:
          updated_from: query.updated_from
      - text: Show conversations for {entity_type} {entity_ids}.
        slots:
          entity_type: query.entity_type
          entity_ids: query.entity_ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a conversation with a customer
      effect: write
      questions:
      - How do I start a new conversation with a marketplace customer?
      - Is creating a conversation processed immediately or asynchronously?
      instructions:
      - text: Create conversation {conversation}.
        slots:
          conversation: requestBody.conversation
      - text: Open a conversation {conversation} with attachments {files}.
        slots:
          conversation: requestBody.conversation
          files: requestBody.files
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/{conversationId}/messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a message in a conversation
      effect: write
      questions:
      - How do I reply to a customer inside an existing conversation?
      - Can I attach files when messaging a customer in a conversation?
      instructions:
      - text: Send {message_input} in conversation {conversationId}.
        slots:
          message_input: requestBody.message_input
          conversationId: path.conversationId
      - text: Reply in conversation {conversationId} with {message_input} and files {files}.
        slots:
          conversationId: path.conversationId
          message_input: requestBody.message_input
          files: requestBody.files
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/{conversationId}/attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: Download conversation attachments
      effect: read
      questions:
      - How do I get all the files shared in a conversation?
      - Can I download only selected attachments as a ZIP?
      instructions:
      - text: Download attachments of conversation {conversationId}.
        slots:
          conversationId: path.conversationId
      - text: Download attachments {attachment_ids} from conversation {conversationId}.
        slots:
          attachment_ids: query.attachment_ids
          conversationId: path.conversationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/actions/{actionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a conversation action's status
      effect: read
      questions:
      - Did my asynchronous conversation request succeed?
      - How do I track the processing of a conversation I just created?
      instructions:
      - text: Get the status of conversation action {actionId}.
        slots:
          actionId: path.actionId
      - text: Check whether action {actionId} finished processing.
        slots:
          actionId: path.actionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/{conversationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a conversation's messages
      effect: read
      questions:
      - What messages have been exchanged in a conversation?
      - Can I fetch only the messages sent after a certain one?
      instructions:
      - text: Get messages of conversation {conversationId}.
        slots:
          conversationId: path.conversationId
      - text: Show messages in conversation {conversationId} after {message_after}.
        slots:
          conversationId: path.conversationId
          message_after: query.message_after
      method: generated
      generated: '2026-09-26'