InstantID Serverless API
InstantID aims to generate customized images with various poses or styles from only a single reference ID image while ensuring high fidelity
POST /v2/instantid · 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 "instantid",
9 prompt="photo of a man",
10 face_image="https://segmind-sd-models.s3.amazonaws.com/outputs/instantid_input.jpg",
11 negative_prompt="lowquality, badquality, sketches",
12 style="Vibrant Color",
13 samples=1,
14 num_inference_steps=10,
15 guidance_scale=5,
16 seed=354849415,
17 identity_strength=0.8,
18 adapter_strength=0.8,
19 enhance_face_region=True,
20 base64=False,
21)
22print(result["status"]) # COMPLETED
23print(result.get("output")) # model output (e.g. media URL)
24print(result["metrics"]["inference_time"]) # server compute seconds
25
26# --- Or submit + poll manually (track request_id, control the cadence) ---
27from segmind import SegmindClient, InferenceFailed, InferenceTimeout
28
29client = SegmindClient() # reads SEGMIND_API_KEY
30payload = {
31 "prompt": "photo of a man",
32 "face_image": "https://segmind-sd-models.s3.amazonaws.com/outputs/instantid_input.jpg",
33 "negative_prompt": "lowquality, badquality, sketches",
34 "style": "Vibrant Color",
35 "samples": 1,
36 "num_inference_steps": 10,
37 "guidance_scale": 5,
38 "seed": 354849415,
39 "identity_strength": 0.8,
40 "adapter_strength": 0.8,
41 "enhance_face_region": True,
42 "base64": False,
43}
44job = client.submit_async("instantid", **payload)
45print(job.request_id) # available immediately
46try:
47 result = job.wait(timeout=600, interval=1.0)
48except InferenceTimeout as e:
49 print("still running:", e.request_id)
50except InferenceFailed as e:
51 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 "instantid",
9 prompt="photo of a man",
10 face_image="https://segmind-sd-models.s3.amazonaws.com/outputs/instantid_input.jpg",
11 negative_prompt="lowquality, badquality, sketches",
12 style="Vibrant Color",
13 samples=1,
14 num_inference_steps=10,
15 guidance_scale=5,
16 seed=354849415,
17 identity_strength=0.8,
18 adapter_strength=0.8,
19 enhance_face_region=True,
20 base64=False,
21)
22print(result["status"]) # COMPLETED
23print(result.get("output")) # model output (e.g. media URL)
24print(result["metrics"]["inference_time"]) # server compute seconds
25
26# --- Or submit + poll manually (track request_id, control the cadence) ---
27from segmind import SegmindClient, InferenceFailed, InferenceTimeout
28
29client = SegmindClient() # reads SEGMIND_API_KEY
30payload = {
31 "prompt": "photo of a man",
32 "face_image": "https://segmind-sd-models.s3.amazonaws.com/outputs/instantid_input.jpg",
33 "negative_prompt": "lowquality, badquality, sketches",
34 "style": "Vibrant Color",
35 "samples": 1,
36 "num_inference_steps": 10,
37 "guidance_scale": 5,
38 "seed": 354849415,
39 "identity_strength": 0.8,
40 "adapter_strength": 0.8,
41 "enhance_face_region": True,
42 "base64": False,
43}
44job = client.submit_async("instantid", **payload)
45print(job.request_id) # available immediately
46try:
47 result = job.wait(timeout=600, interval=1.0)
48except InferenceTimeout as e:
49 print("still running:", e.request_id)
50except InferenceFailed as e:
51 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/instantidParameters
face_imagerequiredstring (uri)Face Image.
promptrequiredstringPrompt to render
adapter_strengthoptionalnumberAdapter Strength
0.8Range: 0 - 1base64optionalbooleanBase64 encoding of the output image.
falseenhance_face_regionoptionalbooleanEnhance Face region
trueguidance_scaleoptionalnumberScale for classifier-free guidance
5Range: 1 - 25identity_strengthoptionalnumberIdentity Strength
0.8Range: 0 - 1negative_promptoptionalstringPrompts to exclude, eg. 'bad anatomy, bad hands, missing fingers'
num_inference_stepsoptionalintegerNumber of denoising steps.
10Range: 4 - 100pose_imageoptionalstring (uri)Pose Image.
samplesoptionalintegerNumber of samples to generate.
1Range: 1 - 4seedoptionalintegerSeed for image generation.
-1Range: -1 - 999999999999999styleoptionalstringStyle to apply
"(No style)""Watercolor""Film Noir""Neon""Jungle""Mars""Vibrant Color""Snow""Line art""Art Nouveau"+19 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/instantidSubmit — 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