Upload
Upload Image
Upload an image to HITL.sh hosting (S3-backed) for use in image content type requests
POST
/
v1
/
upload
/
image
Upload Image
curl --request POST \
--url https://api.hitl.sh/v1/upload/image \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.hitl.sh/v1/upload/image"
payload = {}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.hitl.sh/v1/upload/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.hitl.sh/v1/upload/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([
]),
CURLOPT_HTTPHEADER => [
"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.hitl.sh/v1/upload/image"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
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.hitl.sh/v1/upload/image")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hitl.sh/v1/upload/image")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"error": true,
"data": {
"url": "<string>"
}
}Upload Image
Upload an image file to HITL.sh hosting. The returned URL can be used as theimage_url field when creating requests with type: "image".
Request
file
required
Image file to upload. Must be one of the supported formats.
Supported Formats
| Format | MIME Type |
|---|---|
| JPEG | image/jpeg |
| PNG | image/png |
| GIF | image/gif |
| WebP | image/webp |
Limits
- Maximum file size: 10 MB
- Content-Type:
multipart/form-data
Response
boolean
Whether the request failed
object
Show data
Show data
string
The hosted URL for the uploaded image. Use this as
image_url in your request.Success Response
{
"error": false,
"data": {
"url": "https://cdn.hitl.sh/uploads/img/abc123.jpg"
}
}
Examples
import requests
with open("product-photo.jpg", "rb") as f:
response = requests.post(
"https://api.hitl.sh/v1/upload/image",
headers={"Authorization": f"Bearer {api_key}"},
files={"file": ("product-photo.jpg", f, "image/jpeg")}
)
image_url = response.json()["data"]["url"]
# Now create a request with the uploaded image
request_data = {
"processing_type": "time-sensitive",
"type": "image",
"priority": "high",
"request_text": "Does this product photo meet our quality standards?",
"image_url": image_url,
"response_type": "boolean",
"response_config": {},
"default_response": False,
"platform": "api"
}
const FormData = require("form-data");
const fs = require("fs");
const form = new FormData();
form.append("file", fs.createReadStream("product-photo.jpg"));
const uploadResponse = await axios.post(
"https://api.hitl.sh/v1/upload/image",
form,
{
headers: {
Authorization: `Bearer ${apiKey}`,
...form.getHeaders()
}
}
);
const imageUrl = uploadResponse.data.data.url;
// Now create a request with the uploaded image
const requestData = {
processing_type: "time-sensitive",
type: "image",
priority: "high",
request_text: "Does this product photo meet our quality standards?",
image_url: imageUrl,
response_type: "boolean",
response_config: {},
default_response: false,
platform: "api"
};
# Upload the image
curl -X POST https://api.hitl.sh/v1/upload/image \
-H "Authorization: Bearer your_api_key" \
-F "file=@product-photo.jpg"
# Response: { "error": false, "data": { "url": "https://cdn.hitl.sh/uploads/img/abc123.jpg" } }
# Use the returned URL in a request
curl -X POST https://api.hitl.sh/v1/api/loops/{loop_id}/requests \
-H "Authorization: Bearer your_api_key" \
-H "Content-Type: application/json" \
-d '{
"type": "image",
"image_url": "https://cdn.hitl.sh/uploads/img/abc123.jpg",
"request_text": "Does this product photo meet our quality standards?",
"response_type": "boolean",
"response_config": {},
"default_response": false,
"platform": "api"
}'
⌘I
Upload Image
curl --request POST \
--url https://api.hitl.sh/v1/upload/image \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.hitl.sh/v1/upload/image"
payload = {}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.hitl.sh/v1/upload/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.hitl.sh/v1/upload/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([
]),
CURLOPT_HTTPHEADER => [
"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.hitl.sh/v1/upload/image"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("POST", url, payload)
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.hitl.sh/v1/upload/image")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hitl.sh/v1/upload/image")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"error": true,
"data": {
"url": "<string>"
}
}