Consistent Character With Pose Serverless API
Create images of a given character in different poses
POST /v2/consistent-character-with-pose · 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 "consistent-character-with-pose",
9 base_64=False,
10 custom_height=1024,
11 custom_width=1024,
12 face_image="https://segmind-sd-models.s3.amazonaws.com/display_images/ccpose_ip.png",
13 output_format="png",
14 pose_image="https://segmind-sd-models.s3.amazonaws.com/display_images/cc_pose_img.png",
15 prompt="A candid photo of a woman , wearing a blue denim shirt and matching jeans. light smile on her face",
16 quality=95,
17 samples=1,
18 seed=2778725438,
19 use_input_img_dimension=True,
20)
21print(result["status"]) # COMPLETED
22print(result.get("output")) # model output (e.g. media URL)
23print(result["metrics"]["inference_time"]) # server compute seconds
24
25# --- Or submit + poll manually (track request_id, control the cadence) ---
26from segmind import SegmindClient, InferenceFailed, InferenceTimeout
27
28client = SegmindClient() # reads SEGMIND_API_KEY
29payload = {
30 "base_64": False,
31 "custom_height": 1024,
32 "custom_width": 1024,
33 "face_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/ccpose_ip.png",
34 "output_format": "png",
35 "pose_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/cc_pose_img.png",
36 "prompt": "A candid photo of a woman , wearing a blue denim shirt and matching jeans. light smile on her face",
37 "quality": 95,
38 "samples": 1,
39 "seed": 2778725438,
40 "use_input_img_dimension": True,
41}
42job = client.submit_async("consistent-character-with-pose", **payload)
43print(job.request_id) # available immediately
44try:
45 result = job.wait(timeout=600, interval=1.0)
46except InferenceTimeout as e:
47 print("still running:", e.request_id)
48except InferenceFailed as e:
49 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 "consistent-character-with-pose",
9 base_64=False,
10 custom_height=1024,
11 custom_width=1024,
12 face_image="https://segmind-sd-models.s3.amazonaws.com/display_images/ccpose_ip.png",
13 output_format="png",
14 pose_image="https://segmind-sd-models.s3.amazonaws.com/display_images/cc_pose_img.png",
15 prompt="A candid photo of a woman , wearing a blue denim shirt and matching jeans. light smile on her face",
16 quality=95,
17 samples=1,
18 seed=2778725438,
19 use_input_img_dimension=True,
20)
21print(result["status"]) # COMPLETED
22print(result.get("output")) # model output (e.g. media URL)
23print(result["metrics"]["inference_time"]) # server compute seconds
24
25# --- Or submit + poll manually (track request_id, control the cadence) ---
26from segmind import SegmindClient, InferenceFailed, InferenceTimeout
27
28client = SegmindClient() # reads SEGMIND_API_KEY
29payload = {
30 "base_64": False,
31 "custom_height": 1024,
32 "custom_width": 1024,
33 "face_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/ccpose_ip.png",
34 "output_format": "png",
35 "pose_image": "https://segmind-sd-models.s3.amazonaws.com/display_images/cc_pose_img.png",
36 "prompt": "A candid photo of a woman , wearing a blue denim shirt and matching jeans. light smile on her face",
37 "quality": 95,
38 "samples": 1,
39 "seed": 2778725438,
40 "use_input_img_dimension": True,
41}
42job = client.submit_async("consistent-character-with-pose", **payload)
43print(job.request_id) # available immediately
44try:
45 result = job.wait(timeout=600, interval=1.0)
46except InferenceTimeout as e:
47 print("still running:", e.request_id)
48except InferenceFailed as e:
49 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/consistent-character-with-poseParameters
face_imagerequiredstring (uri)Face image
"https://segmind-sd-models.s3.amazonaws.com/display_images/ccpose_ip.png"pose_imagerequiredstring (uri)Pose image
"https://segmind-sd-models.s3.amazonaws.com/display_images/cc_pose_img.png"promptrequiredstringTextual description for the image generation
"A candid photo of a woman , wearing a blue denim shirt and matching jeans. light smile on her face"base_64optionalbooleanOutput as base64 encoded string
falsecustom_heightoptionalintegerCustom height for output image
1024Range: 64 - 4096custom_widthoptionalintegerCustom width for output image
1024Range: 64 - 4096output_formatoptionalstringOutput image format
"png""jpeg""png""webp"qualityoptionalintegerImage quality setting for output
95Range: 10 - 100samplesoptionalintegerNumber of images to generate
1Range: 1 - 4seedoptionalintegerRandom seed for generation
2778725438use_input_img_dimensionoptionalbooleanWhether to use the input image's dimensions
trueResponse 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/consistent-character-with-poseSubmit — 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