Create an image build
curl --request POST \
--url https://api.hyperbrowser.ai/api/images/builds \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"imageName": "<string>",
"inputSha256": "<string>",
"inputSizeBytes": 2,
"inputFormat": "rootfs_export_tar_gz",
"sourcePlatform": "linux/amd64",
"imageConfigUser": "<string>",
"imageInit": {
"env": {},
"command": "<string>",
"args": [
"<string>"
]
}
}
'import requests
url = "https://api.hyperbrowser.ai/api/images/builds"
payload = {
"imageName": "<string>",
"inputSha256": "<string>",
"inputSizeBytes": 2,
"inputFormat": "rootfs_export_tar_gz",
"sourcePlatform": "linux/amd64",
"imageConfigUser": "<string>",
"imageInit": {
"env": {},
"command": "<string>",
"args": ["<string>"]
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
imageName: '<string>',
inputSha256: '<string>',
inputSizeBytes: 2,
inputFormat: 'rootfs_export_tar_gz',
sourcePlatform: 'linux/amd64',
imageConfigUser: '<string>',
imageInit: {env: {}, command: '<string>', args: ['<string>']}
})
};
fetch('https://api.hyperbrowser.ai/api/images/builds', 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.hyperbrowser.ai/api/images/builds",
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([
'imageName' => '<string>',
'inputSha256' => '<string>',
'inputSizeBytes' => 2,
'inputFormat' => 'rootfs_export_tar_gz',
'sourcePlatform' => 'linux/amd64',
'imageConfigUser' => '<string>',
'imageInit' => [
'env' => [
],
'command' => '<string>',
'args' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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://api.hyperbrowser.ai/api/images/builds"
payload := strings.NewReader("{\n \"imageName\": \"<string>\",\n \"inputSha256\": \"<string>\",\n \"inputSizeBytes\": 2,\n \"inputFormat\": \"rootfs_export_tar_gz\",\n \"sourcePlatform\": \"linux/amd64\",\n \"imageConfigUser\": \"<string>\",\n \"imageInit\": {\n \"env\": {},\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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.hyperbrowser.ai/api/images/builds")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"imageName\": \"<string>\",\n \"inputSha256\": \"<string>\",\n \"inputSizeBytes\": 2,\n \"inputFormat\": \"rootfs_export_tar_gz\",\n \"sourcePlatform\": \"linux/amd64\",\n \"imageConfigUser\": \"<string>\",\n \"imageInit\": {\n \"env\": {},\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperbrowser.ai/api/images/builds")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"imageName\": \"<string>\",\n \"inputSha256\": \"<string>\",\n \"inputSizeBytes\": 2,\n \"inputFormat\": \"rootfs_export_tar_gz\",\n \"sourcePlatform\": \"linux/amd64\",\n \"imageConfigUser\": \"<string>\",\n \"imageInit\": {\n \"env\": {},\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"build": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"imageName": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"imageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inputSha256": "<string>",
"inputSizeBytes": 123,
"errorCode": "<string>",
"errorMessage": "<string>"
},
"upload": {
"url": "<string>",
"method": "PUT",
"headers": {},
"objectKey": "<string>",
"expiresInSeconds": 123,
"maxUploadBytes": 123
}
}Sandbox Images
Create an image build
POST
/
api
/
images
/
builds
Create an image build
curl --request POST \
--url https://api.hyperbrowser.ai/api/images/builds \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"imageName": "<string>",
"inputSha256": "<string>",
"inputSizeBytes": 2,
"inputFormat": "rootfs_export_tar_gz",
"sourcePlatform": "linux/amd64",
"imageConfigUser": "<string>",
"imageInit": {
"env": {},
"command": "<string>",
"args": [
"<string>"
]
}
}
'import requests
url = "https://api.hyperbrowser.ai/api/images/builds"
payload = {
"imageName": "<string>",
"inputSha256": "<string>",
"inputSizeBytes": 2,
"inputFormat": "rootfs_export_tar_gz",
"sourcePlatform": "linux/amd64",
"imageConfigUser": "<string>",
"imageInit": {
"env": {},
"command": "<string>",
"args": ["<string>"]
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
imageName: '<string>',
inputSha256: '<string>',
inputSizeBytes: 2,
inputFormat: 'rootfs_export_tar_gz',
sourcePlatform: 'linux/amd64',
imageConfigUser: '<string>',
imageInit: {env: {}, command: '<string>', args: ['<string>']}
})
};
fetch('https://api.hyperbrowser.ai/api/images/builds', 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.hyperbrowser.ai/api/images/builds",
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([
'imageName' => '<string>',
'inputSha256' => '<string>',
'inputSizeBytes' => 2,
'inputFormat' => 'rootfs_export_tar_gz',
'sourcePlatform' => 'linux/amd64',
'imageConfigUser' => '<string>',
'imageInit' => [
'env' => [
],
'command' => '<string>',
'args' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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://api.hyperbrowser.ai/api/images/builds"
payload := strings.NewReader("{\n \"imageName\": \"<string>\",\n \"inputSha256\": \"<string>\",\n \"inputSizeBytes\": 2,\n \"inputFormat\": \"rootfs_export_tar_gz\",\n \"sourcePlatform\": \"linux/amd64\",\n \"imageConfigUser\": \"<string>\",\n \"imageInit\": {\n \"env\": {},\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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.hyperbrowser.ai/api/images/builds")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"imageName\": \"<string>\",\n \"inputSha256\": \"<string>\",\n \"inputSizeBytes\": 2,\n \"inputFormat\": \"rootfs_export_tar_gz\",\n \"sourcePlatform\": \"linux/amd64\",\n \"imageConfigUser\": \"<string>\",\n \"imageInit\": {\n \"env\": {},\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperbrowser.ai/api/images/builds")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"imageName\": \"<string>\",\n \"inputSha256\": \"<string>\",\n \"inputSizeBytes\": 2,\n \"inputFormat\": \"rootfs_export_tar_gz\",\n \"sourcePlatform\": \"linux/amd64\",\n \"imageConfigUser\": \"<string>\",\n \"imageInit\": {\n \"env\": {},\n \"command\": \"<string>\",\n \"args\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"build": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"imageName": "<string>",
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"imageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inputSha256": "<string>",
"inputSizeBytes": 123,
"errorCode": "<string>",
"errorMessage": "<string>"
},
"upload": {
"url": "<string>",
"method": "PUT",
"headers": {},
"objectKey": "<string>",
"expiresInSeconds": 123,
"maxUploadBytes": 123
}
}Authorizations
Body
application/json
Name for the resulting image. Letters, numbers, dashes, and underscores only.
Maximum string length:
64Pattern:
^[A-Za-z0-9_-]+$SHA-256 of the image archive to upload.
Required string length:
64Pattern:
^[A-Fa-f0-9]{64}$Required range:
x >= 1Archive format of the input.
Available options:
rootfs_export_tar_gz Platform of the source image.
Available options:
linux/amd64 Default user from the image config.
Startup defaults to attach to the image.
Show child attributes
Show child attributes
Was this page helpful?
⌘I