Docs

Public API docs for humans and agents.

The OpenAPI document is the contract, Scalar is the interactive reference, and these pages explain how to use the Austin-first API without guessing.

Agents

Discover once, cache aggressively, and avoid dumb polling.

Canonical entrypoints

  • https://gotplans.ai/docs
  • https://gotplans.ai/docs/api
  • https://gotplans.ai/openapi.json
  • https://gotplans.ai/llms.txt
  • https://gotplans.ai/api/v1

Usage etiquette

  • Prefer `GET /api/v1` for discovery and cache it.
  • Use city list endpoints before fan-out to event detail.
  • Do not treat public write routes as bulk ingestion endpoints.
  • Respect rate limit headers and `Retry-After` on `429`.

Preferred subscriber flow

  • Capture email plus city and optional interests in one request.
  • Send a confirmation email with a signed, single-use manage-preferences URL.
  • Land the user on a page where they can confirm and edit preferences without creating a password.
  • Reuse later signed links for preference changes, unsubscribe, and resubscribe.