Slack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Slack Add API

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/admin.emoji.add'].post
$.paths['/calls.add'].post
$.paths['/calls.participants.add'].post
$.paths['/files.remote.add'].post
$.paths['/reminders.add'].post
$.paths['/stars.add'].post

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 Slack Add API
  version: 1.0.0
extends: openapi/slack-add-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['/admin.emoji.add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a custom emoji to the workspace
      effect: write
      questions:
      - How do I upload a custom emoji to our Slack workspace as an admin?
      - What does a new emoji need, a name and an image URL?
      instructions:
      - text: Add custom emoji {name} using the image at {url}.
        slots:
          name: requestBody.name
          url: requestBody.url
      - text: 'Create the :{name}: emoji from {url}.'
        slots:
          name: requestBody.name
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/calls.add'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new call
      effect: write
      questions:
      - Can my video app register a call so it shows up in a channel?
      - What join URL and ID do I need to register a call?
      instructions:
      - text: Register call {external_unique_id} with join link {join_url}.
        slots:
          external_unique_id: requestBody.external_unique_id
          join_url: requestBody.join_url
      - text: Register a call titled {title} starting at {date_start} joinable at {join_url} with ID {external_unique_id}.
        slots:
          title: requestBody.title
          date_start: requestBody.date_start
          join_url: requestBody.join_url
          external_unique_id: requestBody.external_unique_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/calls.participants.add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add participants to a registered call
      effect: write
      questions:
      - How do I show that new people have joined a call my app registered?
      - Can I register several participants joining a call at once?
      instructions:
      - text: Add participants {users} to call {id}.
        slots:
          users: requestBody.users
          id: requestBody.id
      - text: Record that {users} joined the registered call {id}.
        slots:
          users: requestBody.users
          id: requestBody.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/files.remote.add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a file from a remote service
      effect: write
      questions:
      - Can I add a file that lives in my own service to Slack without uploading it?
      - Is it possible to make a remote file's contents searchable?
      instructions:
      - text: Add remote file {title} at {external_url} with external ID {external_id}.
        slots:
          title: requestBody.title
          external_url: requestBody.external_url
          external_id: requestBody.external_id
      - text: Register the remote {filetype} file {external_id} with preview image {preview_image}.
        slots:
          filetype: requestBody.filetype
          external_id: requestBody.external_id
          preview_image: requestBody.preview_image
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reminders.add'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reminder
      effect: write
      questions:
      - Can I set a reminder for myself or a teammate?
      - What time formats does creating a reminder accept?
      instructions:
      - text: Remind me to {text} at {time}.
        slots:
          text: requestBody.text
          time: requestBody.time
      - text: Set a reminder for {user} to {text} at {time}.
        slots:
          user: requestBody.user
          text: requestBody.text
          time: requestBody.time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stars.add'].post
  update:
    x-apievangelist-phrasing:
      intent: Star a message, file or channel
      effect: write
      questions:
      - How do I save a message for later by starring it?
      - Which things can be starred, a file, a channel or a message?
      instructions:
      - text: Star the message at {timestamp} in {channel}.
        slots:
          timestamp: requestBody.timestamp
          channel: requestBody.channel
      - text: Add a star to file {file}.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-09-26'