# Protoface > Call frontier media models and live avatars through one API. - [Protoface API](https://docs.protoface.com/index.md): Frontier media models and live avatars behind one API. - [Inference quickstart](https://docs.protoface.com/guides/model-inference.md): Generate your first video with curl, Python, or JavaScript. - [Generate a video](https://docs.protoface.com/guides/generate-video.md): Turn a text prompt into a finished clip with sound. - [Generate an image](https://docs.protoface.com/guides/generate-image.md): Generate a still and reuse it as input to another model. - [Animate an image](https://docs.protoface.com/guides/image-to-video.md): Use a still as the opening frame of a generated clip. - [Runs](https://docs.protoface.com/guides/runs.md): Submit, poll, retrieve, and cancel a generation. - [Models](https://docs.protoface.com/guides/models.md): Fields, operations, and request schemas for every model. - [Assets](https://docs.protoface.com/guides/assets.md): Upload a file once and reuse it across generations. - [Realtime quickstart](https://docs.protoface.com/quickstart.md): Add a live avatar to a LiveKit agent. - [Avatars](https://docs.protoface.com/guides/avatars.md): Create, list, and use avatars in realtime sessions. - [Source images](https://docs.protoface.com/guides/avatar-source-images.md): Portrait requirements for a successful avatar build. - [Embeds](https://docs.protoface.com/guides/embeds.md): Share links, iframes, and custom UIs for live conversations. - [LiveKit Agents](https://docs.protoface.com/guides/livekit-agents.md): Use the Protoface avatar plugin in a LiveKit Agents app. - [Pipecat](https://docs.protoface.com/guides/pipecat.md): Add a live avatar to a Pipecat pipeline. - [Other integrations](https://docs.protoface.com/guides/more-integrations.md): Starters for Agora, Vapi, OpenAI Realtime, and more. - [Credits and limits](https://docs.protoface.com/reference/quotas.md): Credit reservations, concurrency ceilings, and session limits. - [Usage](https://docs.protoface.com/guides/usage.md): Read account-level spend by day, operation, and surface. - [Authentication](https://docs.protoface.com/guides/authentication.md): API keys, scopes, and where to keep them. - [Errors](https://docs.protoface.com/reference/errors.md): Error envelope, stable codes, and retry behavior. - [MCP server](https://docs.protoface.com/reference/mcp.md): Generate media from Codex, Claude Code, or Cursor. - [API Reference](https://docs.protoface.com/api-reference/index.md): Authentication, conventions, and endpoints for the Protoface REST API. - [List models](https://docs.protoface.com/api-reference/models/list-models.md) - [Retrieve a model](https://docs.protoface.com/api-reference/models/retrieve-a-model.md) - [Submit a run](https://docs.protoface.com/api-reference/runs/submit-a-run.md) - [List runs](https://docs.protoface.com/api-reference/runs/list-runs.md) - [Retrieve a run](https://docs.protoface.com/api-reference/runs/retrieve-a-run.md) - [Poll run status](https://docs.protoface.com/api-reference/runs/poll-run-status.md) - [List run events](https://docs.protoface.com/api-reference/runs/list-run-events.md) - [Cancel a run](https://docs.protoface.com/api-reference/runs/cancel-a-run.md): Call off a run. Queued work is refunded; running work is charged in full. - [Upload an asset](https://docs.protoface.com/api-reference/assets/upload-an-asset.md) - [List assets](https://docs.protoface.com/api-reference/assets/list-assets.md) - [Retrieve an asset](https://docs.protoface.com/api-reference/assets/retrieve-an-asset.md) - [Retrieve asset content](https://docs.protoface.com/api-reference/assets/retrieve-asset-content.md) - [Delete an asset](https://docs.protoface.com/api-reference/assets/delete-an-asset.md): Permanently delete an asset's stored content. - [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. - [Create a custom avatar from an image](https://docs.protoface.com/api-reference/avatars/create-a-custom-avatar-from-an-image.md): Upload a portrait image to build a custom avatar. Returns the avatar in `processing`; poll `GET /v1/avatars/{id}` until it is `ready` (or `failed`). `multipart/form-data`: `image` (PNG/JPEG), and optional `name`. Avatar rendering is configured automatically. - [Retrieve an avatar](https://docs.protoface.com/api-reference/avatars/retrieve-an-avatar.md): Return a single avatar by id. - [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. - [Create a Pipecat avatar media session](https://docs.protoface.com/api-reference/pipecat/create-a-pipecat-avatar-media-session.md): Start a Protoface avatar session for Pipecat. The response contains short-lived WebSocket media credentials used by the `pipecat-protoface` package. - [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=`. - [Create a session](https://docs.protoface.com/api-reference/sessions/create-a-session.md): Allocate a worker and begin a realtime avatar session. - [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. - [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 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. - [Get quota limits](https://docs.protoface.com/api-reference/billing/get-quota-limits.md): Return the calling org's current credit balance and low-balance threshold so API clients can warn before credits run out. - [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. - [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. ## OpenAPI Specs - [openapi](/openapi.json) ## Optional - [Main Site](https://protoface.com) - [Dashboard](https://app.protoface.com) - [Examples](https://github.com/protoface-ai/protoface-quickstart) - [Support](https://protoface.discourse.group/) - [Status](https://status.protoface.com) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.