Create Images Batch
curl --request POST \
--url https://api.aisa.one/apis/v1/htmlcss-to-image/create-images-batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"variations": [
{
"css": "<string>",
"url": "https://example.com",
"html": "<main>Hello</main>",
"headers": {},
"ms_delay": 5000,
"selector": "#receipt",
"timezone": "America/New_York",
"full_screen": true,
"max_wait_ms": 5250,
"pdf_options": {
"scale": 1.05,
"margins": [
"<string>",
"<string>",
"<string>",
"<string>"
],
"page_width": "8.5in",
"page_height": "11in",
"print_background": true
},
"device_scale": 1.55,
"google_fonts": [
"Inter",
"Roboto"
],
"viewport_touch": true,
"viewport_width": 3000,
"disable_twemoji": true,
"viewport_height": 2,
"viewport_mobile": true,
"identify_as_hcti": true,
"render_when_ready": true,
"viewport_landscape": true,
"block_consent_banners": true,
"transparent_background": true,
"additional_header_origins": [
"https://assets.example.com"
],
"include_headers_on_subrequests": true
}
]
}
'import requests
url = "https://api.aisa.one/apis/v1/htmlcss-to-image/create-images-batch"
payload = { "variations": [
{
"css": "<string>",
"url": "https://example.com",
"html": "<main>Hello</main>",
"headers": {},
"ms_delay": 5000,
"selector": "#receipt",
"timezone": "America/New_York",
"full_screen": True,
"max_wait_ms": 5250,
"pdf_options": {
"scale": 1.05,
"margins": ["<string>", "<string>", "<string>", "<string>"],
"page_width": "8.5in",
"page_height": "11in",
"print_background": True
},
"device_scale": 1.55,
"google_fonts": ["Inter", "Roboto"],
"viewport_touch": True,
"viewport_width": 3000,
"disable_twemoji": True,
"viewport_height": 2,
"viewport_mobile": True,
"identify_as_hcti": True,
"render_when_ready": True,
"viewport_landscape": True,
"block_consent_banners": True,
"transparent_background": True,
"additional_header_origins": ["https://assets.example.com"],
"include_headers_on_subrequests": True
}
] }
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({
variations: [
{
css: '<string>',
url: 'https://example.com',
html: '<main>Hello</main>',
headers: {},
ms_delay: 5000,
selector: '#receipt',
timezone: 'America/New_York',
full_screen: true,
max_wait_ms: 5250,
pdf_options: {
scale: 1.05,
margins: ['<string>', '<string>', '<string>', '<string>'],
page_width: '8.5in',
page_height: '11in',
print_background: true
},
device_scale: 1.55,
google_fonts: ['Inter', 'Roboto'],
viewport_touch: true,
viewport_width: 3000,
disable_twemoji: true,
viewport_height: 2,
viewport_mobile: true,
identify_as_hcti: true,
render_when_ready: true,
viewport_landscape: true,
block_consent_banners: true,
transparent_background: true,
additional_header_origins: ['https://assets.example.com'],
include_headers_on_subrequests: true
}
]
})
};
fetch('https://api.aisa.one/apis/v1/htmlcss-to-image/create-images-batch', 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.aisa.one/apis/v1/htmlcss-to-image/create-images-batch",
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([
'variations' => [
[
'css' => '<string>',
'url' => 'https://example.com',
'html' => '<main>Hello</main>',
'headers' => [
],
'ms_delay' => 5000,
'selector' => '#receipt',
'timezone' => 'America/New_York',
'full_screen' => true,
'max_wait_ms' => 5250,
'pdf_options' => [
'scale' => 1.05,
'margins' => [
'<string>',
'<string>',
'<string>',
'<string>'
],
'page_width' => '8.5in',
'page_height' => '11in',
'print_background' => true
],
'device_scale' => 1.55,
'google_fonts' => [
'Inter',
'Roboto'
],
'viewport_touch' => true,
'viewport_width' => 3000,
'disable_twemoji' => true,
'viewport_height' => 2,
'viewport_mobile' => true,
'identify_as_hcti' => true,
'render_when_ready' => true,
'viewport_landscape' => true,
'block_consent_banners' => true,
'transparent_background' => true,
'additional_header_origins' => [
'https://assets.example.com'
],
'include_headers_on_subrequests' => true
]
]
]),
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.aisa.one/apis/v1/htmlcss-to-image/create-images-batch"
payload := strings.NewReader("{\n \"variations\": [\n {\n \"css\": \"<string>\",\n \"url\": \"https://example.com\",\n \"html\": \"<main>Hello</main>\",\n \"headers\": {},\n \"ms_delay\": 5000,\n \"selector\": \"#receipt\",\n \"timezone\": \"America/New_York\",\n \"full_screen\": true,\n \"max_wait_ms\": 5250,\n \"pdf_options\": {\n \"scale\": 1.05,\n \"margins\": [\n \"<string>\",\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ],\n \"page_width\": \"8.5in\",\n \"page_height\": \"11in\",\n \"print_background\": true\n },\n \"device_scale\": 1.55,\n \"google_fonts\": [\n \"Inter\",\n \"Roboto\"\n ],\n \"viewport_touch\": true,\n \"viewport_width\": 3000,\n \"disable_twemoji\": true,\n \"viewport_height\": 2,\n \"viewport_mobile\": true,\n \"identify_as_hcti\": true,\n \"render_when_ready\": true,\n \"viewport_landscape\": true,\n \"block_consent_banners\": true,\n \"transparent_background\": true,\n \"additional_header_origins\": [\n \"https://assets.example.com\"\n ],\n \"include_headers_on_subrequests\": true\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.aisa.one/apis/v1/htmlcss-to-image/create-images-batch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"variations\": [\n {\n \"css\": \"<string>\",\n \"url\": \"https://example.com\",\n \"html\": \"<main>Hello</main>\",\n \"headers\": {},\n \"ms_delay\": 5000,\n \"selector\": \"#receipt\",\n \"timezone\": \"America/New_York\",\n \"full_screen\": true,\n \"max_wait_ms\": 5250,\n \"pdf_options\": {\n \"scale\": 1.05,\n \"margins\": [\n \"<string>\",\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ],\n \"page_width\": \"8.5in\",\n \"page_height\": \"11in\",\n \"print_background\": true\n },\n \"device_scale\": 1.55,\n \"google_fonts\": [\n \"Inter\",\n \"Roboto\"\n ],\n \"viewport_touch\": true,\n \"viewport_width\": 3000,\n \"disable_twemoji\": true,\n \"viewport_height\": 2,\n \"viewport_mobile\": true,\n \"identify_as_hcti\": true,\n \"render_when_ready\": true,\n \"viewport_landscape\": true,\n \"block_consent_banners\": true,\n \"transparent_background\": true,\n \"additional_header_origins\": [\n \"https://assets.example.com\"\n ],\n \"include_headers_on_subrequests\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/htmlcss-to-image/create-images-batch")
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 \"variations\": [\n {\n \"css\": \"<string>\",\n \"url\": \"https://example.com\",\n \"html\": \"<main>Hello</main>\",\n \"headers\": {},\n \"ms_delay\": 5000,\n \"selector\": \"#receipt\",\n \"timezone\": \"America/New_York\",\n \"full_screen\": true,\n \"max_wait_ms\": 5250,\n \"pdf_options\": {\n \"scale\": 1.05,\n \"margins\": [\n \"<string>\",\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ],\n \"page_width\": \"8.5in\",\n \"page_height\": \"11in\",\n \"print_background\": true\n },\n \"device_scale\": 1.55,\n \"google_fonts\": [\n \"Inter\",\n \"Roboto\"\n ],\n \"viewport_touch\": true,\n \"viewport_width\": 3000,\n \"disable_twemoji\": true,\n \"viewport_height\": 2,\n \"viewport_mobile\": true,\n \"identify_as_hcti\": true,\n \"render_when_ready\": true,\n \"viewport_landscape\": true,\n \"block_consent_banners\": true,\n \"transparent_background\": true,\n \"additional_header_origins\": [\n \"https://assets.example.com\"\n ],\n \"include_headers_on_subrequests\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"images": [
{
"id": "<string>",
"url": "<string>"
}
]
}HTML/CSS to Image
Create Images Batch
<!-- aisa-pricing:start -->
A request reference price is not currently available; use a request quote where supported. Declared unit rate: $0.000001 USD per provider_credit. Account-specific pricing and final settlement may differ.
<!-- aisa-pricing:end -->
POST
https://api.aisa.one
/
apis
/
v1
/
htmlcss-to-image
/
create-images-batch
Create Images Batch
curl --request POST \
--url https://api.aisa.one/apis/v1/htmlcss-to-image/create-images-batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"variations": [
{
"css": "<string>",
"url": "https://example.com",
"html": "<main>Hello</main>",
"headers": {},
"ms_delay": 5000,
"selector": "#receipt",
"timezone": "America/New_York",
"full_screen": true,
"max_wait_ms": 5250,
"pdf_options": {
"scale": 1.05,
"margins": [
"<string>",
"<string>",
"<string>",
"<string>"
],
"page_width": "8.5in",
"page_height": "11in",
"print_background": true
},
"device_scale": 1.55,
"google_fonts": [
"Inter",
"Roboto"
],
"viewport_touch": true,
"viewport_width": 3000,
"disable_twemoji": true,
"viewport_height": 2,
"viewport_mobile": true,
"identify_as_hcti": true,
"render_when_ready": true,
"viewport_landscape": true,
"block_consent_banners": true,
"transparent_background": true,
"additional_header_origins": [
"https://assets.example.com"
],
"include_headers_on_subrequests": true
}
]
}
'import requests
url = "https://api.aisa.one/apis/v1/htmlcss-to-image/create-images-batch"
payload = { "variations": [
{
"css": "<string>",
"url": "https://example.com",
"html": "<main>Hello</main>",
"headers": {},
"ms_delay": 5000,
"selector": "#receipt",
"timezone": "America/New_York",
"full_screen": True,
"max_wait_ms": 5250,
"pdf_options": {
"scale": 1.05,
"margins": ["<string>", "<string>", "<string>", "<string>"],
"page_width": "8.5in",
"page_height": "11in",
"print_background": True
},
"device_scale": 1.55,
"google_fonts": ["Inter", "Roboto"],
"viewport_touch": True,
"viewport_width": 3000,
"disable_twemoji": True,
"viewport_height": 2,
"viewport_mobile": True,
"identify_as_hcti": True,
"render_when_ready": True,
"viewport_landscape": True,
"block_consent_banners": True,
"transparent_background": True,
"additional_header_origins": ["https://assets.example.com"],
"include_headers_on_subrequests": True
}
] }
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({
variations: [
{
css: '<string>',
url: 'https://example.com',
html: '<main>Hello</main>',
headers: {},
ms_delay: 5000,
selector: '#receipt',
timezone: 'America/New_York',
full_screen: true,
max_wait_ms: 5250,
pdf_options: {
scale: 1.05,
margins: ['<string>', '<string>', '<string>', '<string>'],
page_width: '8.5in',
page_height: '11in',
print_background: true
},
device_scale: 1.55,
google_fonts: ['Inter', 'Roboto'],
viewport_touch: true,
viewport_width: 3000,
disable_twemoji: true,
viewport_height: 2,
viewport_mobile: true,
identify_as_hcti: true,
render_when_ready: true,
viewport_landscape: true,
block_consent_banners: true,
transparent_background: true,
additional_header_origins: ['https://assets.example.com'],
include_headers_on_subrequests: true
}
]
})
};
fetch('https://api.aisa.one/apis/v1/htmlcss-to-image/create-images-batch', 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.aisa.one/apis/v1/htmlcss-to-image/create-images-batch",
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([
'variations' => [
[
'css' => '<string>',
'url' => 'https://example.com',
'html' => '<main>Hello</main>',
'headers' => [
],
'ms_delay' => 5000,
'selector' => '#receipt',
'timezone' => 'America/New_York',
'full_screen' => true,
'max_wait_ms' => 5250,
'pdf_options' => [
'scale' => 1.05,
'margins' => [
'<string>',
'<string>',
'<string>',
'<string>'
],
'page_width' => '8.5in',
'page_height' => '11in',
'print_background' => true
],
'device_scale' => 1.55,
'google_fonts' => [
'Inter',
'Roboto'
],
'viewport_touch' => true,
'viewport_width' => 3000,
'disable_twemoji' => true,
'viewport_height' => 2,
'viewport_mobile' => true,
'identify_as_hcti' => true,
'render_when_ready' => true,
'viewport_landscape' => true,
'block_consent_banners' => true,
'transparent_background' => true,
'additional_header_origins' => [
'https://assets.example.com'
],
'include_headers_on_subrequests' => true
]
]
]),
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.aisa.one/apis/v1/htmlcss-to-image/create-images-batch"
payload := strings.NewReader("{\n \"variations\": [\n {\n \"css\": \"<string>\",\n \"url\": \"https://example.com\",\n \"html\": \"<main>Hello</main>\",\n \"headers\": {},\n \"ms_delay\": 5000,\n \"selector\": \"#receipt\",\n \"timezone\": \"America/New_York\",\n \"full_screen\": true,\n \"max_wait_ms\": 5250,\n \"pdf_options\": {\n \"scale\": 1.05,\n \"margins\": [\n \"<string>\",\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ],\n \"page_width\": \"8.5in\",\n \"page_height\": \"11in\",\n \"print_background\": true\n },\n \"device_scale\": 1.55,\n \"google_fonts\": [\n \"Inter\",\n \"Roboto\"\n ],\n \"viewport_touch\": true,\n \"viewport_width\": 3000,\n \"disable_twemoji\": true,\n \"viewport_height\": 2,\n \"viewport_mobile\": true,\n \"identify_as_hcti\": true,\n \"render_when_ready\": true,\n \"viewport_landscape\": true,\n \"block_consent_banners\": true,\n \"transparent_background\": true,\n \"additional_header_origins\": [\n \"https://assets.example.com\"\n ],\n \"include_headers_on_subrequests\": true\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.aisa.one/apis/v1/htmlcss-to-image/create-images-batch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"variations\": [\n {\n \"css\": \"<string>\",\n \"url\": \"https://example.com\",\n \"html\": \"<main>Hello</main>\",\n \"headers\": {},\n \"ms_delay\": 5000,\n \"selector\": \"#receipt\",\n \"timezone\": \"America/New_York\",\n \"full_screen\": true,\n \"max_wait_ms\": 5250,\n \"pdf_options\": {\n \"scale\": 1.05,\n \"margins\": [\n \"<string>\",\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ],\n \"page_width\": \"8.5in\",\n \"page_height\": \"11in\",\n \"print_background\": true\n },\n \"device_scale\": 1.55,\n \"google_fonts\": [\n \"Inter\",\n \"Roboto\"\n ],\n \"viewport_touch\": true,\n \"viewport_width\": 3000,\n \"disable_twemoji\": true,\n \"viewport_height\": 2,\n \"viewport_mobile\": true,\n \"identify_as_hcti\": true,\n \"render_when_ready\": true,\n \"viewport_landscape\": true,\n \"block_consent_banners\": true,\n \"transparent_background\": true,\n \"additional_header_origins\": [\n \"https://assets.example.com\"\n ],\n \"include_headers_on_subrequests\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/htmlcss-to-image/create-images-batch")
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 \"variations\": [\n {\n \"css\": \"<string>\",\n \"url\": \"https://example.com\",\n \"html\": \"<main>Hello</main>\",\n \"headers\": {},\n \"ms_delay\": 5000,\n \"selector\": \"#receipt\",\n \"timezone\": \"America/New_York\",\n \"full_screen\": true,\n \"max_wait_ms\": 5250,\n \"pdf_options\": {\n \"scale\": 1.05,\n \"margins\": [\n \"<string>\",\n \"<string>\",\n \"<string>\",\n \"<string>\"\n ],\n \"page_width\": \"8.5in\",\n \"page_height\": \"11in\",\n \"print_background\": true\n },\n \"device_scale\": 1.55,\n \"google_fonts\": [\n \"Inter\",\n \"Roboto\"\n ],\n \"viewport_touch\": true,\n \"viewport_width\": 3000,\n \"disable_twemoji\": true,\n \"viewport_height\": 2,\n \"viewport_mobile\": true,\n \"identify_as_hcti\": true,\n \"render_when_ready\": true,\n \"viewport_landscape\": true,\n \"block_consent_banners\": true,\n \"transparent_background\": true,\n \"additional_header_origins\": [\n \"https://assets.example.com\"\n ],\n \"include_headers_on_subrequests\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"images": [
{
"id": "<string>",
"url": "<string>"
}
]
}Request contract
- Method and path: POST /apis/v1/htmlcss-to-image/create-images-batch
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/htmlcss-to-image/create-images-batch - Runtime facts: ecf7b25fc395f7aff68b9e1c0588b3d9a8bb0e613a7bdfd59ede194deb499492
{
"operationId": "htmlcss-to-image.create-images-batch",
"method": "POST",
"path": "/apis/v1/htmlcss-to-image/create-images-batch",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"variations": {
"items": {
"type": "object",
"properties": {
"css": {
"type": "string",
"description": "CSS applied to HTML input or injected into a captured webpage."
},
"url": {
"type": "string",
"examples": [
"https://example.com"
],
"minLength": 1,
"description": "Absolute, internet-reachable HTTP(S) webpage URL. Set this or html, but not both; use headers for authenticated pages."
},
"html": {
"type": "string",
"examples": [
"<main>Hello</main>"
],
"minLength": 1,
"description": "HTML to render. Set this or url, but not both."
},
"headers": {
"type": "object",
"description": "HTTP headers sent to the captured page, with at most 20 case-insensitive names.",
"maxProperties": 20,
"additionalProperties": {
"type": "string"
}
},
"ms_delay": {
"type": "integer",
"maximum": 10000,
"minimum": 0,
"description": "Extra render delay in milliseconds, from 0 to 10000. Zero omits the explicit delay."
},
"selector": {
"type": "string",
"examples": [
"#receipt"
],
"minLength": 1,
"description": "CSS selector for the element to capture."
},
"timezone": {
"type": "string",
"examples": [
"America/New_York"
],
"minLength": 1,
"description": "IANA timezone exposed to the rendered page."
},
"media_type": {
"enum": [
"screen",
"print"
],
"type": "string",
"description": "CSS media type used while rendering; the provider default is screen."
},
"full_screen": {
"type": "boolean",
"description": "Capture the full scrollable page instead of only the viewport."
},
"max_wait_ms": {
"type": "integer",
"maximum": 10000,
"minimum": 500,
"description": "Maximum wait from 500 to 10000 milliseconds for page loading."
},
"pdf_options": {
"type": "object",
"properties": {
"scale": {
"type": "number",
"maximum": 2,
"minimum": 0.1,
"description": "PDF content scale from 0.1 to 2."
},
"margins": {
"type": "array",
"examples": [
[
"0.5in",
"0.5in",
"0.5in",
"0.5in"
]
],
"maxItems": 4,
"minItems": 4,
"description": "PDF margins as CSS sizes in top, right, bottom, left order.",
"prefixItems": [
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
}
]
},
"page_width": {
"type": "string",
"examples": [
"8.5in"
],
"description": "PDF page width as a CSS size, such as 8.5in or 210mm."
},
"page_height": {
"type": "string",
"examples": [
"11in"
],
"description": "PDF page height as a CSS size, such as 11in or 297mm."
},
"print_background": {
"type": "boolean",
"description": "Whether to include CSS backgrounds in PDF output."
}
},
"description": "PDF page, scale, margin, and background settings.",
"additionalProperties": false
},
"color_scheme": {
"enum": [
"light",
"dark"
],
"type": "string",
"description": "Preferred browser color scheme."
},
"device_scale": {
"type": "number",
"maximum": 3,
"minimum": 0.1,
"description": "Device scale factor from 0.1 to 3; the provider default is 2."
},
"google_fonts": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"Inter",
"Roboto"
]
],
"minItems": 1,
"description": "Google Font family names to load."
},
"viewport_touch": {
"type": "boolean",
"description": "Expose touch input support to the rendered page."
},
"viewport_width": {
"type": "integer",
"maximum": 6000,
"minimum": 1,
"description": "Viewport width in pixels; must be paired with viewport_height."
},
"disable_twemoji": {
"type": "boolean",
"description": "Disable automatic conversion of emoji to Twemoji images."
},
"viewport_height": {
"type": "integer",
"minimum": 1,
"description": "Viewport height in pixels; must be paired with viewport_width."
},
"viewport_mobile": {
"type": "boolean",
"description": "Expose a mobile viewport to the rendered page."
},
"identify_as_hcti": {
"type": "boolean",
"description": "Identify the rendering browser as HTML/CSS to Image."
},
"render_when_ready": {
"type": "boolean",
"description": "Wait until the page signals that rendering is ready."
},
"viewport_landscape": {
"type": "boolean",
"description": "Expose a landscape-oriented viewport to the rendered page."
},
"block_consent_banners": {
"type": "boolean",
"description": "Attempt to block common consent banners."
},
"transparent_background": {
"type": "boolean",
"description": "Render a transparent background where supported."
},
"additional_header_origins": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"https://assets.example.com"
]
],
"maxItems": 20,
"description": "Up to 20 unique exact HTTP(S) origins that may also receive supplied headers."
},
"include_headers_on_subrequests": {
"type": "boolean",
"description": "Also include supplied headers on page subrequests."
}
}
},
"maxItems": 25,
"minItems": 1,
"type": "array",
"description": "One to 25 image requests; each overrides matching default_options fields."
},
"default_options": {
"type": "object",
"properties": {
"css": {
"type": "string",
"description": "CSS applied to HTML input or injected into a captured webpage."
},
"headers": {
"type": "object",
"description": "HTTP headers sent to the captured page, with at most 20 case-insensitive names.",
"maxProperties": 20,
"additionalProperties": {
"type": "string"
}
},
"ms_delay": {
"type": "integer",
"maximum": 10000,
"minimum": 0,
"description": "Extra render delay in milliseconds, from 0 to 10000. Zero omits the explicit delay."
},
"selector": {
"type": "string",
"examples": [
"#receipt"
],
"minLength": 1,
"description": "CSS selector for the element to capture."
},
"timezone": {
"type": "string",
"examples": [
"America/New_York"
],
"minLength": 1,
"description": "IANA timezone exposed to the rendered page."
},
"media_type": {
"enum": [
"screen",
"print"
],
"type": "string",
"description": "CSS media type used while rendering; the provider default is screen."
},
"full_screen": {
"type": "boolean",
"description": "Capture the full scrollable page instead of only the viewport."
},
"max_wait_ms": {
"type": "integer",
"maximum": 10000,
"minimum": 500,
"description": "Maximum wait from 500 to 10000 milliseconds for page loading."
},
"pdf_options": {
"type": "object",
"properties": {
"scale": {
"type": "number",
"maximum": 2,
"minimum": 0.1,
"description": "PDF content scale from 0.1 to 2."
},
"margins": {
"type": "array",
"examples": [
[
"0.5in",
"0.5in",
"0.5in",
"0.5in"
]
],
"maxItems": 4,
"minItems": 4,
"description": "PDF margins as CSS sizes in top, right, bottom, left order.",
"prefixItems": [
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
},
{
"type": "string"
}
]
},
"page_width": {
"type": "string",
"examples": [
"8.5in"
],
"description": "PDF page width as a CSS size, such as 8.5in or 210mm."
},
"page_height": {
"type": "string",
"examples": [
"11in"
],
"description": "PDF page height as a CSS size, such as 11in or 297mm."
},
"print_background": {
"type": "boolean",
"description": "Whether to include CSS backgrounds in PDF output."
}
},
"description": "PDF page, scale, margin, and background settings.",
"additionalProperties": false
},
"color_scheme": {
"enum": [
"light",
"dark"
],
"type": "string",
"description": "Preferred browser color scheme."
},
"device_scale": {
"type": "number",
"maximum": 3,
"minimum": 0.1,
"description": "Device scale factor from 0.1 to 3; the provider default is 2."
},
"google_fonts": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"Inter",
"Roboto"
]
],
"minItems": 1,
"description": "Google Font family names to load."
},
"viewport_touch": {
"type": "boolean",
"description": "Expose touch input support to the rendered page."
},
"viewport_width": {
"type": "integer",
"maximum": 6000,
"minimum": 1,
"description": "Viewport width in pixels; must be paired with viewport_height."
},
"disable_twemoji": {
"type": "boolean",
"description": "Disable automatic conversion of emoji to Twemoji images."
},
"viewport_height": {
"type": "integer",
"minimum": 1,
"description": "Viewport height in pixels; must be paired with viewport_width."
},
"viewport_mobile": {
"type": "boolean",
"description": "Expose a mobile viewport to the rendered page."
},
"identify_as_hcti": {
"type": "boolean",
"description": "Identify the rendering browser as HTML/CSS to Image."
},
"render_when_ready": {
"type": "boolean",
"description": "Wait until the page signals that rendering is ready."
},
"viewport_landscape": {
"type": "boolean",
"description": "Expose a landscape-oriented viewport to the rendered page."
},
"block_consent_banners": {
"type": "boolean",
"description": "Attempt to block common consent banners."
},
"transparent_background": {
"type": "boolean",
"description": "Render a transparent background where supported."
},
"additional_header_origins": {
"type": "array",
"items": {
"type": "string"
},
"examples": [
[
"https://assets.example.com"
]
],
"maxItems": 20,
"description": "Up to 20 unique exact HTTP(S) origins that may also receive supplied headers."
},
"include_headers_on_subrequests": {
"type": "boolean",
"description": "Also include supplied headers on page subrequests."
}
},
"description": "Shared render settings applied before each variation's overrides.",
"additionalProperties": false
}
},
"required": [
"variations"
]
}
}
}
},
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"cost_contract": "response_units",
"customer_multiplier": 1.0,
"customer_pricing": "provider_cost_multiplier",
"estimate_source": "unavailable",
"estimate_unavailable_reason": "reference_request_unavailable",
"evidence_source": "response_body",
"maximum_units": 10000000,
"unit": "provider_credit",
"unit_rate_usd": 1e-06
},
"components": {
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
Cost and request rules
A request reference price is not currently available; use a request quote where supported. Declared unit rate: $0.000001 USD per provider_credit. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.- Declared unit rate (USD): 1e-06
- Billing unit: provider_credit
- Cost contract: response_units
- Published reference multiplier: 1.0
- Declared maximum count/units: 10000000
- Settlement evidence source: response_body
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
Tool result data
Show child attributes
Show child attributes