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 reference OpenAPI JSON API index

Overview

Start from the API index, then go deeper by task.

What is public now

Read endpoints for cities, event lists, and event detail.
Public write endpoints for subscribers, submissions, and feedback.
OpenAPI 3.1 contract and interactive API reference.
Rate-limited public usage with classic 429 headers.

Best first links

/api/v1 for discovery and public metadata
/docs/quickstart for first successful requests
/docs/agents for machine usage guidance
/docs/api for the full reference

Guides

Read by outcome instead of reverse-engineering payloads.

Quickstart

First successful reads and writes against the Austin-first API.

Open quickstart

Events

Event list filters, pagination, detail payloads, and source attribution.

Open events

Subscribers

Subscriber signup, autosave behavior, and how city and interest preferences are stored.

Open subscribers

Submissions

Public event submission intake, moderation semantics, and response payloads.

Open submissions

Rate limits

Public rate limit policy, headers, and retry guidance for reads and writes.

Open rate limits

Agents

Agent-specific discovery, usage etiquette, and preferred subscriber flow.

Open agents

Current Austin-first contract

The API index remains the canonical machine starting point.

GET

/api/v1

Machine-readable index of the public API, discovery URLs, and product recommendations.

GET

/api/v1/cities

List configured markets and their site/API URLs.

GET

/api/v1/cities/{citySlug}/events

List a city's events with filters for date windows, interest, format, free-only, and query text, including occurrence time, venue, and source attribution.

GET

/api/v1/events/{eventId}

Get one event with all currently known occurrences, source links, and summaries.

POST

/api/v1/subscribers

Create or update one newsletter subscriber with city and interest preferences.

POST

/api/v1/submissions

Submit an event for moderation.

POST

/api/feedback

Send product feedback or request new Austin coverage categories.

GET

/openapi.json

Machine-readable OpenAPI 3.1 document for the public contract.