Skip to main content
POST
/
images
/
variations
cURL
curl https://gateway.obiguard.ai/v1/images/variations \
  -H "x-obiguard-api-key: $OBIGUARD_API_KEY" \
  -F image="@otter.png" \
  -F n=2 \
  -F size="1024x1024"
from obiguard import Obiguard

client = Obiguard(
obiguard_api_key="vk-obg***", # Your Obiguard virtual key

)

response = client.images.create_variation(
image=open("image_edit_original.png", "rb"),
n=2,
size="1024x1024"
)
const form = new FormData();
form.append('image', '<string>');
form.append('model', 'dall-e-2');
form.append('n', '1');
form.append('response_format', 'url');
form.append('size', '1024x1024');
form.append('user', 'user-1234');

const options = {method: 'POST', headers: {'x-obiguard-api-key': '<api-key>'}};

options.body = form;

fetch('https://gateway.obiguard.ai/v1/images/variations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://gateway.obiguard.ai/v1/images/variations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\ndall-e-2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"n\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"response_format\"\r\n\r\nurl\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"size\"\r\n\r\n1024x1024\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nuser-1234\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Content-Type: multipart/form-data; boundary=---011000010111000001101001",
"x-obiguard-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://gateway.obiguard.ai/v1/images/variations"

payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\ndall-e-2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"n\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"response_format\"\r\n\r\nurl\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"size\"\r\n\r\n1024x1024\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nuser-1234\r\n-----011000010111000001101001--")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-obiguard-api-key", "<api-key>")
req.Header.Add("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://gateway.obiguard.ai/v1/images/variations")
.header("x-obiguard-api-key", "<api-key>")
.header("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\ndall-e-2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"n\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"response_format\"\r\n\r\nurl\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"size\"\r\n\r\n1024x1024\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nuser-1234\r\n-----011000010111000001101001--")
.asString();
require 'uri'
require 'net/http'

url = URI("https://gateway.obiguard.ai/v1/images/variations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-obiguard-api-key"] = '<api-key>'
request["Content-Type"] = 'multipart/form-data; boundary=---011000010111000001101001'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\ndall-e-2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"n\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"response_format\"\r\n\r\nurl\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"size\"\r\n\r\n1024x1024\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"user\"\r\n\r\nuser-1234\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body
{
  "created": 123,
  "data": [
    {
      "b64_json": "<string>",
      "url": "<string>",
      "revised_prompt": "<string>"
    }
  ]
}

Authorizations

x-obiguard-api-key
string
header
required

Body

multipart/form-data
image
file
required

The image to use as the basis for the variation(s). Must be a valid PNG file, less than 4MB, and square.

model
default:dall-e-2

The model to use for image generation. Only dall-e-2 is supported at this time.

Example:

"dall-e-2"

n
integer | null
default:1

The number of images to generate. Must be between 1 and 10. For dall-e-3, only n=1 is supported.

Required range: 1 <= x <= 10
Example:

1

response_format
enum<string> | null
default:url

The format in which the generated images are returned. Must be one of url or b64_json. URLs are only valid for 60 minutes after the image has been generated.

Available options:
url,
b64_json
Example:

"url"

size
enum<string> | null
default:1024x1024

The size of the generated images. Must be one of 256x256, 512x512, or 1024x1024.

Available options:
256x256,
512x512,
1024x1024
Example:

"1024x1024"

user
string

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Example:

"user-1234"

Response

200 - application/json

OK

created
integer
required
data
object[]
required