> ## Documentation Index
> Fetch the complete documentation index at: https://docs.yalg.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# YALG Developer Docs

> Integrate YALG content workflows into your own product.

YALG helps creators and teams turn anecdotes into publishable content across posts, scripts, shorts, carousels, and analytics workflows. The Developer API gives you the same owner-scoped workflows through a stable public `/v1` surface.

<CardGroup cols={2}>
  <Card title="Start in 5 minutes" icon="rocket" href="/quickstart">
    Create an API key, call your account endpoint, and make the first
    authenticated request.
  </Card>

  <Card title="Authentication" icon="key-round" href="/authentication">
    Send the `x-api-key` header and keep keys in server-side environments only.
  </Card>

  <Card title="Rate limits" icon="gauge" href="/concepts/rate-limits">
    Understand quotas, per-minute limits, and response headers.
  </Card>

  <Card title="OpenAPI source" icon="code" href="https://api.yalg.ai/openapi.v1-3.1.json">
    Inspect the live OpenAPI 3.1 document that powers the API reference.
  </Card>
</CardGroup>

## Base URL

The production API base URL is:

```text theme={null}
https://api.yalg.ai
```

Public integration endpoints live under `/v1`.

## Authentication model

Public API requests are authenticated with named API keys. Each request acts as the user who owns the key, so product resources are automatically scoped to that owner.

<Warning>
  API keys are shown once. Store them in a server-side secret manager or
  environment variable, and never expose them in client-side code.
</Warning>

## Common integration paths

<CardGroup cols={2}>
  <Card title="Collect anecdotes" icon="mic" href="/guides/anecdotes">
    Create text, audio, or spreadsheet-based anecdotes that become source
    material for content.
  </Card>

  <Card title="Manage posts" icon="send" href="/guides/posts">
    Create drafts, schedule posts, publish, mark external publication, and
    manage media.
  </Card>

  <Card title="Run generation jobs" icon="sparkles" href="/guides/post-generation">
    Generate post drafts from anecdotes and track generation job state.
  </Card>

  <Card title="Render blog articles" icon="newspaper" href="/guides/blog-articles">
    Fetch finished blog articles with a Developer API key and render their
    Markdown in your own site.
  </Card>

  <Card title="Read analytics" icon="bar-chart-3" href="/guides/analytics">
    Pull dashboard summaries, recent posts, and pending validation items.
  </Card>
</CardGroup>

## What is generated automatically?

The API reference is generated from `https://api.yalg.ai/openapi.v1-3.1.json`, the public OpenAPI 3.1 document served by the YALG backend. The backend validates at startup that documented request bodies and non-empty responses include schemas, so the reference stays aligned with the API surface.