Generated by API Evangelist
Written by API Evangelist tooling for ZoomInfo's API. It is a proposal applied on top of the contract, not a document ZoomInfo publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Platform API V1 Workflows API
version: 1.0.0
extends: openapi/zoominfo-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: 3
- target: $.paths['/platform/v1/workflows'].get
update:
x-apievangelist-phrasing:
intent: List workflows
effect: read
questions:
- Which workflows can I run on demand?
- Can I list only active workflows or find one by name?
instructions:
- text: List my workflows.
- text: Find workflows named {name}.
slots:
name: query.filter[name]
- text: List workflows that are runnable on demand {onDemand}.
slots:
onDemand: query.filter[runnableOnDemand]
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/v1/workflows/{id}/actions/execute'].post
update:
x-apievangelist-phrasing:
intent: Run a workflow
effect: write
questions:
- How do I trigger a workflow to run now?
- Can I pass inputs when I execute a workflow?
instructions:
- text: Execute workflow {id}.
slots:
id: path.id
- text: Run workflow {id} with {inputs}.
slots:
id: path.id
inputs: requestBody.data
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/v1/workflows/executions/{id}'].get
update:
x-apievangelist-phrasing:
intent: Check a workflow execution's status
effect: read
questions:
- Did my workflow execution finish?
- What's the status of a workflow run I started?
instructions:
- text: Get the status of workflow execution {id}.
slots:
id: path.id
- text: Check whether execution {id} has completed.
slots:
id: path.id
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.