Caricature Style Serverless API
Transform everyday photos into lively, whimsical caricature illustrations that highlight individual features with playful exaggeration.
POST /v2/caricature-style · 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 "caricature-style",
9 image="https://segmind-resources.s3.amazonaws.com/output/39a9c58a-4f9d-49d8-9fe6-6189ffbc410b-guy.webp",
10 size="1024x1024",
11 quality="high",
12 background="opaque",
13 output_compression=100,
14 output_format="png",
15)
16print(result["status"]) # COMPLETED
17print(result.get("output")) # model output (e.g. media URL)
18print(result["metrics"]["inference_time"]) # server compute seconds
19
20# --- Or submit + poll manually (track request_id, control the cadence) ---
21from segmind import SegmindClient, InferenceFailed, InferenceTimeout
22
23client = SegmindClient() # reads SEGMIND_API_KEY
24payload = {
25 "image": "https://segmind-resources.s3.amazonaws.com/output/39a9c58a-4f9d-49d8-9fe6-6189ffbc410b-guy.webp",
26 "size": "1024x1024",
27 "quality": "high",
28 "background": "opaque",
29 "output_compression": 100,
30 "output_format": "png",
31}
32job = client.submit_async("caricature-style", **payload)
33print(job.request_id) # available immediately
34try:
35 result = job.wait(timeout=600, interval=1.0)
36except InferenceTimeout as e:
37 print("still running:", e.request_id)
38except InferenceFailed as e:
39 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 "caricature-style",
9 image="https://segmind-resources.s3.amazonaws.com/output/39a9c58a-4f9d-49d8-9fe6-6189ffbc410b-guy.webp",
10 size="1024x1024",
11 quality="high",
12 background="opaque",
13 output_compression=100,
14 output_format="png",
15)
16print(result["status"]) # COMPLETED
17print(result.get("output")) # model output (e.g. media URL)
18print(result["metrics"]["inference_time"]) # server compute seconds
19
20# --- Or submit + poll manually (track request_id, control the cadence) ---
21from segmind import SegmindClient, InferenceFailed, InferenceTimeout
22
23client = SegmindClient() # reads SEGMIND_API_KEY
24payload = {
25 "image": "https://segmind-resources.s3.amazonaws.com/output/39a9c58a-4f9d-49d8-9fe6-6189ffbc410b-guy.webp",
26 "size": "1024x1024",
27 "quality": "high",
28 "background": "opaque",
29 "output_compression": 100,
30 "output_format": "png",
31}
32job = client.submit_async("caricature-style", **payload)
33print(job.request_id) # available immediately
34try:
35 result = job.wait(timeout=600, interval=1.0)
36except InferenceTimeout as e:
37 print("still running:", e.request_id)
38except InferenceFailed as e:
39 print("failed:", e.detail)API Endpoint
https://api.segmind.com/v1/caricature-styleParameters
imagerequiredstring (uri)Provide a high-resolution image URI. Use professional photos to highlight expressions.
"https://segmind-resources.s3.amazonaws.com/output/39a9c58a-4f9d-49d8-9fe6-6189ffbc410b-guy.webp"backgroundoptionalstringDecide background transparency. 'Opaque' works best for standalone images.
"opaque""transparent""opaque"output_compressionoptionalintegerSet image compression. '85' is advisable for decent quality with smaller file size.
100output_formatoptionalstringSelect image format. Use 'PNG' for lossless quality.
"png""png""jpeg""webp"qualityoptionalstringSet visual quality. 'High' is ideal for detailed caricatures.
"high""low""medium""high"sizeoptionalstringSelect image resolution. Use '1024x1024' for fast processing and detailed features.
"1024x1024""1024x1024""1536x1024""1024x1536""auto"use_case_configoptionalstringResponse 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/caricature-styleSubmit — 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