Tooncrafter Serverless API
Create videos from illustrated input images
POST /v2/tooncrafter · submit + poll 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3from segmind import SegmindClient, InferenceFailed, InferenceTimeout
4
5# Async (v2) — recommended for long-running / video models.
6# run() blocks up to 600s; submit_async + job.wait(timeout=...) sets a longer
7# deadline and keeps the request_id so you can re-poll later.
8client = SegmindClient() # reads SEGMIND_API_KEY
9payload = {
10 "loop": False,
11 "seed": 42,
12 "prompt": "cartoon character animation",
13 "image_1": "https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t1.jpg",
14 "image_2": "https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t2.jpg",
15 "image_3": "https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t3.jpg",
16 "image_4": "https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t4.jpg",
17 "image_5": "https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t5.jpg",
18 "image_6": "https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t6.jpg",
19 "max_width": 512,
20 "max_height": 512,
21 "interpolate": False,
22 "negative_prompt": "low quality",
23 "color_correction": True,
24}
25job = client.submit_async("tooncrafter", **payload)
26print(job.request_id) # available immediately
27try:
28 result = job.wait(timeout=900, interval=2.0)
29 print(result["status"]) # COMPLETED
30 print(result.get("output")) # model output (e.g. video URL)
31except InferenceTimeout as e:
32 print("still running:", e.request_id) # re-poll later with this id
33except InferenceFailed as e:
34 print("failed:", e.detail)
35
36# Fast models (<=600s) can use the one-liner instead:
37# result = segmind.run("tooncrafter", **payload) 1# pip install "segmind>=1.1.0"
2# export SEGMIND_API_KEY="YOUR_API_KEY"
3from segmind import SegmindClient, InferenceFailed, InferenceTimeout
4
5# Async (v2) — recommended for long-running / video models.
6# run() blocks up to 600s; submit_async + job.wait(timeout=...) sets a longer
7# deadline and keeps the request_id so you can re-poll later.
8client = SegmindClient() # reads SEGMIND_API_KEY
9payload = {
10 "loop": False,
11 "seed": 42,
12 "prompt": "cartoon character animation",
13 "image_1": "https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t1.jpg",
14 "image_2": "https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t2.jpg",
15 "image_3": "https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t3.jpg",
16 "image_4": "https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t4.jpg",
17 "image_5": "https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t5.jpg",
18 "image_6": "https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t6.jpg",
19 "max_width": 512,
20 "max_height": 512,
21 "interpolate": False,
22 "negative_prompt": "low quality",
23 "color_correction": True,
24}
25job = client.submit_async("tooncrafter", **payload)
26print(job.request_id) # available immediately
27try:
28 result = job.wait(timeout=900, interval=2.0)
29 print(result["status"]) # COMPLETED
30 print(result.get("output")) # model output (e.g. video URL)
31except InferenceTimeout as e:
32 print("still running:", e.request_id) # re-poll later with this id
33except InferenceFailed as e:
34 print("failed:", e.detail)
35
36# Fast models (<=600s) can use the one-liner instead:
37# result = segmind.run("tooncrafter", **payload)API Endpoint
https://api.segmind.com/v1/tooncrafterParameters
image_1requiredstring (uri)First input image
"https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t1.jpg"image_2requiredstring (uri)Second input image
"https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t2.jpg"color_correctionoptionalbooleanIf the colors are coming out strange, or if the colors between your input images are very different, disable this
trueimage_10optionalstring (uri)Tenth input image (optional)
nullimage_3optionalstring (uri)Third input image (optional)
"https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t3.jpg"image_4optionalstring (uri)Fourth input image (optional)
"https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t4.jpg"image_5optionalstring (uri)Fifth input image (optional)
"https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t5.jpg"image_6optionalstring (uri)Sixth input image (optional)
"https://segmind-sd-models.s3.amazonaws.com/display_images/tooncrafter/t6.jpg"image_7optionalstring (uri)Seventh input image (optional)
nullimage_8optionalstring (uri)Eighth input image (optional)
nullimage_9optionalstring (uri)Ninth input image (optional)
nullinterpolateoptionalbooleanEnable 2x interpolation using FILM
falseloopoptionalbooleanLoop the video
falsemax_heightoptionalintegerMaximum height of the video
512256512768max_widthoptionalintegerMaximum width of the video
512256512768negative_promptoptionalstringThings you do not want to see in your video
"low quality"promptoptionalstringEnter your prompt
"cartoon character animation"seedoptionalintegerSet a seed for reproducibility. Random by default.
42Response Type
Returns: Video
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/tooncrafterSubmit — 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