HeyGen Generate Look Serverless API

Change avatar outfits and backgrounds while keeping the same face.

~50.59s
POST /v2/heygen-generate-look · submit + poll
 1# pip install "segmind>=1.1.0"
 2# export SEGMIND_API_KEY="YOUR_API_KEY"
 3import segmind
 4
 5# Async (v2): submit to the queue and block until COMPLETED.
 6# run() returns the final result dict (600s deadline, 1.0s poll by default).
 7result = segmind.run(
 8    "heygen-generate-look",
 9    prompt="wearing a smart casual outfit in a bright modern studio",
10    group_id="e6284f7ae0084adea3b1ddf4a481ec1f",
11    orientation="square",
12    pose="half_body",
13    style="Realistic",
14)
15print(result["status"])                      # COMPLETED
16print(result.get("output"))                  # model output (e.g. media URL)
17print(result["metrics"]["inference_time"])   # server compute seconds
18
19# --- Or submit + poll manually (track request_id, control the cadence) ---
20from segmind import SegmindClient, InferenceFailed, InferenceTimeout
21
22client = SegmindClient()                      # reads SEGMIND_API_KEY
23payload = {
24    "prompt": "wearing a smart casual outfit in a bright modern studio",
25    "group_id": "e6284f7ae0084adea3b1ddf4a481ec1f",
26    "orientation": "square",
27    "pose": "half_body",
28    "style": "Realistic",
29}
30job = client.submit_async("heygen-generate-look", **payload)
31print(job.request_id)                         # available immediately
32try:
33    result = job.wait(timeout=600, interval=1.0)
34except InferenceTimeout as e:
35    print("still running:", e.request_id)
36except InferenceFailed as e:
37    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/heygen-generate-look

Parameters

group_idoptional
string

A trained HeyGen photo-avatar group (returned by an earlier image call) — generates a look instantly, no retraining. Provide this (with a prompt) OR image(s).

imagesoptional
string[]

Photos of the person to create a NEW identity from — upload several (HeyGen recommends >=10 clear, varied photos of the same person for good identity fidelity). Starts training (~15-30 min) and returns a reusable group_id; then call again with that group_id + a prompt to generate looks. Omit if you already have a group_id.

nameoptional
string

Optional name for the new avatar identity.

orientationoptional
string
Default: "square"
Allowed values :
Square"square"
Horizontal"horizontal"
Vertical"vertical"
poseoptional
string
Default: "half_body"
Allowed values :
Half Body"half_body"
Close Up"close_up"
Full Body"full_body"
promptoptional
string

Describe the new outfit / environment / pose, e.g. 'wearing a formal business suit in a modern corporate office'. Required when generating a look (with a group_id).

styleoptional
string
Default: "Realistic"
Allowed values :
"Realistic""Pixar""Cinematic""Vintage""Noir""Cyberpunk""Unspecified"

Response Type

Returns: Image

Asynchronous requests (v2)

Use Async for video, long-running (>~60s), or high-concurrency workloads; Sync is simplest for fast image & LLM calls. Async submits a request and you poll it to completion.

  1. 1
    POST /v2/heygen-generate-look

    Submitreturns request_id, status_url, response_url

  2. 2
    GET /v2/requests/{id}/status

    Polluntil COMPLETED or FAILED

  3. 3
    GET /v2/requests/{id}

    Resultfinal response body

Status states

QUEUEDAccepted, waiting for a worker
PROCESSINGRunning on a worker
COMPLETEDDone — result body is ready
FAILEDErrored (incl. content/RAI blocks)
  • A FAILED request is served as HTTP 422 — the body still carries the error detail.
  • An unknown or expired request_id returns HTTP 404.
  • Results are retained for 1 hour, then expire.
  • Content / RAI blocks surface as FAILED, not a separate state.
  • Track completion by polling the status endpoint.

Common Error Codes

The API returns standard HTTP status codes. Detailed error messages are provided in the response body.

400

Bad Request

Invalid parameters or request format

401

Unauthorized

Missing or invalid API key

403

Forbidden

Insufficient permissions

404

Not Found

Model or endpoint not found

406

Insufficient Credits

Not enough credits to process request

429

Rate Limited

Too many requests

500

Server Error

Internal server error

502

Bad Gateway

Service temporarily unavailable

504

Timeout

Request timed out