Boreal-H3 Image to Video Serverless API
Animate a still into talking video with native audio.
POST /v2/boreal-h3-image-to-video · 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 "first_frame_image": "https://segmind-resources.s3.amazonaws.com/input/boreal-h3-image-to-video-first-frame.jpg",
11 "prompt": "The potter's wheel keeps spinning and the tall bowl rises between her wet fingers, water running down the grey clay as she steadies the rim. She glances up at the camera and says, \"Feel how thin that wall is getting.\" Her hands return to shaping the clay. Wheel humming and wet clay slapping, daylight from the studio window.",
12 "resolution": "768p",
13 "duration": 5,
14 "prompt_enhancement": "auto",
15}
16job = client.submit_async("boreal-h3-image-to-video", **payload)
17print(job.request_id) # available immediately
18try:
19 result = job.wait(timeout=900, interval=2.0)
20 print(result["status"]) # COMPLETED
21 print(result.get("output")) # model output (e.g. video URL)
22except InferenceTimeout as e:
23 print("still running:", e.request_id) # re-poll later with this id
24except InferenceFailed as e:
25 print("failed:", e.detail)
26
27# Fast models (<=600s) can use the one-liner instead:
28# result = segmind.run("boreal-h3-image-to-video", **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 "first_frame_image": "https://segmind-resources.s3.amazonaws.com/input/boreal-h3-image-to-video-first-frame.jpg",
11 "prompt": "The potter's wheel keeps spinning and the tall bowl rises between her wet fingers, water running down the grey clay as she steadies the rim. She glances up at the camera and says, \"Feel how thin that wall is getting.\" Her hands return to shaping the clay. Wheel humming and wet clay slapping, daylight from the studio window.",
12 "resolution": "768p",
13 "duration": 5,
14 "prompt_enhancement": "auto",
15}
16job = client.submit_async("boreal-h3-image-to-video", **payload)
17print(job.request_id) # available immediately
18try:
19 result = job.wait(timeout=900, interval=2.0)
20 print(result["status"]) # COMPLETED
21 print(result.get("output")) # model output (e.g. video URL)
22except InferenceTimeout as e:
23 print("still running:", e.request_id) # re-poll later with this id
24except InferenceFailed as e:
25 print("failed:", e.detail)
26
27# Fast models (<=600s) can use the one-liner instead:
28# result = segmind.run("boreal-h3-image-to-video", **payload)API Endpoint
https://api.segmind.com/v1/boreal-h3-image-to-videoParameters
first_frame_imagerequiredstring (uri)The opening frame. The output keeps this image's aspect ratio.
promptrequiredstringDescribe the subject, action, camera and any dialogue or sound. Describe what should move in the image.
"The subject turns to the camera and smiles, gentle push-in, ambient room sound"durationoptionalintegerVideo length in whole seconds, 1-15.
5Range: 1 - 15last_frame_imageoptionalstring (uri)Optional closing frame; the video transitions from the first frame to this one.
prompt_enhancementoptionalstringauto rewrites the prompt for the model; none sends it as written.
"auto""auto""none"resolutionoptionalstringOutput resolution. 2k is 1440 px on the short edge. The per-second price rises with resolution.
"768p""768p""1088p""2k"Response 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/boreal-h3-image-to-videoSubmit — 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