Mirakl

Mirakl Conversations API

The Conversations API from Mirakl — 5 operation(s) for conversations.

GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /conversations Start a conversation with a customer · createConversation - Create a new conversation #
Ask an LLM
“How do I start a new conversation with a marketplace customer?”
“Is creating a conversation processed immediately or asynchronously?”
Tell an agent
Create conversation {conversation}.
Open a conversation {conversation} with attachments {files}.
GET /conversations List order conversations · listConversations - List all order conversations #
Ask an LLM
“Which customer conversations have changed since my last sync?”
“Can I list conversations for specific orders in Mirakl Connect?”
Tell an agent
List conversations updated since {updated_from}.
Show conversations for {entity_type} {entity_ids}.
POST /conversations/{conversationId}/messages Send a message in a conversation · createMessage - Create a message in a conversation #
Ask an LLM
“How do I reply to a customer inside an existing conversation?”
“Can I attach files when messaging a customer in a conversation?”
Tell an agent
Send {message_input} in conversation {conversationId}.
Reply in conversation {conversationId} with {message_input} and files {files}.
GET /conversations/{conversationId}/attachments Download conversation attachments · downloadConversationAttachments - Download attachments of a conversation #
Ask an LLM
“How do I get all the files shared in a conversation?”
“Can I download only selected attachments as a ZIP?”
Tell an agent
Download attachments of conversation {conversationId}.
Download attachments {attachment_ids} from conversation {conversationId}.
GET /conversations/actions/{actionId} Check a conversation action's status · getConversationActionStatus - Get action status #
Ask an LLM
“Did my asynchronous conversation request succeed?”
“How do I track the processing of a conversation I just created?”
Tell an agent
Get the status of conversation action {actionId}.
Check whether action {actionId} finished processing.
GET /conversations/{conversationId} Get a conversation's messages · getConversationMessages - Get messages for a conversation #
Ask an LLM
“What messages have been exchanged in a conversation?”
“Can I fetch only the messages sent after a certain one?”
Tell an agent
Get messages of conversation {conversationId}.
Show messages in conversation {conversationId} after {message_after}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-conversations-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/mirakl:mirakl-conversations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mirakl-conversations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: '{% partial file="/partial-content/product/connect/rest/connect/openapi-description.md" /%}'
  title: Mirakl Connect Conversations API
  version: ''
servers:
- description: Connect Production endpoint
  url: https://miraklconnect.com/api
tags:


# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-conversations-api-openapi.yml