API Reference

Browse the major REST endpoints exposed by Tapistry. Download the full OpenAPI schema from /openapi.json on any deployment. Markdown source lives in docs/guides/API_REFERENCE.md.

Highlights

  • Authentication: `/auth/login`, `/auth/keys`, and `/auth/me` manage user sessions and platform keys.
  • Publishing: /apis/publish, /apis/{slug}/pipeline-runs, and /apis/{api_id}/promote drive releases.
  • Invocation: /invoke/{slug} executes APIs using the `X-Platform-Key` header.
  • Billing: `/billing/status`, `/billing/portal`, and `/billing/payouts` expose spend and revenue data.
  • Credentials: `/credentials` (DMK) and `/credentials/ubyok/*` (UBYOK) handle secret management.

Pair this reference with the CLI Reference for command equivalents and theSecurity guide to understand authentication requirements.