Edit Image

Edit an image based on a text prompt and optional mask using the specified model.

Authorization

X-API-Key<token>

Project-scoped Nebul API key. Also accepted as Authorization: Bearer <key>.

In: header

Request Body

multipart/form-data

TypeScript Definitions

Use the request body type in TypeScript.

model*Model

Length1 <= length

prompt*Prompt

Length1 <= length

image*array<>

mask?|null

n?N

Default1

size?Size

Default"auto"

response_format?Response Format

Default"b64_json"

quality?Quality

Default"auto"

background?Background

Default"auto"

guidance?number|null

user?string|null

output_format?Output Format

Default"png"

Response Body

`application/json`

curl -X POST "https://example.com/v1/images/edits" \  -F model="string" \  -F prompt="string" \  -F image="[    \"string\"  ]"

{  "created": 0,  "data": [    {      "b64_json": "string",      "url": "string"    }  ],  "background": "string",  "output_format": "string",  "size": "string",  "quality": "string",  "usage": {}}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

422application/json

`application/json`

`application/json`