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

# API Reference

> Authentication, conventions, and endpoints for the Protoface REST API.

Everything lives under `https://api.protoface.com/v1`. Media generation
is `POST /v1/run/{model_id}` and `GET /v1/runs/{id}`. Live avatars start
at `POST /v1/sessions`.

Authenticate with a Protoface API key:

```http theme={null}
Authorization: Bearer sk_live_...
```

Create and manage keys in
[app.protoface.com](https://app.protoface.com). One key covers inference
and Realtime, and [Authentication](/guides/authentication) covers
scopes.

## Conventions

* IDs are prefixed strings such as `run_...`, `sess_...`, `asset_...`,
  and `av_...`. Model IDs are the exception: `publisher/model`, which
  doubles as the run path.
* Timestamps are ISO-8601 UTC strings.
* List endpoints use cursor pagination with `limit` and `starting_after`.
* Error responses use the envelope described in
  [Errors](/reference/errors), where `error.code` is the field to
  branch on.
* `POST /v1/run/{model_id}` and `POST /v1/sessions` accept an
  `Idempotency-Key` for safe retries, reused only for an unchanged body.
  [Runs](/guides/runs#idempotency) covers the rules.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.