Expression Editor Serverless API

Expression Editor uses reference images to accurately generate new images with desired expressions. Perfect for digital art, memes, and marketing.

POST /v2/expression-editor · 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    "expression-editor",
 9    aaa=0,
10    blink=0,
11    eee=0,
12    eyebrow=0,
13    image="https://segmind-sd-models.s3.amazonaws.com/display_images/ep-editor-ip.png",
14    image_format="png",
15    image_quality=95,
16    pupil_x=0,
17    pupil_y=0,
18    rotate_pitch=0,
19    rotate_roll=0,
20    rotate_yaw=0,
21    sample_parts="OnlyExpression",
22    smile=1,
23    wink=0,
24    woo=0,
25)
26print(result["status"])                      # COMPLETED
27print(result.get("output"))                  # model output (e.g. media URL)
28print(result["metrics"]["inference_time"])   # server compute seconds
29
30# --- Or submit + poll manually (track request_id, control the cadence) ---
31from segmind import SegmindClient, InferenceFailed, InferenceTimeout
32
33client = SegmindClient()                      # reads SEGMIND_API_KEY
34payload = {
35    "aaa": 0,
36    "blink": 0,
37    "eee": 0,
38    "eyebrow": 0,
39    "image": "https://segmind-sd-models.s3.amazonaws.com/display_images/ep-editor-ip.png",
40    "image_format": "png",
41    "image_quality": 95,
42    "pupil_x": 0,
43    "pupil_y": 0,
44    "rotate_pitch": 0,
45    "rotate_roll": 0,
46    "rotate_yaw": 0,
47    "sample_parts": "OnlyExpression",
48    "smile": 1,
49    "wink": 0,
50    "woo": 0,
51}
52job = client.submit_async("expression-editor", **payload)
53print(job.request_id)                         # available immediately
54try:
55    result = job.wait(timeout=600, interval=1.0)
56except InferenceTimeout as e:
57    print("still running:", e.request_id)
58except InferenceFailed as e:
59    print("failed:", e.detail)

API Endpoint

POSThttps://api.segmind.com/v1/expression-editor

Parameters

imagerequired
string (uri)

URL of the Input Face Image

Default: "https://segmind-sd-models.s3.amazonaws.com/display_images/ep-editor-ip.png"
aaaoptional
number

Mouth shape for 'aaa'

Default: 0Range: -30 - 30
blinkoptional
number

Blink intensity

Default: 0Range: -20 - 5
eeeoptional
number

Mouth shape for 'eee'

Default: 0Range: -15 - 15
eyebrowoptional
number

Eyebrow position adjustment

Default: 0Range: -10 - 10
image_formatoptional
string

Output image format

Default: "png"
Allowed values :
"png""jpg""webp"
image_qualityoptional
integer

Image quality

Default: 95Range: 10 - 100
pupil_xoptional
number

Pupil X-axis position

Default: 0Range: -15 - 15
pupil_yoptional
number

Pupil Y-axis position

Default: 0Range: -15 - 15
ref_expression_imageoptional
string (uri)

URL of the reference expression image

Default: null
rotate_pitchoptional
number

Pitch rotation in degrees

Default: 0Range: -20 - 20
rotate_rolloptional
number

Roll rotation in degrees

Default: 0Range: -20 - 20
rotate_yawoptional
number

Yaw rotation in degrees

Default: 0Range: -20 - 20
sample_partsoptional
string

Part of the face to sample

Default: "OnlyExpression"
Allowed values :
"OnlyExpression""OnlyRotation""OnlyMouth""OnlyEyes""All"
smileoptional
number

Smile intensity

Default: 0Range: -0.3 - 1.3
winkoptional
number

Wink intensity

Default: 0Range: 0 - 25
woooptional
number

Mouth shape for 'woo'

Default: 0Range: -15 - 15

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/expression-editor

    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