Skip to content

Document multipart model handling for image edits #896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
akhilmmenon wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Document multipart model handling for image edits #896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5cb92fd
Update Azure-OpenAI docs to include Image Editing section
Apr 29, 2026
8329642
Added runnable version of the code
Apr 29, 2026
4422b20
Made this change provider agnostic
Apr 29, 2026
0bb946d
Update product/ai-gateway/multimodal-capabilities/image-generation.mdx
akhilmmenon Apr 29, 2026
e682f9e
Update product/ai-gateway/multimodal-capabilities/image-generation.mdx
akhilmmenon Apr 29, 2026
25385df
Modified the note for image edit in image-generation.mdx and create-i…
akhilmmenon May 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions api-reference/inference-api/images/create-image-edit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@
title: Create Image Edit
openapi: post /images/edits
---

<Note>
Image edit requests use `multipart/form-data` and the provider-prefixed model aliases inside multipart payloads is not supported, so pass the upstream provider's model or deployment name directly in the `model` form field instead of values like `@provider/model-name`.
Copy link
Copy Markdown
Contributor

@sivadurga-d sivadurga-d May 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do not add here.

</Note>
7 changes: 6 additions & 1 deletion product/ai-gateway/multimodal-capabilities/image-generation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,9 +125,14 @@ curl "https://api.portkey.ai/v1/images/generations" \
</Tab>
</Tabs>

<Note>
For Image Edit requests, provider-prefixed model aliases inside multipart payloads are not supported. The `model` value should match the model or deployment name expected by the upstream provider.
Copy link
Copy Markdown
Contributor

@sivadurga-d sivadurga-d May 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For image edit you can give add a section and example, then below just put note @provider/modelname in request body is not supported.

</Note>

### API Reference

[Create Image](/provider-endpoints/images/create-image)
- [Create Image](/provider-endpoints/images/create-image)
- [Create Image Edit](/provider-endpoints/images/create-image-edit)

### OpenAI gpt-image-1 Parameters

Expand Down