# 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 Conversations API
  version: 1.0.0
extends: openapi/dify-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 an end user's conversations
      effect: read
      questions:
      - How do I show a user their past chat conversations, most recent first?
      - Can I sort a user's conversation list by a different field?
      instructions:
      - text: List the conversations for end user {user}.
        slots:
          user: query.user
      - text: Show the {limit} most recently active conversations for {user}.
        slots:
          limit: query.limit
          user: query.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a conversation's message history
      effect: read
      questions:
      - What messages were exchanged in a given conversation?
      - Can I page back through older messages in a chat thread?
      instructions:
      - text: Show the message history of conversation {conversation_id}.
        slots:
          conversation_id: query.conversation_id
      - text: Load the messages in conversation {conversation_id} older than message {first_id}.
        slots:
          conversation_id: query.conversation_id
          first_id: query.first_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/{conversation_id}/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List the variables stored in a conversation
      effect: read
      questions:
      - Which conversation variables has my chatflow stored for this chat?
      - Can I look up a single conversation variable by its name?
      instructions:
      - text: List the stored variables in conversation {conversation_id}.
        slots:
          conversation_id: path.conversation_id
      - text: Get the variable named {variable_name} in conversation {conversation_id}.
        slots:
          variable_name: query.variable_name
          conversation_id: path.conversation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/{conversation_id}/name'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename or auto-title a conversation
      effect: write
      questions:
      - Can I give a conversation a custom title shown in the chat list?
      - Is there a way to have the app auto-generate a conversation's name from its messages?
      instructions:
      - text: Rename conversation {conversation_id} to {name}.
        slots:
          conversation_id: path.conversation_id
          name: requestBody.name
      - text: Auto-generate a title for conversation {conversation_id}.
        slots:
          conversation_id: path.conversation_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/{conversation_id}/variables/{variable_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a conversation variable's value
      effect: write
      questions:
      - How do I overwrite the value of a conversation variable mid-chat?
      - Does a new variable value have to match the variable's existing type?
      instructions:
      - text: Set variable {variable_id} in conversation {conversation_id} to {value}.
        slots:
          variable_id: path.variable_id
          conversation_id: path.conversation_id
          value: requestBody.value
      - text: Update conversation {conversation_id}'s variable {variable_id} with the new value {value}.
        slots:
          conversation_id: path.conversation_id
          variable_id: path.variable_id
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/conversations/{conversation_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a conversation
      effect: destructive
      questions:
      - How do I delete a chat conversation a user no longer wants?
      - Can I remove a conversation on behalf of a specific end user?
      instructions:
      - text: Delete conversation {conversation_id}.
        slots:
          conversation_id: path.conversation_id
      - text: Remove conversation {conversation_id} belonging to user {user}.
        slots:
          conversation_id: path.conversation_id
          user: requestBody.user
      method: generated
      generated: '2026-09-26'