Picture editing

curl --request POST \
  --url https://api.tikway.ai/v1/images/edits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "microsoft/mai-image-2.5-pro",
  "prompt": "Keep the apple unchanged and replace only its background with a misty enchanted forest under soft cinematic lighting.",
  "size": "1024x1024",
  "images": [
    {
      "image_url": "https://gd-hbimg.huaban.com/cb36fdfc6ee4707de3ec666d6bc202fb99d9bef326a10d-oQHn3b_fw658"
    }
  ]
}
'

import requests

url = "https://api.tikway.ai/v1/images/edits"

payload = {
    "model": "microsoft/mai-image-2.5-pro",
    "prompt": "Keep the apple unchanged and replace only its background with a misty enchanted forest under soft cinematic lighting.",
    "size": "1024x1024",
    "images": [{ "image_url": "https://gd-hbimg.huaban.com/cb36fdfc6ee4707de3ec666d6bc202fb99d9bef326a10d-oQHn3b_fw658" }]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: 'microsoft/mai-image-2.5-pro',
    prompt: 'Keep the apple unchanged and replace only its background with a misty enchanted forest under soft cinematic lighting.',
    size: '1024x1024',
    images: [
      {
        image_url: 'https://gd-hbimg.huaban.com/cb36fdfc6ee4707de3ec666d6bc202fb99d9bef326a10d-oQHn3b_fw658'
      }
    ]
  })
};

fetch('https://api.tikway.ai/v1/images/edits', 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://api.tikway.ai/v1/images/edits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model' => 'microsoft/mai-image-2.5-pro',
    'prompt' => 'Keep the apple unchanged and replace only its background with a misty enchanted forest under soft cinematic lighting.',
    'size' => '1024x1024',
    'images' => [
        [
                'image_url' => 'https://gd-hbimg.huaban.com/cb36fdfc6ee4707de3ec666d6bc202fb99d9bef326a10d-oQHn3b_fw658'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.tikway.ai/v1/images/edits"

	payload := strings.NewReader("{\n  \"model\": \"microsoft/mai-image-2.5-pro\",\n  \"prompt\": \"Keep the apple unchanged and replace only its background with a misty enchanted forest under soft cinematic lighting.\",\n  \"size\": \"1024x1024\",\n  \"images\": [\n    {\n      \"image_url\": \"https://gd-hbimg.huaban.com/cb36fdfc6ee4707de3ec666d6bc202fb99d9bef326a10d-oQHn3b_fw658\"\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.tikway.ai/v1/images/edits")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"microsoft/mai-image-2.5-pro\",\n  \"prompt\": \"Keep the apple unchanged and replace only its background with a misty enchanted forest under soft cinematic lighting.\",\n  \"size\": \"1024x1024\",\n  \"images\": [\n    {\n      \"image_url\": \"https://gd-hbimg.huaban.com/cb36fdfc6ee4707de3ec666d6bc202fb99d9bef326a10d-oQHn3b_fw658\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.tikway.ai/v1/images/edits")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": \"microsoft/mai-image-2.5-pro\",\n  \"prompt\": \"Keep the apple unchanged and replace only its background with a misty enchanted forest under soft cinematic lighting.\",\n  \"size\": \"1024x1024\",\n  \"images\": [\n    {\n      \"image_url\": \"https://gd-hbimg.huaban.com/cb36fdfc6ee4707de3ec666d6bc202fb99d9bef326a10d-oQHn3b_fw658\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "created": 1713833628,
  "data": [
    {
      "b64_json": "..."
    }
  ],
  "usage": {
    "total_tokens": 100,
    "input_tokens": 50,
    "output_tokens": 50,
    "input_tokens_details": {
      "text_tokens": 10,
      "image_tokens": 40
    }
  }
}

POST

https://api.tikway.ai

images

edits

Picture editing

curl --request POST \
  --url https://api.tikway.ai/v1/images/edits \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "microsoft/mai-image-2.5-pro",
  "prompt": "Keep the apple unchanged and replace only its background with a misty enchanted forest under soft cinematic lighting.",
  "size": "1024x1024",
  "images": [
    {
      "image_url": "https://gd-hbimg.huaban.com/cb36fdfc6ee4707de3ec666d6bc202fb99d9bef326a10d-oQHn3b_fw658"
    }
  ]
}
'

import requests

url = "https://api.tikway.ai/v1/images/edits"

payload = {
    "model": "microsoft/mai-image-2.5-pro",
    "prompt": "Keep the apple unchanged and replace only its background with a misty enchanted forest under soft cinematic lighting.",
    "size": "1024x1024",
    "images": [{ "image_url": "https://gd-hbimg.huaban.com/cb36fdfc6ee4707de3ec666d6bc202fb99d9bef326a10d-oQHn3b_fw658" }]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: 'microsoft/mai-image-2.5-pro',
    prompt: 'Keep the apple unchanged and replace only its background with a misty enchanted forest under soft cinematic lighting.',
    size: '1024x1024',
    images: [
      {
        image_url: 'https://gd-hbimg.huaban.com/cb36fdfc6ee4707de3ec666d6bc202fb99d9bef326a10d-oQHn3b_fw658'
      }
    ]
  })
};

fetch('https://api.tikway.ai/v1/images/edits', 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://api.tikway.ai/v1/images/edits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model' => 'microsoft/mai-image-2.5-pro',
    'prompt' => 'Keep the apple unchanged and replace only its background with a misty enchanted forest under soft cinematic lighting.',
    'size' => '1024x1024',
    'images' => [
        [
                'image_url' => 'https://gd-hbimg.huaban.com/cb36fdfc6ee4707de3ec666d6bc202fb99d9bef326a10d-oQHn3b_fw658'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.tikway.ai/v1/images/edits"

	payload := strings.NewReader("{\n  \"model\": \"microsoft/mai-image-2.5-pro\",\n  \"prompt\": \"Keep the apple unchanged and replace only its background with a misty enchanted forest under soft cinematic lighting.\",\n  \"size\": \"1024x1024\",\n  \"images\": [\n    {\n      \"image_url\": \"https://gd-hbimg.huaban.com/cb36fdfc6ee4707de3ec666d6bc202fb99d9bef326a10d-oQHn3b_fw658\"\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.tikway.ai/v1/images/edits")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"microsoft/mai-image-2.5-pro\",\n  \"prompt\": \"Keep the apple unchanged and replace only its background with a misty enchanted forest under soft cinematic lighting.\",\n  \"size\": \"1024x1024\",\n  \"images\": [\n    {\n      \"image_url\": \"https://gd-hbimg.huaban.com/cb36fdfc6ee4707de3ec666d6bc202fb99d9bef326a10d-oQHn3b_fw658\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.tikway.ai/v1/images/edits")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": \"microsoft/mai-image-2.5-pro\",\n  \"prompt\": \"Keep the apple unchanged and replace only its background with a misty enchanted forest under soft cinematic lighting.\",\n  \"size\": \"1024x1024\",\n  \"images\": [\n    {\n      \"image_url\": \"https://gd-hbimg.huaban.com/cb36fdfc6ee4707de3ec666d6bc202fb99d9bef326a10d-oQHn3b_fw658\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "created": 1713833628,
  "data": [
    {
      "b64_json": "..."
    }
  ],
  "usage": {
    "total_tokens": 100,
    "input_tokens": 50,
    "output_tokens": 50,
    "input_tokens_details": {
      "text_tokens": 10,
      "image_tokens": 40
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

model

enum<string>

required

Required. Forward model ID for MAI Image 2.5 Pro.

Available options:

microsoft/mai-image-2.5-pro

images

object[]

required

Required. A single JPEG or PNG source image. Forward JSON compatible form uses a file_id/image_url object.

Required array length: 1 element

Hide child attributes

images.file_id

string

The ID of the source image file uploaded to the Files API.

images.image_url

string

Full image URL, or Base64 data URL.

prompt

string

required

Required. Text description of how you wish to edit or expand the image.

Minimum string length: 1

size

enum<string> | null

Compatible output sizes. The MAI native editing interface does not provide independent size parameters, and whether it takes effect depends on the OFOX upstream.

Available options:

auto,

1024x1024,

1536x1024,

1024x1536,

null

response_format

enum<string>

default:b64_json

OFOX compatible response format. MAI native output is fixed to a single PNG Base64; it is recommended to use b64_json.

Available options:

b64_json,

url

Response

200 - application/json

created

integer

required

The Unix timestamp in seconds when the edit result was created.

data

object[]

required

Edited image list.

Hide child attributes

data.b64_json

string

Base64 encoded image content. The GPT Image model is returned by default.

data.revised_prompt

string

The actual revision prompt word of DALL·E 3; this editing interface usually does not return this field.

data.url

string

Generate image URL. DALL·E is provided when using the URL return format and is usually valid for 60 minutes.

background

enum<string>

The actual output context used.

Available options:

transparent,

opaque

output_format

enum<string>

Actual output format.

Available options:

png,

webp,

jpeg

quality

enum<string>

Output quality for actual use.

Available options:

low,

medium,

high,

auto

size

string

The actual generated image size.

usage

object

The token usage of the GPT Image model.

Hide child attributes

usage.input_tokens

integer

Enter the number of tokens for text and images.

usage.input_tokens_details

object

Hide child attributes

usage.input_tokens_details.image_tokens

integer

Enter the number of image tokens.

usage.input_tokens_details.text_tokens

integer

Enter the text token number.

usage.output_tokens

integer

Output the number of tokens.

usage.output_tokens_details

object

Hide child attributes

usage.output_tokens_details.image_tokens

integer

Output the number of image tokens.

usage.output_tokens_details.text_tokens

integer

Output text token number.

usage.total_tokens

integer

The total number of input and output tokens.

Chat completions

Image generation

Video generation

Embeddings

Transcriptions

Picture editing

Authorizations

Body

Response