--- title: Qwen 2 Edit-Image url: https://runapi.ai/docs/api/qwen-2/edit-image.md canonical: https://runapi.ai/docs/api/qwen-2/edit-image locale: en --- # Qwen 2 Edit-Image ## Overview Use the edit image endpoint with a supported model. Use the returned Task ID to retrieve its state, or provide callback_url for the deliveries documented below. ### Quick start 1. Create an API key and set it as RUNAPI_API_KEY. 2. Choose a supported model and send a POST request whose body matches that model's schema. 3. Store the returned task ID, then poll until a terminal state or handle the callbacks documented below. ## Endpoint POST /api/v1/qwen_2/edit_image Base URL: https://runapi.ai API version: v1 Authentication: Authorization: Bearer YOUR_API_TOKEN ## Supported models Open a model page for current pricing, rate limits, and commercial-usage details. - [qwen-2-edit-image](/models/qwen-2/edit-image) ## Request schema Fields and allowed values depend on the selected model. When supplied, callback_url receives the Task deliveries documented below. ### qwen-2-edit-image ```json { "aspect_ratio": { "enum": [ "1:1", "2:3", "3:2", "3:4", "4:3", "9:16", "16:9", "21:9" ], "type": "string" }, "callback_url": { "type": "string" }, "enable_safety_checker": { "type": "boolean" }, "model": { "type": "string" }, "output_format": { "enum": [ "jpeg", "png" ], "type": "string" }, "prompt": { "required": true, "type": "string" }, "seed": { "type": "integer" }, "source_image_url": { "required": true, "type": "string" } } ``` ## Create acceptance HTTP 202 - POST /api/v1/qwen_2/edit_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "id": { "type": "string" }, "status": { "enum": [ "processing" ], "type": "string" }, "task_replayed": { "type": "boolean" } }, "required": [ "id", "status", "billing" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "billing": { "refund": null, "reservation": null, "settlement": null }, "id": "tsk_reference_demo", "status": "processing" } ``` ## Polling processing HTTP 200 - GET /api/v1/qwen_2/edit_image/:id ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "id": { "type": "string" }, "status": { "enum": [ "processing" ], "type": "string" } }, "required": [ "id", "status", "billing" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "billing": { "refund": null, "reservation": null, "settlement": null }, "id": "tsk_reference_demo", "status": "processing" } ``` ## Polling completed HTTP 200 - GET /api/v1/qwen_2/edit_image/:id ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "id": { "type": "string" }, "images": { "items": { "properties": { "url": { "type": "string" } }, "required": [ "url" ], "type": "object", "unevaluatedProperties": false }, "type": "array" }, "status": { "enum": [ "completed" ], "type": "string" } }, "required": [ "id", "status", "images", "billing" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "billing": { "refund": null, "reservation": null, "settlement": null }, "id": "tsk_reference_demo", "images": [ { "url": "https://cdn.runapi.ai/public/samples/image.jpg" } ], "status": "completed" } ``` ## Polling failed HTTP 200 - GET /api/v1/qwen_2/edit_image/:id ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "type": "string" }, "id": { "type": "string" }, "status": { "enum": [ "failed" ], "type": "string" } }, "required": [ "id", "status", "error", "billing" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "billing": { "refund": null, "reservation": null, "settlement": null }, "error": "Task processing failed.", "id": "tsk_reference_demo", "status": "failed" } ``` ## Customer callback: completed HTTP 200 - POST callback_url ### Response schema ```json { "properties": { "id": { "type": "string" }, "images": { "items": { "properties": { "url": { "type": "string" } }, "required": [ "url" ], "type": "object", "unevaluatedProperties": false }, "type": "array" }, "status": { "enum": [ "completed" ], "type": "string" } }, "required": [ "id", "status", "images" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "id": "tsk_reference_demo", "images": [ { "url": "https://cdn.runapi.ai/public/samples/image.jpg" } ], "status": "completed" } ``` ## Customer callback: failed HTTP 200 - POST callback_url ### Response schema ```json { "properties": { "error": { "oneOf": [ { "type": "string" }, { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } ] }, "id": { "type": "string" }, "status": { "enum": [ "failed" ], "type": "string" } }, "required": [ "id", "status", "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "generation_failed", "message": "Task processing failed." }, "id": "tsk_reference_demo", "status": "failed" } ``` ## Errors HTTP 401 - POST /api/v1/qwen_2/edit_image This response has no body. ## Errors HTTP 401 - GET /api/v1/qwen_2/edit_image/:id This response has no body. ## Errors HTTP 400 - POST /api/v1/qwen_2/edit_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "model_must_be_one_of_qwen-2-edit-image", "message": "model must be one of: qwen-2-edit-image" } } ``` ## Errors HTTP 402 - POST /api/v1/qwen_2/edit_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "insufficient_balance", "message": "Insufficient balance" } } ``` ## Errors HTTP 403 - POST /api/v1/qwen_2/edit_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "api_token_credit_limit_exceeded", "message": "API key credit limit exceeded" } } ``` ## Errors HTTP 409 - POST /api/v1/qwen_2/edit_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "request_conflict", "message": "The request uses features that are not supported for the selected model" } } ``` ## Errors HTTP 429 - POST /api/v1/qwen_2/edit_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "rate_limited", "message": "Rate limit reached. Please retry later." } } ``` ## Errors HTTP 503 - POST /api/v1/qwen_2/edit_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "service_unavailable", "message": "Service under maintenance, please try again later" } } ``` ## Errors HTTP 504 - POST /api/v1/qwen_2/edit_image ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "billing": { "refund": null, "reservation": null, "settlement": null }, "error": { "code": "timeout_error", "message": "The request timed out" } } ``` ## Errors HTTP 404 - GET /api/v1/qwen_2/edit_image/:id ### Response schema ```json { "properties": { "billing": { "properties": { "refund": { "oneOf": [ { "properties": { "refunded_at": { "type": "string" } }, "required": [ "refunded_at" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "reservation": { "oneOf": [ { "properties": { "amount_cents": { "type": "integer" } }, "required": [ "amount_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] }, "settlement": { "oneOf": [ { "properties": { "amount_micro_cents": { "type": "integer" }, "charged_amount_cents": { "type": "integer" } }, "required": [ "charged_amount_cents", "amount_micro_cents" ], "type": "object", "unevaluatedProperties": false }, { "enum": [ null ] } ] } }, "required": [ "reservation", "settlement", "refund" ], "type": "object", "unevaluatedProperties": false }, "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object", "unevaluatedProperties": false } }, "required": [ "error" ], "type": "object", "unevaluatedProperties": false } ``` ### Response example ```json { "error": { "code": "not_found", "message": "Task with id 'tsk_reference_demo' not found" } } ``` ## Generated Code Samples Use cURL directly, or install an SDK for your language. Each sample submits the validated request shown in this reference. ### curl ```curl curl -X POST https://runapi.ai/api/v1/qwen_2/edit_image \ -H 'Authorization: Bearer YOUR_API_TOKEN' \ -H 'Content-Type: application/json' \ -d '{"model":"qwen-2-edit-image","prompt":"Change the vase to cobalt blue.","source_image_url":"https://cdn.runapi.ai/public/samples/image.jpg"}' ``` ### javascript #### Install ```bash npm install @runapi.ai/qwen-2 ``` ```javascript import { Qwen2Client } from "@runapi.ai/qwen-2"; const client = new Qwen2Client({ apiKey: process.env.RUNAPI_API_KEY }); const task = await client.editImage.create({ "model": "qwen-2-edit-image", "prompt": "Change the vase to cobalt blue.", "source_image_url": "https://cdn.runapi.ai/public/samples/image.jpg" }); ``` ### python #### Install ```bash pip install runapi-qwen-2 ``` ```python import os from runapi.qwen_2 import Qwen2Client client = Qwen2Client(api_key=os.environ["RUNAPI_API_KEY"]) task = client.edit_image.create( model="qwen-2-edit-image", prompt="Change the vase to cobalt blue.", source_image_url="https://cdn.runapi.ai/public/samples/image.jpg" ) ``` ### go #### Install ```bash go get github.com/runapi-ai/qwen-2-sdk/go@latest ``` ```go package main import ( "context" "log" "os" "github.com/runapi-ai/core-sdk/go/option" qwen2 "github.com/runapi-ai/qwen-2-sdk/go/qwen2" ) func main() { client, err := qwen2.NewClient(option.WithAPIKey(os.Getenv("RUNAPI_API_KEY"))) if err != nil { log.Fatal(err) } task, err := client.EditImage.Create(context.Background(), qwen2.EditImageParams{ Model: "qwen-2-edit-image", Prompt: "Change the vase to cobalt blue.", SourceImageURL: "https://cdn.runapi.ai/public/samples/image.jpg", }) if err != nil { log.Fatal(err) } _ = task } ``` ### ruby #### Install ```bash gem install runapi-qwen-2 ``` ```ruby require "runapi/qwen_2" client = RunApi::Qwen2::Client.new(api_key: ENV.fetch("RUNAPI_API_KEY")) task = client.edit_image.create( model: "qwen-2-edit-image", prompt: "Change the vase to cobalt blue.", source_image_url: "https://cdn.runapi.ai/public/samples/image.jpg" ) ``` ### java #### Install ```kotlin implementation("ai.runapi:runapi-qwen-2") ``` ```java import ai.runapi.qwen2.Qwen2Client; import ai.runapi.qwen2.types.EditImageParams; import ai.runapi.core.polling.TaskCreateResponse; public final class Example { public static void main(String[] args) { Qwen2Client client = Qwen2Client.builder() .apiKey(System.getenv("RUNAPI_API_KEY")) .build(); TaskCreateResponse task = client.editImage().create( EditImageParams.builder() .model("qwen-2-edit-image") .prompt("Change the vase to cobalt blue.") .sourceImageUrl("https://cdn.runapi.ai/public/samples/image.jpg") .build() ); } } ``` ### php #### Install ```bash composer require runapi-ai/qwen-2 ``` ```php editImage->create([ "model" => "qwen-2-edit-image", "prompt" => "Change the vase to cobalt blue.", "source_image_url" => "https://cdn.runapi.ai/public/samples/image.jpg" ]); ``` ## Related Guides - [Authentication](/docs/guides/authentication) - [Quickstart](/docs/guides/task-api/quickstart)