Drippay · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Drip Events API
9 actions
9 updates
phrasing
extends
openapi/drippay-events-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Drippay's API. It is a proposal applied on top of the contract, not a document Drippay publishes.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/v1/customers/{customerId}/events'].get
$.paths['/v1/events'].get
$.paths['/v1/events'].post
$.paths['/v1/events/{id}'].get
$.paths['/v1/events/{id}/payload'].get
$.paths['/v1/events/{id}/trace'].get
$.paths['/v1/trace/{correlationId}'].get
$.paths['/v1/events/payloads'].get
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 Drip Events API
version: 1.0.0
extends: openapi/drippay-events-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: 8
- target: $.paths['/v1/customers/{customerId}/events'].get
update:
x-apievangelist-phrasing:
intent: Get a customer's execution events
effect: read
questions:
- What has one customer's agent been doing — can I see their events?
- Can I filter a customer's events to one workflow and a time window?
instructions:
- text: Show events for customer {customerId}.
slots:
customerId: path.customerId
- text: List {eventType} events for customer {customerId} from {from} to {to}.
slots:
eventType: query.eventType
customerId: path.customerId
from: query.from
to: query.to
- text: Show customer {customerId}'s events in workflow {workflowId}.
slots:
customerId: path.customerId
workflowId: query.workflowId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/events'].get
update:
x-apievangelist-phrasing:
intent: List execution events across the business
effect: read
questions:
- Which events happened inside a specific agent run?
- Can I find all failed LLM inference events across every customer?
- Is there a way to look up an event by its idempotency key?
instructions:
- text: List all events in run {runId}.
slots:
runId: query.runId
- text: List {eventType} events with outcome {outcome}.
slots:
eventType: query.eventType
outcome: query.outcome
- text: Find the event with idempotency key {idempotencyKey}.
slots:
idempotencyKey: query.idempotencyKey
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/events'].post
update:
x-apievangelist-phrasing:
intent: Record an execution event
effect: write
questions:
- How do I log what my agent did as an execution event?
- What are the only required fields when recording an event?
- Can I store an event's input and output payloads for later retrieval?
instructions:
- text: Record an event for customer {customerId} with idempotency key {idempotencyKey}.
slots:
customerId: requestBody.customerId
idempotencyKey: requestBody.idempotencyKey
- text: Log a {actionName} event with outcome {outcome} for {customerId}, key {idempotencyKey}.
slots:
actionName: requestBody.actionName
outcome: requestBody.outcome
customerId: requestBody.customerId
idempotencyKey: requestBody.idempotencyKey
- text: Record event {idempotencyKey} in run {runId} and keep its payloads ({storePayloads}).
slots:
idempotencyKey: requestBody.idempotencyKey
runId: requestBody.runId
storePayloads: requestBody.storePayloads
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/events/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an event's full details
effect: read
questions:
- What were the outcome, hashes and billing info for one event?
- Can I see an event's parent, children and retries in its record?
instructions:
- text: Show event {id}.
slots:
id: path.id
- text: Get full details for event {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/events/{id}/payload'].get
update:
x-apievangelist-phrasing:
intent: Get the stored payloads for an event
effect: read
questions:
- Can I retrieve the raw input and output my agent sent for one event?
- Why would an event's stored payload return not found?
instructions:
- text: Get the stored input and output payloads for event {id}.
slots:
id: path.id
- text: Fetch the raw payloads for {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/events/{id}/trace'].get
update:
x-apievangelist-phrasing:
intent: Trace an event's causality chain
effect: read
questions:
- What chain of events led to this one, and what did it cause?
- Can I see the retry chain and anomalies for a single event?
instructions:
- text: Trace the causality of event {id}.
slots:
id: path.id
- text: Show ancestors, children and retries for event {id} in {format} format.
slots:
id: path.id
format: query.format
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/trace/{correlationId}'].get
update:
x-apievangelist-phrasing:
intent: Trace events across runs by correlation ID
effect: read
questions:
- How do I follow one request across multiple agent runs and services?
- Which events share a correlation ID, grouped by run?
instructions:
- text: Trace everything with correlation ID {correlationId}.
slots:
correlationId: path.correlationId
- text: Show events for correlation {correlationId} grouped by run, as {format}.
slots:
correlationId: path.correlationId
format: query.format
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/events/payloads'].get
update:
x-apievangelist-phrasing:
intent: List events with payloads in flat rows
effect: read
questions:
- Can I export events with their inputs and outputs inlined as flat rows for SQL?
- Which events have a stored output payload?
instructions:
- text: List events with stored payloads for customer {customerId}.
slots:
customerId: query.customerId
- text: Export flat payload rows for action {actionName} from {from} to {to}.
slots:
actionName: query.actionName
from: query.from
to: query.to
method: generated
generated: '2026-09-26'