Dify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dify Service Chat Messages API

4 actions 4 updates phrasing extends openapi/dify-chat-messages-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Dify's API. It is a proposal applied on top of the contract, not a document Dify publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/chat-messages'].post
$.paths['/chat-messages/{task_id}/stop'].post
$.paths['/messages/{message_id}/suggested'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Dify Service Chat Messages API
  version: 1.0.0
extends: openapi/dify-chat-messages-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: 3
- target: $.paths['/chat-messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a message to a chat app and get a reply
      effect: write
      questions:
      - 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?
      - Is it possible to stream the reply as server-sent events rather than wait for it?
      instructions:
      - text: Send {query} to the chat app as user {user}.
        slots:
          query: requestBody.query
          user: requestBody.user
      - text: Continue conversation {conversation_id} for user {user} with the message {query}.
        slots:
          conversation_id: requestBody.conversation_id
          user: requestBody.user
          query: requestBody.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/chat-messages/{task_id}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a streaming chat reply mid-generation
      effect: write
      questions:
      - 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?
      instructions:
      - text: Stop chat reply task {task_id} for user {user}.
        slots:
          task_id: path.task_id
          user: requestBody.user
      - text: Halt the streaming chatbot answer with task {task_id} started by {user}.
        slots:
          task_id: path.task_id
          user: requestBody.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/messages/{message_id}/suggested'].get
  update:
    x-apievangelist-phrasing:
      intent: Get suggested follow-up questions for a message
      effect: read
      questions:
      - What follow-up questions does the app suggest after a given answer?
      - Can I show users next-question suggestions under a chat reply?
      instructions:
      - text: Get the suggested follow-up questions for message {message_id} for user {user}.
        slots:
          message_id: path.message_id
          user: query.user
      - text: Show next-question suggestions for chat message {message_id} as seen by {user}.
        slots:
          message_id: path.message_id
          user: query.user
      method: generated
      generated: '2026-09-26'