Tools
Image Web Search
Finds the best web image match from a semantic query
POST
/
v2
/
image-utils
/
image-web-search
cURL
curl --request POST \
--url https://api.tokenkit.co/v2/image-utils/image-web-search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'instructions=<string>' \
--form aspect_ratio=any \
--form effort=lowimport requests
url = "https://api.tokenkit.co/v2/image-utils/image-web-search"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instructions\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"aspect_ratio\"\r\n\r\nany\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"effort\"\r\n\r\nlow\r\n-----011000010111000001101001--"
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('instructions', '<string>');
form.append('aspect_ratio', 'any');
form.append('effort', 'low');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.tokenkit.co/v2/image-utils/image-web-search', 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.tokenkit.co/v2/image-utils/image-web-search",
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=\"instructions\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"aspect_ratio\"\r\n\r\nany\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"effort\"\r\n\r\nlow\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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.tokenkit.co/v2/image-utils/image-web-search"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instructions\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"aspect_ratio\"\r\n\r\nany\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"effort\"\r\n\r\nlow\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.tokenkit.co/v2/image-utils/image-web-search")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instructions\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"aspect_ratio\"\r\n\r\nany\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"effort\"\r\n\r\nlow\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tokenkit.co/v2/image-utils/image-web-search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instructions\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"aspect_ratio\"\r\n\r\nany\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"effort\"\r\n\r\nlow\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"job_id": "job_123",
"links": {
"self": "/v1/jobs/job_123",
"stream": "/v1/jobs/job_123/stream"
}
},
"errors": null
}Request body
application/json (or form body, depending on your client setup)
instructions(string, required): Between3and10,000charactersaspect_ratio("any" | validAspectRatios, optional): Defaults to"any"effort("high" | "low", optional): Defaults to"low"
Validation rules
instructionsminimum length:3instructionsmaximum length:10,000
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
multipart/form-data
⌘I
cURL
curl --request POST \
--url https://api.tokenkit.co/v2/image-utils/image-web-search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'instructions=<string>' \
--form aspect_ratio=any \
--form effort=lowimport requests
url = "https://api.tokenkit.co/v2/image-utils/image-web-search"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instructions\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"aspect_ratio\"\r\n\r\nany\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"effort\"\r\n\r\nlow\r\n-----011000010111000001101001--"
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('instructions', '<string>');
form.append('aspect_ratio', 'any');
form.append('effort', 'low');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.tokenkit.co/v2/image-utils/image-web-search', 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.tokenkit.co/v2/image-utils/image-web-search",
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=\"instructions\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"aspect_ratio\"\r\n\r\nany\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"effort\"\r\n\r\nlow\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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.tokenkit.co/v2/image-utils/image-web-search"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instructions\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"aspect_ratio\"\r\n\r\nany\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"effort\"\r\n\r\nlow\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.tokenkit.co/v2/image-utils/image-web-search")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instructions\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"aspect_ratio\"\r\n\r\nany\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"effort\"\r\n\r\nlow\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tokenkit.co/v2/image-utils/image-web-search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"instructions\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"aspect_ratio\"\r\n\r\nany\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"effort\"\r\n\r\nlow\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"job_id": "job_123",
"links": {
"self": "/v1/jobs/job_123",
"stream": "/v1/jobs/job_123/stream"
}
},
"errors": null
}