IntegrationOS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for One Actions API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/available-actions/search/{platform}'].get
$.paths['/v1/available-actions/{platform}'].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 One Actions API
  version: 1.0.0
extends: openapi/integration-os-actions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v1/available-actions/search/{platform}'].get
  update:
    x-apievangelist-phrasing:
      intent: Search a platform's actions by keyword
      effect: read
      questions:
      - How do I find the action that sends an email or creates a contact on a connected platform?
      - Can a keyword search over a platform's actions also return the knowledge docs for each match?
      - Is there a way to include deprecated actions when I search a platform by free text?
      instructions:
      - text: Search platform {platform} for actions matching "{query}".
        slots:
          platform: path.platform
          query: query.query
      - text: Search {platform} actions for "{query}" and include each match's knowledge document.
        slots:
          platform: path.platform
          query: query.query
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/available-actions/{platform}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the actions available on a platform
      effect: read
      questions:
      - What actions does a connected platform expose that I can run?
      - Can I list only the POST actions on a platform, or filter them by tag?
      instructions:
      - text: List page {page} of the actions available on {platform}.
        slots:
          page: query.page
          platform: path.platform
      - text: List the {method} actions on {platform} tagged {tags}, page {page}.
        slots:
          method: query.method
          platform: path.platform
          tags: query.tags
          page: query.page
      method: generated
      generated: '2026-10-01'