Open AI (ChatGPT)
๐Ÿ‡บ๐Ÿ‡ธ English
  • ๐Ÿ‡บ๐Ÿ‡ธ English
  • ๐Ÿ‡ฏ๐Ÿ‡ต Japanese
  • ๐Ÿ‡ต๐Ÿ‡น Portuguese
  • ๐Ÿ‡ฐ๐Ÿ‡ท Korea
  • ๐Ÿ‡ฉ๐Ÿ‡ช German
  1. Images
Open AI (ChatGPT)
๐Ÿ‡บ๐Ÿ‡ธ English
  • ๐Ÿ‡บ๐Ÿ‡ธ English
  • ๐Ÿ‡ฏ๐Ÿ‡ต Japanese
  • ๐Ÿ‡ต๐Ÿ‡น Portuguese
  • ๐Ÿ‡ฐ๐Ÿ‡ท Korea
  • ๐Ÿ‡ฉ๐Ÿ‡ช German
  • README
  • Introduction
  • Authentication
  • Making requests
  • Streaming
  • Debugging requests
  • Backward compatibility
  • Administration
  • Audio
    • Create speech
      POST
    • Create transcription
      POST
    • Create translation
      POST
  • Chat
    • Create chat completion
      POST
  • Embeddings
    • Create embeddings
      POST
  • Fine-tuning
    • Create fine-tuning job
      POST
    • List fine-tuning jobs
      GET
    • List fine-tuning events
      GET
    • List fine-tuning checkpoints
      GET
    • Retrieve fine-tuning job
      GET
    • Cancel fine-tuning
      POST
  • Batch
    • Create batch
      POST
    • Retrieve batch
      GET
    • Cancel batch
      POST
    • List batch
      GET
  • Files
    • README
    • Upload file
    • List files
    • Retrieve file
    • Delete file
    • Retrieve file content
  • Uploads
    • Create upload
    • Add upload part
    • Complete upload
  • Images
    • README
    • Create image
      POST
    • Create image edit
      POST
    • Create image variation
      POST
  • Models
    • List models
    • Retrieve model
    • Delete a fine-tuned model
  • Moderations
    • Create moderation
  • Invites
    • List invites
    • Create invite
    • Retrieve invite
    • Delete invite
  • Users
    • List users
    • Modify user
    • Retrieve user
  • Projects
    • List projects
    • Create project
    • Retrieve project
    • Modify project
    • Archive project
  • Project users
    • List project users
    • Create project user
    • Retrieve project user
    • Modify project user
    • Delete project user
    • Create project service account
  • Project service accounts
    • List project service accounts
    • Create project service account
    • Retrieve project service account
    • Delete project service account
  • Project API keys
    • List project API keys
    • Retrieve project API key
    • Delete project API key
  • Project rate limits
    • List project rate limits
    • Modify project rate limit
  • Audit logs
    • List audit logs
  • Usage
    • Completions
    • Embeddings
    • Moderations
    • Images
    • Audio speeches
    • Audio transcriptions
    • Vector stores
    • Code interpreter sessions
    • Costs
  • Completions
    • Create completion
  • Assistants (v1)
    • Create assistant (v1)
    • Create assistant file (v1)
    • List assistants (v1)
    • List assistant files (v1)
    • Retrieve assistant (v1)
    • Retrieve assistant file (v1)
    • Modify assistant (v1)
    • Delete assistant (v1)
    • Delete assistant file (v1)
  • Threads (v1)
    • Create thread (v1)
    • Retrieve thread (v1)
    • Modify thread (v1)
    • Delete thread (v1)
  • Messages (v1)
    • Create message (v1)
    • List messages (v1)
    • List message files (v1)
    • Retrieve message (v1)
    • Retrieve message file (v1)
    • Modify message (v1)
  • Runs (v1)
    • Create run (v1)
    • Create thread and run (v1)
    • List runs (v1)
    • List run steps (v1)
    • Retrieve run (v1)
    • Retrieve run step (v1)
    • Modify run (v1)
    • Submit tool outputs to run (v1)
    • Cancel a run (v1)
  1. Images

Create image edit

POST
https://api.openai.com/v1/images/edits
Creates an edited or extended image given an original image and a prompt.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.openai.com/v1/images/edits' \
--header 'Authorization: Bearer ' \
--form 'image=@"cmMtdXBsb2FkLTE2ODc4MzMzNDc3NTEtMjA=/31225951_59371037e9_small.png"' \
--form 'prompt="A cute baby sea otter wearing a beret."' \
--form 'n="2"' \
--form 'size="1024x1024"' \
--form 'response_format="url"' \
--form 'user=""'
Response Response Example
{
  "created": 1589478378,
  "data": [
    {
      "url": "https://..."
    },
    {
      "url": "https://..."
    }
  ]
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
Authorization
stringย 
optional
Example:
Bearer {{YOUR_API_KEY}}
Body Params multipart/form-data
image
fileย 
required
The image to edit. Must be a valid PNG file, less than 4MB, and square. If mask is not provided, image must have transparency, which will be used as the mask.
Example:
cmMtdXBsb2FkLTE2ODc4MzMzNDc3NTEtMjA=/31225951_59371037e9_small.png
mask
fileย 
optional
An additional image whose fully transparent areas (e.g. where alpha is zero) indicate whereย imageย should be edited. Must be a valid PNG file, less than 4MB, and have the same dimensions asย image.
Example:
[]
prompt
stringย 
required
A text description of the desired image(s). The maximum length is 1000 characters.
Example:
A cute baby sea otter wearing a beret.
n
stringย 
optional
The number of images to generate. Must be between 1 and 10.
Example:
2
size
stringย 
optional
The size of the generated images. Must be one ofย 256x256,ย 512x512, orย 1024x1024.
Example:
1024x1024
response_format
stringย 
optional
The format in which the generated images are returned. Must be one ofย urlย orย b64_json.
Example:
url
user
stringย 
optional
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.ย Learn more.

Responses

๐ŸŸข200ๆˆๅŠŸ
application/json
Body
created
integerย 
required
data
arrayย [object {1}]ย 
required
url
stringย 
required
Modified atย 2024-12-23 06:20:38
Previous
Create image
Next
Create image variation
Built with