> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developers.meshapi.ai/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.meshapi.ai/_mcp/server. # Edit an image POST https://api.meshapi.ai/v1/images/edits Content-Type: application/json OpenAI-compatible image editing endpoint. Accepts EITHER ``multipart/form-data`` (binary uploads: ``image``, optional ``mask``, ``reference_images``) OR ``application/json`` whose image fields are data-URL / base64 strings (or ``{"url": ...}`` objects) — the same convention as the chat ``image_url``. Remote http(s) URLs are rejected (mesh does not server-side-fetch images); send a ``data:image/;base64,`` URL. Supports ``operation`` in {edit, remove_background, upscale, outpaint, mix, reframe, inpaint}. Each op is gated by the resolved model's supports_image_ flag (422 when unset / unsupported); the legacy provider matrix is a transitional backstop for the original four ops. - ``edit`` (default): openai, byteplus, vertex — prompt + image (+ optional mask + refs). - ``remove_background``: openai, vertex — image only; prompt optional. - ``upscale``: vertex (Imagen) or byteplus (Seedream Smart Upscale) — image + upscale_factor (x2|x4; Seedream maps x2→2k, x4→4k). - ``outpaint``: vertex — image + prompt + mask (defines expansion region). - ``mix``: Gemini image models + gpt-image (openai) — prompt + image + 1-3 reference_images (2-4 sources composed into one, sent as image[]); single output. - ``reframe``: Gemini image models — image + aspect_ratio (1:1|3:4|4:3|9:16|16:9|2:3|3:2); recomposes by outpainting to the target ratio; single output. - ``inpaint``: openai, vertex — image + mask (canonical WHITE=edit; mesh normalizes per provider). Optional mask_feather blends the result back through the mask (Pillow; 501 if unavailable). > **Note:** The image response may not render in GitBook's "Test it" panel. > To view the edited image, try this endpoint with Postman, curl, or another > HTTP client. Reference: https://developers.meshapi.ai/api-reference/mesh-api/images/edit-image ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: openapi version: 1.0.0 paths: /v1/images/edits: post: operationId: edit-image summary: Edit an image description: >- OpenAI-compatible image editing endpoint. Accepts EITHER ``multipart/form-data`` (binary uploads: ``image``, optional ``mask``, ``reference_images``) OR ``application/json`` whose image fields are data-URL / base64 strings (or ``{"url": ...}`` objects) — the same convention as the chat ``image_url``. Remote http(s) URLs are rejected (mesh does not server-side-fetch images); send a ``data:image/;base64,`` URL. Supports ``operation`` in {edit, remove_background, upscale, outpaint, mix, reframe, inpaint}. Each op is gated by the resolved model's supports_image_ flag (422 when unset / unsupported); the legacy provider matrix is a transitional backstop for the original four ops. - ``edit`` (default): openai, byteplus, vertex — prompt + image (+ optional mask + refs). - ``remove_background``: openai, vertex — image only; prompt optional. - ``upscale``: vertex (Imagen) or byteplus (Seedream Smart Upscale) — image + upscale_factor (x2|x4; Seedream maps x2→2k, x4→4k). - ``outpaint``: vertex — image + prompt + mask (defines expansion region). - ``mix``: Gemini image models + gpt-image (openai) — prompt + image + 1-3 reference_images (2-4 sources composed into one, sent as image[]); single output. - ``reframe``: Gemini image models — image + aspect_ratio (1:1|3:4|4:3|9:16|16:9|2:3|3:2); recomposes by outpainting to the target ratio; single output. - ``inpaint``: openai, vertex — image + mask (canonical WHITE=edit; mesh normalizes per provider). Optional mask_feather blends the result back through the mask (Pillow; 501 if unavailable). > **Note:** The image response may not render in GitBook's "Test it" panel. > To view the edited image, try this endpoint with Postman, curl, or another > HTTP client. tags: - images parameters: - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: The edited image(s). content: application/json: schema: description: Any type '401': description: Missing or invalid API key content: application/json: schema: description: Any type '402': description: Insufficient balance or spend cap reached content: application/json: schema: description: Any type '415': description: Unsupported image content type content: application/json: schema: description: Any type '422': description: Validation error (missing required field or oversized file) content: application/json: schema: description: Any type '429': description: Rate limit exceeded content: application/json: schema: description: Any type '500': description: Upstream provider error content: application/json: schema: description: Any type '501': description: Provider does not support image editing content: application/json: schema: description: Any type requestBody: content: application/json: schema: description: Any type servers: - url: https://api.meshapi.ai description: Production Server components: securitySchemes: HTTPBearer: type: http scheme: bearer ``` ## Examples **Request** ```json { "model": "openai/gpt-image-1", "prompt": "Add a red scarf to the portrait", "image": { "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==" } } ``` **Response** ```json { "created": 1717200000, "data": [ { "url": "https://images.example.com/edits/portrait-with-scarf.png" } ] } ``` **SDK Code** ```python import requests url = "https://api.meshapi.ai/v1/images/edits" payload = { "model": "openai/gpt-image-1", "prompt": "Add a red scarf to the portrait", "image": { "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==" } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.meshapi.ai/v1/images/edits'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"model":"openai/gpt-image-1","prompt":"Add a red scarf to the portrait","image":{"url":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.meshapi.ai/v1/images/edits" payload := strings.NewReader("{\n \"model\": \"openai/gpt-image-1\",\n \"prompt\": \"Add a red scarf to the portrait\",\n \"image\": {\n \"url\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\"\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.meshapi.ai/v1/images/edits") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"model\": \"openai/gpt-image-1\",\n \"prompt\": \"Add a red scarf to the portrait\",\n \"image\": {\n \"url\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\"\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.meshapi.ai/v1/images/edits") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"model\": \"openai/gpt-image-1\",\n \"prompt\": \"Add a red scarf to the portrait\",\n \"image\": {\n \"url\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\"\n }\n}") .asString(); ``` ```php request('POST', 'https://api.meshapi.ai/v1/images/edits', [ 'body' => '{ "model": "openai/gpt-image-1", "prompt": "Add a red scarf to the portrait", "image": { "url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==" } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.meshapi.ai/v1/images/edits"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"model\": \"openai/gpt-image-1\",\n \"prompt\": \"Add a red scarf to the portrait\",\n \"image\": {\n \"url\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==\"\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "model": "openai/gpt-image-1", "prompt": "Add a red scarf to the portrait", "image": ["url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg=="] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.meshapi.ai/v1/images/edits")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```