HotshotXL Serverless API
A text-to-GIF model that works on Stable Diffusion XL.
POST /v2/hotshot-xl · 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 "hotshot-xl",
9 mp4=False,
10 seed=6226,
11 steps=30,
12 width=672,
13 height=384,
14 prompt="a dog running towards you with a smile, hd, high quality",
15 scheduler="EulerAncestralDiscreteScheduler",
16 negative_prompt="blurry",
17)
18print(result["status"]) # COMPLETED
19print(result.get("output")) # model output (e.g. media URL)
20print(result["metrics"]["inference_time"]) # server compute seconds
21
22# --- Or submit + poll manually (track request_id, control the cadence) ---
23from segmind import SegmindClient, InferenceFailed, InferenceTimeout
24
25client = SegmindClient() # reads SEGMIND_API_KEY
26payload = {
27 "mp4": False,
28 "seed": 6226,
29 "steps": 30,
30 "width": 672,
31 "height": 384,
32 "prompt": "a dog running towards you with a smile, hd, high quality",
33 "scheduler": "EulerAncestralDiscreteScheduler",
34 "negative_prompt": "blurry",
35}
36job = client.submit_async("hotshot-xl", **payload)
37print(job.request_id) # available immediately
38try:
39 result = job.wait(timeout=600, interval=1.0)
40except InferenceTimeout as e:
41 print("still running:", e.request_id)
42except InferenceFailed as e:
43 print("failed:", e.detail) 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 "hotshot-xl",
9 mp4=False,
10 seed=6226,
11 steps=30,
12 width=672,
13 height=384,
14 prompt="a dog running towards you with a smile, hd, high quality",
15 scheduler="EulerAncestralDiscreteScheduler",
16 negative_prompt="blurry",
17)
18print(result["status"]) # COMPLETED
19print(result.get("output")) # model output (e.g. media URL)
20print(result["metrics"]["inference_time"]) # server compute seconds
21
22# --- Or submit + poll manually (track request_id, control the cadence) ---
23from segmind import SegmindClient, InferenceFailed, InferenceTimeout
24
25client = SegmindClient() # reads SEGMIND_API_KEY
26payload = {
27 "mp4": False,
28 "seed": 6226,
29 "steps": 30,
30 "width": 672,
31 "height": 384,
32 "prompt": "a dog running towards you with a smile, hd, high quality",
33 "scheduler": "EulerAncestralDiscreteScheduler",
34 "negative_prompt": "blurry",
35}
36job = client.submit_async("hotshot-xl", **payload)
37print(job.request_id) # available immediately
38try:
39 result = job.wait(timeout=600, interval=1.0)
40except InferenceTimeout as e:
41 print("still running:", e.request_id)
42except InferenceFailed as e:
43 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/hotshot-xlParameters
heightoptionalintegerAn enumeration.
384256320384448512576640672704768+4 moremp4optionalbooleanSave as mp4, False for GIF
falsenegative_promptoptionalstringNegative prompt
"blurry"promptoptionalstringInput prompt
""scheduleroptionalstringAn enumeration.
"EulerAncestralDiscreteScheduler""DDIMScheduler""DPMSolverMultistepScheduler""HeunDiscreteScheduler""KarrasDPM""EulerAncestralDiscreteScheduler""EulerDiscreteScheduler""PNDMScheduler"seedoptionalintegerRandom seed. Leave blank to randomize the seed
6226stepsoptionalintegerNumber of denoising steps
30Range: 1 - 500widthoptionalintegerAn enumeration.
672256320384448512576640672704768+4 moreResponse 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
POST /v2/hotshot-xlSubmit — 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