Skip to main content
POST
/
api
/
message
/
edit_image
Edit Image
curl --request POST \
  --url https://api.trieve.ai/api/message/edit_image \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '
{
  "input_images": [
    {
      "file_name": "<string>",
      "image_src": {
        "base64": "<string>"
      }
    }
  ],
  "prompt": "<string>",
  "mime_type": "<string>",
  "n": 1
}
'
import requests

url = "https://api.trieve.ai/api/message/edit_image"

payload = {
"input_images": [
{
"file_name": "<string>",
"image_src": { "base64": "<string>" }
}
],
"prompt": "<string>",
"mime_type": "<string>",
"n": 1
}
headers = {
"TR-Dataset": "<tr-dataset>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {
'TR-Dataset': '<tr-dataset>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
input_images: [{file_name: '<string>', image_src: {base64: '<string>'}}],
prompt: '<string>',
mime_type: '<string>',
n: 1
})
};

fetch('https://api.trieve.ai/api/message/edit_image', 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.trieve.ai/api/message/edit_image",
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([
'input_images' => [
[
'file_name' => '<string>',
'image_src' => [
'base64' => '<string>'
]
]
],
'prompt' => '<string>',
'mime_type' => '<string>',
'n' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"TR-Dataset: <tr-dataset>"
],
]);

$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.trieve.ai/api/message/edit_image"

payload := strings.NewReader("{\n \"input_images\": [\n {\n \"file_name\": \"<string>\",\n \"image_src\": {\n \"base64\": \"<string>\"\n }\n }\n ],\n \"prompt\": \"<string>\",\n \"mime_type\": \"<string>\",\n \"n\": 1\n}")

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

req.Header.Add("TR-Dataset", "<tr-dataset>")
req.Header.Add("Authorization", "<api-key>")
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.trieve.ai/api/message/edit_image")
.header("TR-Dataset", "<tr-dataset>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"input_images\": [\n {\n \"file_name\": \"<string>\",\n \"image_src\": {\n \"base64\": \"<string>\"\n }\n }\n ],\n \"prompt\": \"<string>\",\n \"mime_type\": \"<string>\",\n \"n\": 1\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.trieve.ai/api/message/edit_image")

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

request = Net::HTTP::Post.new(url)
request["TR-Dataset"] = '<tr-dataset>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"input_images\": [\n {\n \"file_name\": \"<string>\",\n \"image_src\": {\n \"base64\": \"<string>\"\n }\n }\n ],\n \"prompt\": \"<string>\",\n \"mime_type\": \"<string>\",\n \"n\": 1\n}"

response = http.request(request)
puts response.read_body
{
  "image_urls": [
    "<string>"
  ]
}
{
"message": "Bad Request"
}

Authorizations

Authorization
string
header
required

Headers

TR-Dataset
string<uuid>
required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Body

application/json

JSON request payload to edit an image

input_images
object[]
required

The images to edit

prompt
string
required

The prompt describing the desired edit

mime_type
string | null

The mime type of the uploaded image(s)

n
integer<int32> | null

The number of images to generate (default: 1)

Required range: x >= 0
quality
enum<string> | null
Available options:
low,
medium,
high
size
enum<string> | null
Available options:
1024x1024,
1024x1536,
1536x1024

Response

A list of base64 encoded images

image_urls
string[]
required

The URL of the generated image