API reference · Recraft
recraft/recraft/v3/edit
Integrate this model through SandBase's unified API, with production-ready schemas and examples.
Production endpoint
Send your first request
OpenAI-compatible endpoint with unified authentication and usage tracking.
POST
https://api.sandbase.ai/v1/runModel ID
recraft/recraft/v3/edit01
Input Schema
6 parameters · 2 required · 4 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
image | string | Required | The URL of the image to modify. Must be less than 5 MB in size, have resolution less than 16 MP and max dimension less than 4096 pixels. |
prompt | string | Required | A text description of areas to change. · Min length: 1 · Max length: 1000 |
style | string | Optional | The style of the generated images. Vector images cost 2X as much. · Options: any, realistic_image, digital_illustration, vector_illustration, realistic_image/b_and_w, realistic_image/hard_flash, realistic_image/hdr, realistic_image/natural_light, realistic_image/studio_portrait, realistic_image/enterprise, realistic_image/motion_blur, realistic_image/evening_light, realistic_image/faded_nostalgia, realistic_image/forest_life, realistic_image/mystic_naturalism, realistic_image/natural_tones, realistic_image/organic_calm, realistic_image/real_life_glow, realistic_image/retro_realism, realistic_image/retro_snapshot, realistic_image/urban_drama, realistic_image/village_realism, realistic_image/warm_folk, digital_illustration/pixel_art, digital_illustration/hand_drawn, digital_illustration/grain, digital_illustration/infantile_sketch, digital_illustration/2d_art_poster, digital_illustration/handmade_3d, digital_illustration/hand_drawn_outline, digital_illustration/engraving_color, digital_illustration/2d_art_poster_2, digital_illustration/antiquarian, digital_illustration/bold_fantasy, digital_illustration/child_book, digital_illustration/child_books, digital_illustration/cover, digital_illustration/crosshatch, digital_illustration/digital_engraving, digital_illustration/expressionism, digital_illustration/freehand_details, digital_illustration/grain_20, digital_illustration/graphic_intensity, digital_illustration/hard_comics, digital_illustration/long_shadow, digital_illustration/modern_folk, digital_illustration/multicolor, digital_illustration/neon_calm, digital_illustration/noir, digital_illustration/nostalgic_pastel, digital_illustration/outline_details, digital_illustration/pastel_gradient, digital_illustration/pastel_sketch, digital_illustration/pop_art, digital_illustration/pop_renaissance, digital_illustration/street_art, digital_illustration/tablet_sketch, digital_illustration/urban_glow, digital_illustration/urban_sketching, digital_illustration/vanilla_dreams, digital_illustration/young_adult_book, digital_illustration/young_adult_book_2, vector_illustration/bold_stroke, vector_illustration/chemistry, vector_illustration/colored_stencil, vector_illustration/contour_pop_art, vector_illustration/cosmics, vector_illustration/cutout, vector_illustration/depressive, vector_illustration/editorial, vector_illustration/emotional_flat, vector_illustration/infographical, vector_illustration/marker_outline, vector_illustration/mosaic, vector_illustration/naivector, vector_illustration/roundish_flat, vector_illustration/segmented_colors, vector_illustration/sharp_contrast, vector_illustration/thin, vector_illustration/vector_photo, vector_illustration/vivid_shapes, vector_illustration/engraving, vector_illustration/line_art, vector_illustration/line_circuit, vector_illustration/linocut · Default: "realistic_image" anyrealistic_imagedigital_illustrationvector_illustrationrealistic_image/b_and_wrealistic_image/hard_flashrealistic_image/hdrrealistic_image/natural_lightrealistic_image/studio_portraitrealistic_image/enterpriserealistic_image/motion_blurrealistic_image/evening_lightrealistic_image/faded_nostalgiarealistic_image/forest_liferealistic_image/mystic_naturalismrealistic_image/natural_tonesrealistic_image/organic_calmrealistic_image/real_life_glowrealistic_image/retro_realismrealistic_image/retro_snapshotrealistic_image/urban_dramarealistic_image/village_realismrealistic_image/warm_folkdigital_illustration/pixel_artdigital_illustration/hand_drawndigital_illustration/graindigital_illustration/infantile_sketchdigital_illustration/2d_art_posterdigital_illustration/handmade_3ddigital_illustration/hand_drawn_outlinedigital_illustration/engraving_colordigital_illustration/2d_art_poster_2digital_illustration/antiquariandigital_illustration/bold_fantasydigital_illustration/child_bookdigital_illustration/child_booksdigital_illustration/coverdigital_illustration/crosshatchdigital_illustration/digital_engravingdigital_illustration/expressionismdigital_illustration/freehand_detailsdigital_illustration/grain_20digital_illustration/graphic_intensitydigital_illustration/hard_comicsdigital_illustration/long_shadowdigital_illustration/modern_folkdigital_illustration/multicolordigital_illustration/neon_calmdigital_illustration/noirdigital_illustration/nostalgic_pasteldigital_illustration/outline_detailsdigital_illustration/pastel_gradientdigital_illustration/pastel_sketchdigital_illustration/pop_artdigital_illustration/pop_renaissancedigital_illustration/street_artdigital_illustration/tablet_sketchdigital_illustration/urban_glowdigital_illustration/urban_sketchingdigital_illustration/vanilla_dreamsdigital_illustration/young_adult_bookdigital_illustration/young_adult_book_2vector_illustration/bold_strokevector_illustration/chemistryvector_illustration/colored_stencilvector_illustration/contour_pop_artvector_illustration/cosmicsvector_illustration/cutoutvector_illustration/depressivevector_illustration/editorialvector_illustration/emotional_flatvector_illustration/infographicalvector_illustration/marker_outlinevector_illustration/mosaicvector_illustration/naivectorvector_illustration/roundish_flatvector_illustration/segmented_colorsvector_illustration/sharp_contrastvector_illustration/thinvector_illustration/vector_photovector_illustration/vivid_shapesvector_illustration/engravingvector_illustration/line_artvector_illustration/line_circuitvector_illustration/linocut |
colors | object[] | Optional | An array of preferable colors · Default: [] |
strength | number | Optional | Defines the difference with the original image, should lie in [0, 1], where 0 means almost identical, and 1 means miserable similarity · Min: 0 · Max: 1 · Default: 0.5 |
style_id | string | Optional | The ID of the custom style reference (optional) |
02
Output Schema
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the generation task |
status | string | Task status: pending, running, completed, failed, timeout |
model | string | Model used for the generation |
outputs | array | Array of output items |
outputs[].url | string | URL of the generated artifact |
outputs[].content_type | string | MIME type (e.g. image/png, video/mp4) |
error | object | null | Error details if failed, null on success |
error.type | string | Machine-readable error type code |
error.message | string | Human-readable error description |
Async Workflow
This model uses asynchronous execution. Submit a request and poll for the result.
- Submit — POST to /v1/run, receive an
id - Poll — GET /v1/run/{id} until status is
completed,failed, ortimeout - Retrieve — Read
outputsfrom the completed response
03
Code Examples
Ready-to-run snippets
# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"model": "recraft/recraft/v3/edit",
"image": "https://static.sandbase.ai/examples/recraft/recraft/v3/edit/input_image_0.jpeg",
"style": "realistic_image",
"colors": [],
"prompt": "winter",
"strength": 0.2,
"style_id": null
}'
# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
-H "Authorization: Bearer YOUR_API_KEY"
