Dify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dify Service Completion Messages API

3 actions 3 updates phrasing extends openapi/dify-completion-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 3

$.info

$.paths['/completion-messages'].post

$.paths['/completion-messages/{task_id}/stop'].post

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 Dify Service Completion Messages API
  version: 1.0.0
extends: openapi/dify-completion-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: 2
- target: $.paths['/completion-messages'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate text with a text generator app
      effect: write
      questions:
      - How do I get generated text from my Dify text generator app?
      - Can I send files along with the input values to a completion app?
      instructions:
      - text: Run the text generator app with inputs {inputs} for user {user}.
        slots:
          inputs: requestBody.inputs
          user: requestBody.user
      - text: Generate a completion for {query} as end user {user} with inputs {inputs}.
        slots:
          query: requestBody.query
          user: requestBody.user
          inputs: requestBody.inputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/completion-messages/{task_id}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a streaming text completion
      effect: write
      questions:
      - Can I cancel a text generator completion that is still streaming?
      - What stops a runaway completion task in my text generation app?
      instructions:
      - text: Stop completion task {task_id} for user {user}.
        slots:
          task_id: path.task_id
          user: requestBody.user
      - text: Halt the text generator output for task {task_id} started by {user}.
        slots:
          task_id: path.task_id
          user: requestBody.user
      method: generated
      generated: '2026-09-26'