Loops · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Loops OpenAPI Spec Workflows API

6 actions 6 updates phrasing extends openapi/loops-workflows-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Loops's API. It is a proposal applied on top of the contract, not a document Loops publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v1/workflows'].get

$.paths['/v1/workflows'].post

$.paths['/v1/workflows/{workflowId}'].get

$.paths['/v1/workflows/{workflowId}'].post

$.paths['/v1/workflows/{workflowId}/mailing-list'].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 Loops OpenAPI Spec Workflows API
  version: 1.0.0
extends: openapi/loops-workflows-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: 5
- target: $.paths['/v1/workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflows
      effect: read
      questions:
      - What automated workflows do I have?
      - Can I page through my workflows?
      instructions:
      - text: List my workflows.
      - text: Show workflows from cursor {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/workflows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a draft workflow
      effect: write
      questions:
      - How do I start a new email automation workflow?
      - Can I attach a mailing list when creating a workflow?
      instructions:
      - text: Create a workflow named {name}.
        slots:
          name: requestBody.name
      - text: Create draft workflow {name} for mailing list {mailingListId}.
        slots:
          name: requestBody.name
          mailingListId: requestBody.mailingListId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/workflows/{workflowId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow's graph
      effect: read
      questions:
      - How do I see all the steps and connections in a workflow?
      - What is the current revision ID of a workflow?
      instructions:
      - text: Show workflow {workflowId}.
        slots:
          workflowId: path.workflowId
      - text: Get the node graph of workflow {workflowId}.
        slots:
          workflowId: path.workflowId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/workflows/{workflowId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a workflow
      effect: write
      questions:
      - How do I rename an existing workflow?
      - Can I update a workflow's description?
      instructions:
      - text: Rename workflow {workflowId} to {name} at revision {expectedRevisionId}.
        slots:
          workflowId: path.workflowId
          name: requestBody.name
          expectedRevisionId: requestBody.expectedRevisionId
      - text: Set workflow {workflowId}'s description to {description}, revision {expectedRevisionId}.
        slots:
          workflowId: path.workflowId
          description: requestBody.description
          expectedRevisionId: requestBody.expectedRevisionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/workflows/{workflowId}/mailing-list'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a workflow's mailing list
      effect: write
      questions:
      - How do I switch which mailing list a workflow sends to?
      - What happens to queued contacts when a workflow's list changes?
      instructions:
      - text: Switch workflow {workflowId} to mailing list {mailingListId} at revision {expectedRevisionId}.
        slots:
          workflowId: path.workflowId
          mailingListId: requestBody.mailingListId
          expectedRevisionId: requestBody.expectedRevisionId
      - text: Dry-run changing workflow {workflowId}'s list to {mailingListId}, revision {expectedRevisionId}, dryRun {dryRun}.
        slots:
          workflowId: path.workflowId
          mailingListId: requestBody.mailingListId
          expectedRevisionId: requestBody.expectedRevisionId
          dryRun: requestBody.dryRun
      method: generated
      generated: '2026-09-26'