Shots
Take
Capture the viewport or the frame buffer as a shot.
POST
/
shots
Take
curl --request POST \
--url http://127.0.0.1:45710/api/v1/shots \
--header 'Content-Type: application/json' \
--data '
{
"setup": "<string>",
"source": "viewport",
"replace": "<string>"
}
'import requests
url = "http://127.0.0.1:45710/api/v1/shots"
payload = {
"setup": "<string>",
"source": "viewport",
"replace": "<string>"
}
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({setup: '<string>', source: 'viewport', replace: '<string>'})
};
fetch('http://127.0.0.1:45710/api/v1/shots', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "45710",
CURLOPT_URL => "http://127.0.0.1:45710/api/v1/shots",
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([
'setup' => '<string>',
'source' => 'viewport',
'replace' => '<string>'
]),
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 := "http://127.0.0.1:45710/api/v1/shots"
payload := strings.NewReader("{\n \"setup\": \"<string>\",\n \"source\": \"viewport\",\n \"replace\": \"<string>\"\n}")
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("http://127.0.0.1:45710/api/v1/shots")
.header("Content-Type", "application/json")
.body("{\n \"setup\": \"<string>\",\n \"source\": \"viewport\",\n \"replace\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:45710/api/v1/shots")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"setup\": \"<string>\",\n \"source\": \"viewport\",\n \"replace\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"source": "viewport",
"name": "<string>",
"width": 123,
"height": 123,
"mime": "<string>",
"author": {
"name": "<string>",
"kind": "person",
"via": "<string>",
"picture": "<string>"
},
"at": "<string>",
"setup": "<string>",
"view": {
"type": "<string>",
"camera": "<string>",
"cameraName": "<string>",
"matrix": [
123
],
"fov": 123,
"focus": 123,
"target": [
123,
123,
123
],
"size": [
123,
123
]
},
"marks": [
{
"kind": "pen",
"color": "<string>",
"points": [
123
]
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Body
application/json
Which
Response
Taken
Was this page helpful?
⌘I
Take
curl --request POST \
--url http://127.0.0.1:45710/api/v1/shots \
--header 'Content-Type: application/json' \
--data '
{
"setup": "<string>",
"source": "viewport",
"replace": "<string>"
}
'import requests
url = "http://127.0.0.1:45710/api/v1/shots"
payload = {
"setup": "<string>",
"source": "viewport",
"replace": "<string>"
}
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({setup: '<string>', source: 'viewport', replace: '<string>'})
};
fetch('http://127.0.0.1:45710/api/v1/shots', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "45710",
CURLOPT_URL => "http://127.0.0.1:45710/api/v1/shots",
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([
'setup' => '<string>',
'source' => 'viewport',
'replace' => '<string>'
]),
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 := "http://127.0.0.1:45710/api/v1/shots"
payload := strings.NewReader("{\n \"setup\": \"<string>\",\n \"source\": \"viewport\",\n \"replace\": \"<string>\"\n}")
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("http://127.0.0.1:45710/api/v1/shots")
.header("Content-Type", "application/json")
.body("{\n \"setup\": \"<string>\",\n \"source\": \"viewport\",\n \"replace\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:45710/api/v1/shots")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"setup\": \"<string>\",\n \"source\": \"viewport\",\n \"replace\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"source": "viewport",
"name": "<string>",
"width": 123,
"height": 123,
"mime": "<string>",
"author": {
"name": "<string>",
"kind": "person",
"via": "<string>",
"picture": "<string>"
},
"at": "<string>",
"setup": "<string>",
"view": {
"type": "<string>",
"camera": "<string>",
"cameraName": "<string>",
"matrix": [
123
],
"fov": 123,
"focus": 123,
"target": [
123,
123,
123
],
"size": [
123,
123
]
},
"marks": [
{
"kind": "pen",
"color": "<string>",
"points": [
123
]
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}