# AiPSEO Public API

> Owner control-plane documentation for https://api.aipseo.com
> Readable without API credentials. Live browser execution is disabled.

## Machine contract

- OpenAPI 3.1: /api/openapi.json
- Auth: X-API-Key header only (never URL/query/cookie)
- Scopes: x-required-scopes per operation
- Correlation: optional X-Request-ID (echoed on every response)
- Errors: PublicErrorEnvelope JSON body

## Human guides

- Developer landing: /
- API reference: /reference
- Quickstart: /quickstart
- Errors: /errors
- Concurrency: /concurrency
- Idempotency: /idempotency
- Changelog: /changelog
- Compatibility: /docs redirects to /reference

## Important exceptions

- PUT /v1/qr/{short_id}/paywall does not require If-Match-Version, does not
  increment resource_version, is not on the mutation-audit path, and is not
  covered by idempotency middleware.

## Privacy

Transcripts, recordings, raw storage references, owner/internal IDs beyond the
public contract, and live credentials must not appear in fixtures or examples.
Use placeholders such as YOUR_API_KEY and example short IDs only.