Hallo Serverless API
Hallo lets you create portrait videos from single images.
POST /v2/hallo · submit + poll 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3from segmind import SegmindClient, InferenceFailed, InferenceTimeout
4
5# Async (v2) — recommended for long-running / video models.
6# run() blocks up to 600s; submit_async + job.wait(timeout=...) sets a longer
7# deadline and keeps the request_id so you can re-poll later.
8client = SegmindClient() # reads SEGMIND_API_KEY
9payload = {
10 "input_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/hallo/hallo-input.png",
11 "input_audio": "https://segmind-sd-models.s3.amazonaws.com/display_images/hallo/hallo-audio-2.mp3",
12 "pose_weight": 1.4,
13 "face_weight": 1,
14 "lip_weight": 1.2,
15 "face_expand_ratio": 1.2,
16 "base64": False,
17}
18job = client.submit_async("hallo", **payload)
19print(job.request_id) # available immediately
20try:
21 result = job.wait(timeout=900, interval=2.0)
22 print(result["status"]) # COMPLETED
23 print(result.get("output")) # model output (e.g. video URL)
24except InferenceTimeout as e:
25 print("still running:", e.request_id) # re-poll later with this id
26except InferenceFailed as e:
27 print("failed:", e.detail)
28
29# Fast models (<=600s) can use the one-liner instead:
30# result = segmind.run("hallo", **payload) 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3from segmind import SegmindClient, InferenceFailed, InferenceTimeout
4
5# Async (v2) — recommended for long-running / video models.
6# run() blocks up to 600s; submit_async + job.wait(timeout=...) sets a longer
7# deadline and keeps the request_id so you can re-poll later.
8client = SegmindClient() # reads SEGMIND_API_KEY
9payload = {
10 "input_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/hallo/hallo-input.png",
11 "input_audio": "https://segmind-sd-models.s3.amazonaws.com/display_images/hallo/hallo-audio-2.mp3",
12 "pose_weight": 1.4,
13 "face_weight": 1,
14 "lip_weight": 1.2,
15 "face_expand_ratio": 1.2,
16 "base64": False,
17}
18job = client.submit_async("hallo", **payload)
19print(job.request_id) # available immediately
20try:
21 result = job.wait(timeout=900, interval=2.0)
22 print(result["status"]) # COMPLETED
23 print(result.get("output")) # model output (e.g. video URL)
24except InferenceTimeout as e:
25 print("still running:", e.request_id) # re-poll later with this id
26except InferenceFailed as e:
27 print("failed:", e.detail)
28
29# Fast models (<=600s) can use the one-liner instead:
30# result = segmind.run("hallo", **payload)API Endpoint
https://api.segmind.com/v1/halloParameters
input_audiorequiredstring (uri)Input audio file. Avoid special symbol in the filename as it may cause ffmpeg erros.
"https://segmind-sd-models.s3.amazonaws.com/display_images/hallo/hallo-audio-2.mp3"input_imagerequiredstring (uri)Input image of a talking-head.
"https://segmind-sd-models.s3.amazonaws.com/display_images/hallo/hallo-input.png"base64optionalbooleanBase64 encoding of the output image.
falseface_expand_ratiooptionalnumberFace Expand Ratio
1.2Range: 0 - 10face_weightoptionalnumberWeight of the Face in output
1Range: 0 - 10lip_weightoptionalnumberWeight of the Lip to apply
1.2Range: 0 - 10pose_weightoptionalnumberWeight of the Pose in output
1.4Range: 0 - 10Response Type
Returns: Video
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
POST /v2/halloSubmit — returns request_id, status_url, response_url
- 2
GET /v2/requests/{id}/statusPoll — until COMPLETED or FAILED
- 3
GET /v2/requests/{id}Result — final response body
Status states
- 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.
Bad Request
Invalid parameters or request format
Unauthorized
Missing or invalid API key
Forbidden
Insufficient permissions
Not Found
Model or endpoint not found
Insufficient Credits
Not enough credits to process request
Rate Limited
Too many requests
Server Error
Internal server error
Bad Gateway
Service temporarily unavailable
Timeout
Request timed out