EDedenai
Images

Image Edits

OpenAI-compatible image-edit endpoint.

Accepts either application/json (gpt-image-style images: [{file_id|image_url}]) or multipart/form-data (OpenAI SDK classic shape: image[] UploadFile, optional mask UploadFile, plus text fields). Content-Type drives dispatch.

post/v3/images/edits

Request

  • Base URL
    https://api.edenai.run
  • Auth
    HTTP bearer

Request body

tagsunknown
modelstring required

provider/model, e.g. 'openai/gpt-image-2'

promptstring required
ninteger nullable
sizestring nullable

Provider-specific size string. OpenAI accepts '1024x1024', '1536x1024', '1024x1536', 'auto'. Vertex Imagen accepts square or aspect-ratio strings. Validation is delegated to the provider.

userstring nullable

End-user identifier for abuse tracking.

metadataobject nullable

Arbitrary metadata attached to the request.

extra_headersobject nullable

Additional HTTP headers forwarded to the provider API. Credential headers (Authorization, x-api-key, ...) are rejected.

Example request

{
  "tags": {
    "client": "acme",
    "project": "invoices"
  }
}

Response

Successful Response

costnumber nullable
providerstring nullable
createdinteger nullable
usageobject nullable

Changes

No recorded changes to this operation across all 1 revision of this API.