Dify

Dify Chat Messages API

Operations related to chat messages and interactions.

GitHub OpenAPI

Operations 3

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 /chat-messages Send a message to a chat app and get a reply · Send Chat Message #
Ask an LLM
“How do I send a user's message to my Dify chatbot and get the assistant's reply?”
“Can I continue an existing conversation instead of starting a new one?”
Tell an agent
Send {query} to the chat app as user {user}.
Continue conversation {conversation_id} for user {user} with the message {query}.
POST /chat-messages/{task_id}/stop Stop a streaming chat reply mid-generation · Stop Chat Message Generation #
Ask an LLM
“Can I cancel a chat response that is still streaming?”
“Why did stopping a chat reply do nothing when I used a different user ID?”
Tell an agent
Stop chat reply task {task_id} for user {user}.
Halt the streaming chatbot answer with task {task_id} started by {user}.
GET /messages/{message_id}/suggested Get suggested follow-up questions for a message · Get Next Suggested Questions #
Ask an LLM
“What follow-up questions does the app suggest after a given answer?”
“Can I show users next-question suggestions under a chat reply?”
Tell an agent
Get the suggested follow-up questions for message {message_id} for user {user}.
Show next-question suggestions for chat message {message_id} as seen by {user}.

Documentation

📖
Documentation
https://docs.dify.ai/
📖
APIReference
https://docs.dify.ai/en/api-reference
📖
GettingStarted
https://docs.dify.ai/en/api-reference/guides/get-started

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/dify/refs/heads/main/openapi/dify-chat-messages-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/dify:dify-chat-messages-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

dify-chat-messages-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Dify Service Chat Messages API
  description: REST API for Dify applications and knowledge bases. Application endpoints authenticate with an app API key; knowledge endpoints authenticate with a dataset API key.
  version: 1.0.0
servers:
- url: https://{api_base_url}
  description: Base URL of the Dify Service API. For self-hosted deployments, replace it with your own API base URL.
  variables:
    api_base_url:
      default: api.dify.ai/v1
      description: Host and path of the API base URL, without the `https://` prefix.
security:
- ApiKeyAuth: []
tags:


# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dify/refs/heads/main/openapi/dify-chat-messages-api-openapi.yml