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

# API overview

> Use the workspace-scoped v1 API and its generated OpenAPI operations.

The HTTP API lives under <code>/api/v1</code>. Most routes are workspace-scoped:

```text theme={null}
/api/v1/workspaces/{workspace}/...
```

Use a browser session for operator and account-management workflows. Use a scoped <code>gp\_live\_</code> bearer key for machine access where the route policy permits it.

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/api-reference/authentication">
    Session and bearer behavior, route scopes, errors, idempotency, and anti-enumeration.
  </Card>

  <Card title="Pagination and limits" icon="list" href="/api-reference/pagination-limits">
    Current collection behavior, query limits, job concurrency, and field caps.
  </Card>
</CardGroup>

## Base request

```bash theme={null}
curl \
  -H "Authorization: Bearer gp_live_REPLACE_ME" \
  -H "Accept: application/json" \
  http://127.0.0.1:3000/api/v1/workspaces/acme/runs
```

## Generated operations

The operation pages below this section are rendered from <code>docs/openapi.json</code>. That snapshot is produced by the running application's OpenAPI route, so it must be refreshed when route contracts change.

```bash theme={null}
cd apps/web
npm run dev

# From the repository root, in another terminal:
node apps/web/scripts/docs-openapi.mjs
```

<Note>
  The generation script fetches <code>[http://127.0.0.1:3000/api/v1/openapi.json](http://127.0.0.1:3000/api/v1/openapi.json)</code> by default. It is not an offline source generator. Set <code>OPENAPI\_URL</code> when the app runs on another port.
</Note>

## Route stability

The generated schema describes request and response structures exposed by the current application. Authorization policy can still narrow what a session or API key may do. Check [Authentication](/api-reference/authentication) before integrating a generated operation.