🎨 Image Editing

Image Editing

Editing works like image generation with images added to the request. Pass their URLs in input_image along with your prompt. Some models edit the image directly, while others generate images with optional image references. To see all image generation models that can take input images, visit the Models page and filter by “Image to image”.

cURL
Python

Start the edit

GEN_ID=$(curl -s -X POST \
  https://hub.oxen.ai/api/ai/queue \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OXEN_API_KEY" \
  -d '{
    "model": "gpt-image-2-5-sunburst",
    "input_image": ["https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png"],
    "prompt": "Add a funny hat to the ox"
  }' | jq -r '.generations[0].generation_id')

Wait for it to finish

while true; do
  STATUS=$(curl -s -H "Authorization: Bearer $OXEN_API_KEY" \
    "https://hub.oxen.ai/api/ai/queue/$GEN_ID" | jq -r '.status')
  case $STATUS in succeeded|failed|cancelled) break;; esac
  sleep 3
done

curl -s -H "Authorization: Bearer $OXEN_API_KEY" \
  "https://hub.oxen.ai/api/ai/queue/$GEN_ID" | jq -r '.result_url'

import os
import requests
import time

HEADERS = {
    "Authorization": f"Bearer {os.getenv('OXEN_API_KEY')}",
    "Content-Type": "application/json",
}

enqueue = requests.post(
    "https://hub.oxen.ai/api/ai/queue",
    headers=HEADERS,
    json={
        "model": "gpt-image-2-5-sunburst",
        "input_image": ["https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png"],
        "prompt": "Add a funny hat to the ox",
    },
)
enqueue.raise_for_status()
generation_id = enqueue.json()["generations"][0]["generation_id"]

while True:
    data = requests.get(
        f"https://hub.oxen.ai/api/ai/queue/{generation_id}",
        headers=HEADERS,
    ).json()
    if data["status"] in {"succeeded", "failed", "cancelled"}:
        break
    time.sleep(3)

print(f"Edited image: {data['result_url']}")

Pass more than one image to combine them:

{
  "model": "gpt-image-2-5-sunburst",
  "input_image": [
    "https://hub.oxen.ai/api/repos/elau/assets/file/main/bloxy/bloxy_cropped_512x512.png",
    "https://hub.oxen.ai/api/repos/elau/assets/file/main/paintings/Wanderer_above_the_Sea_of_Fog_Caspar_David_Friedrich_399x512.jpeg"
  ],
  "prompt": "Put the character from the first image into the scene from the second"
}

Image URLs must be public, since the model downloads them.

Parameters

model: Model name, for example gpt-image-2-5-sunburst
input_image: Image URL, or an array of URLs
prompt: What to change or create

Models can take more parameters, listed in each model’s API reference. The queue reference covers the rest of the queue API.

Playground Interface

The model playground allows you to quickly test out the boundaries of any model in the UI. This is a great way to experiment with different prompts and see how the model performs before integrating it into your application.

The generated images automatically get saved to a dataset that you can share with your team, download and use to train your own model, or use in your application.

Get Started

Developer Tools

🎨 Image Editing

Image Editing

Parameters

Playground Interface

​Image Editing

​Parameters

​Playground Interface

Image Editing

Parameters

Playground Interface