Skip to main content
POST
Validate Face Image
For AI agents, use https://docs.tavus.io/openapi.yaml for the full HTTP API contract.

Authorizations

x-api-key
string
header
required

Body

application/json
imageBase64
string
required

Base64-encoded image bytes, without a data:image/...;base64, prefix. Leading and trailing whitespace is trimmed.

Required string length: 1 - 29360128
Example:

"<base64-encoded-image>"

mimeType
enum<string>
default:image/jpeg

The image's MIME type. Defaults to image/jpeg when omitted.

Available options:
image/jpeg,
image/png,
image/webp,
image/heic,
image/heif
Example:

"image/jpeg"

model
enum<string>
default:phoenix-4

Phoenix model to validate the image for. Match the model_name you will send to Create Face.

Available options:
phoenix-4,
phoenix-4.5
Example:

"phoenix-4.5"

Response

Validation completed. An unsuitable image returns passed: false with structured checks.

passed
boolean
required

True when every check for the selected model passes.

message
string
required

A human-readable summary of the validation result.

checks
object[]
required

Checks for the selected model. Use entries with passed: false to show rejection reasons.

details
object
required

Model-specific observations, including booleans about image quality, pose, framing, and other requirements. Use checks for pass/fail decisions: some detail booleans describe problems, so true does not always mean acceptable.