HEheygen
Video Quality

Create Video Quality Comparison

Changed on

Submit one pairwise video comparison. The server waits for a bounded synchronous result: completed comparisons return 200, while comparisons that continue asynchronously return 202 and can be polled by comparison_id.

post/v3/video-quality/comparisons

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/video-quality/comparisons
  • Auth
    API key in header x-api-key

Headers

Idempotency-Keystring

Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 request_in_progress. Keys must be 1–255 characters from [A-Za-z0-9_:.-]; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.

Request body

promptstring required

Prompt used to generate both candidate videos. This provides request context, but scoring is selected by question_id and does not condition on this free-form prompt.

model_astring required

Caller-supplied identifier for the model that generated video A.

model_bstring required

Caller-supplied identifier for the model that generated video B.

question_id'engagement' | 'prompt_intent' | 'composition' | 'temporal_consistency' | 'craft' | 'q1' required

Supported C2V judge questions.

judge_model_versionstring nullable

Allowlisted dated judge model name. Omit to use the active server-configured version.

Response

Successful response

Changes