Consistent Character With Pose Serverless API

Create images of a given character in different poses

~31.06s
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)

API Endpoint

POSThttps://api.segmind.com/v1/consistent-character-with-pose

Parameters

face_imagerequired
string (uri)

Face image

Default: "https://segmind-sd-models.s3.amazonaws.com/display_images/ccpose_ip.png"
pose_imagerequired
string (uri)

Pose image

Default: "https://segmind-sd-models.s3.amazonaws.com/display_images/cc_pose_img.png"
promptrequired
string

Textual description for the image generation

Default: "A candid photo of a woman , wearing a blue denim shirt and matching jeans. light smile on her face"
base_64optional
boolean

Output as base64 encoded string

Default: false
custom_heightoptional
integer

Custom height for output image

Default: 1024Range: 64 - 4096
custom_widthoptional
integer

Custom width for output image

Default: 1024Range: 64 - 4096
output_formatoptional
string

Output image format

Default: "png"
Allowed values :
"jpeg""png""webp"
qualityoptional
integer

Image quality setting for output

Default: 95Range: 10 - 100
samplesoptional
integer

Number of images to generate

Default: 1Range: 1 - 4
seedoptional
integer

Random seed for generation

Default: 2778725438
use_input_img_dimensionoptional
boolean

Whether to use the input image's dimensions

Default: true

Response 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. 1
    POST /v2/consistent-character-with-pose

    Submitreturns request_id, status_url, response_url

  2. 2
    GET /v2/requests/{id}/status

    Polluntil COMPLETED or FAILED

  3. 3
    GET /v2/requests/{id}

    Resultfinal response body

Status states

QUEUEDAccepted, waiting for a worker
PROCESSINGRunning on a worker
COMPLETEDDone — result body is ready
FAILEDErrored (incl. content/RAI blocks)
  • 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.

400

Bad Request

Invalid parameters or request format

401

Unauthorized

Missing or invalid API key

403

Forbidden

Insufficient permissions

404

Not Found

Model or endpoint not found

406

Insufficient Credits

Not enough credits to process request

429

Rate Limited

Too many requests

500

Server Error

Internal server error

502

Bad Gateway

Service temporarily unavailable

504

Timeout

Request timed out