Skip to main content
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:
Create and manage keys in app.protoface.com. One key covers inference and Realtime, and 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, 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 covers the rules.