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.

API referenceOpenAPI JSONAPI index

Quickstart

Make one read request, then one write request.

Conventions

  • Read routes are unauthenticated in v1.
  • Write routes are public but rate-limited and abuse-monitored.
  • All public API payloads are JSON.
  • Rate limit headers are documented at /docs/rate-limits.

Recommended order

  • Start with `GET /api/v1` to discover the current contract.
  • Use city list and event list endpoints before fan-out to event detail.
  • Use subscriber writes for one user at a time, not bulk import.

Step 1

Read the API index

curl "https://gotplans.ai/api/v1"

Step 2

List Austin events

curl "https://gotplans.ai/api/v1/cities/austin/events?limit=5&interest=music"

Step 3

Create or update a subscriber

curl -X POST "https://gotplans.ai/api/v1/subscribers" \
  -H "Content-Type: application/json" \
  -d '{"email":"andrew@example.com","citySlugs":["austin"],"interestSlugs":["run-clubs","music"],"source":"api"}'