# Protoface

## Docs

- [Create a custom avatar from an image](https://docs.protoface.com/api-reference/avatars/create-a-custom-avatar-from-an-image.md): Upload a source image to build a custom avatar. Returns the avatar in `processing`; poll `GET /v1/avatars/{id}` until it is `ready` (or `failed`). See [Choosing a source image](/guides/avatar-source-images) for examples and best practices. `multipart/form-data`: `image` (PNG/JPEG), `name`, and optio…
- [Delete an avatar](https://docs.protoface.com/api-reference/avatars/delete-an-avatar.md): Delete a custom avatar and permanently remove its uploaded source image and built assets. The avatar disappears from listings and can no longer run sessions; past session and usage records are kept. Platform stock avatars cannot be deleted.
- [List avatars](https://docs.protoface.com/api-reference/avatars/list-avatars.md): List avatars available to the calling org. Includes platform-built-in stock avatars (e.g. `av_stock_001`) and any customer-uploaded avatars.
- [Retrieve an avatar](https://docs.protoface.com/api-reference/avatars/retrieve-an-avatar.md): Return a single avatar by id.
- [List billing plans](https://docs.protoface.com/api-reference/billing/list-billing-plans.md): Return the current Protoface billing plan catalog. This endpoint is unauthenticated so signup and pricing UI can render the same catalog used by checkout and enforcement.
- [API Reference](https://docs.protoface.com/api-reference/index.md): Authentication, conventions, and endpoints for the Protoface REST API.
- [Platform status roll-up](https://docs.protoface.com/api-reference/platform/platform-status-roll-up.md): Public status of the Protoface platform. Polled by the status page and operator dashboards. Unauthenticated.
- [Create a session](https://docs.protoface.com/api-reference/sessions/create-a-session.md): Allocate a worker and begin a realtime avatar session.
- [End a session](https://docs.protoface.com/api-reference/sessions/end-a-session.md): Terminate a session immediately. Idempotent: calling on an already-terminal session returns 200 with the existing state. The session transitions to `canceled` if it had not yet started, or `ending` (then `ended` once the worker drains) if it was running.
- [List sessions](https://docs.protoface.com/api-reference/sessions/list-sessions.md): List sessions for the calling org, newest first. Repeatable `status` filters OR together; the group aliases `active` and `terminal` expand to the underlying status set. `created_after` / `created_before` accept ISO-8601 UTC. Paginate with `limit` + `starting_after=<last_session_id>`.
- [Retrieve a session](https://docs.protoface.com/api-reference/sessions/retrieve-a-session.md): Return the current state of a session, including timing and usage counters.
- [Get usage summary](https://docs.protoface.com/api-reference/usage/get-usage-summary.md): Return aggregated usage for the calling org over a time range.
- [Choosing a source image](https://docs.protoface.com/guides/avatar-source-images.md): Pick a source image that helps Protoface build a natural custom avatar.
- [Avatars](https://docs.protoface.com/guides/avatars.md): Find the avatar ID to use in a Protoface session.
- [LiveKit Agents](https://docs.protoface.com/guides/livekit-agents.md): Use the Protoface avatar plugin in a LiveKit Agents app.
- [More Integrations](https://docs.protoface.com/guides/more-integrations.md): Protoface integrates with many voice AI platforms, SDKs, and frameworks. Pick a quickstart and run in minutes.
- [Usage](https://docs.protoface.com/guides/usage.md): Read account-level usage totals.
- [Protoface Docs](https://docs.protoface.com/index.md): Add realtime, high-fidelity avatars to your AI app or agent with the Protoface API.
- [Quickstart](https://docs.protoface.com/quickstart.md): Run a LiveKit Agents app with a Protoface avatar.
- [Errors](https://docs.protoface.com/reference/errors.md): Error envelope, stable codes, and retry behavior.
- [Known issues](https://docs.protoface.com/reference/known-issues.md): Current integration status and constraints.
- [Quotas](https://docs.protoface.com/reference/quotas.md): Session caps, usage rounding, and credit behavior.

## OpenAPI Specs

- [openapi](https://docs.protoface.com/openapi.json)