API Reference

The rendered API reference is generated from Alfred's client OpenAPI 3.1 document. Request schemas for workflow triggers are generated from the same Zod schemas used at runtime.

Client OpenAPI JSON

Download the machine-readable client contract.

Operator OpenAPI JSON

Download the separate health, observability, and administration contract.

Service Capabilities

Review the five workflows and configuration-gated surfaces.

Workflow Reference

Understand trigger identity, supported workflows, and errors.

Execution Reference

Understand execution resources, stages, and controls.

Event Reference

Understand event versions and delivery semantics.

Generated operation pages

Endpoint pages below this entry are generated from /openapi.json. Do not hand-copy their schemas into authored pages. /openapi.operator.json is downloadable for operators but does not generate pages in this reference.

Adapter ingress hooks for Slack, GitHub, and Zendesk are excluded from both contracts. They are platform integrations, not client SDK operations.

Base Contract

Content type: application/json
Authentication: bearer API key unless the operation is explicitly public
Workflow submission: asynchronous
Workflow delivery: Idempotency-Key required
Google Maps recovery: POST /v1/executions/{id}/retry-maps-whitelist
Error bodies: stable error code plus human-readable context
Schema dialect: JSON Schema Draft 2020-12

Use generated operation pages for exact parameters, bodies, responses, and examples. Generated operation pages are the exact HTTP contract. Authored guides provide end-to-end procedures, integration sequencing, and recovery decisions; they link back to the generated contract instead of duplicating it.