AI Consumption Guide

Yapper's public API is team-scoped. API keys are created in Account → Developer and share the team's workspace credits.

Prefer the OpenAPI document at /api/v1/openapi.json for exact schemas. llms.txt and llms-full.txt are served for AI discovery:

• /api/v1/llms.txt
• /api/v1/llms-full.txt

Agent rules

• Always authenticate with Authorization: Bearer $YAPPER_API_KEY.
• Call GET /api/v1/credits before expensive work when the user asks whether a generation can run.
• Poll GET /api/v1/processes/{processId}; do not assume synchronous completion.
• Treat status values as queued, processing, completed, or failed.
• Do not rely on Firebase paths, provider job ids, private errors, or internal processContext fields.
• Use asset ids and public asset records rather than scraping internal storage URLs.
• For POST /api/v1/processes, send Idempotency-Key when retrying or when the caller has an external job id.