Get document visual components
curl --request GET \
--url https://api.example.com/api/v0/documents/{document_id}/visual-componentsimport requests
url = "https://api.example.com/api/v0/documents/{document_id}/visual-components"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v0/documents/{document_id}/visual-components', 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.example.com/api/v0/documents/{document_id}/visual-components",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v0/documents/{document_id}/visual-components"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v0/documents/{document_id}/visual-components")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v0/documents/{document_id}/visual-components")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"id": 123,
"type": "string",
"document_id": 123,
"page_number": 123,
"label": "string",
"bbox": {
"x0": 123.45,
"y0": 123.45,
"x1": 123.45,
"y1": 123.45
},
"description": "string",
"created_at": "string",
"updated_at": "string"
}
]
Documents
Get document visual components
Retrieves all visual components associated with a document.
GET
/
api
/
v0
/
documents
/
{document_id}
/
visual-components
Get document visual components
curl --request GET \
--url https://api.example.com/api/v0/documents/{document_id}/visual-componentsimport requests
url = "https://api.example.com/api/v0/documents/{document_id}/visual-components"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v0/documents/{document_id}/visual-components', 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.example.com/api/v0/documents/{document_id}/visual-components",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v0/documents/{document_id}/visual-components"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v0/documents/{document_id}/visual-components")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v0/documents/{document_id}/visual-components")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"id": 123,
"type": "string",
"document_id": 123,
"page_number": 123,
"label": "string",
"bbox": {
"x0": 123.45,
"y0": 123.45,
"x1": 123.45,
"y1": 123.45
},
"description": "string",
"created_at": "string",
"updated_at": "string"
}
]
Get document visual components
Retrieves all visual components associated with a document.Path Parameters
integer
required
No description provided
Response
The response data for this endpoint.
[
{
"id": 123,
"type": "string",
"document_id": 123,
"page_number": 123,
"label": "string",
"bbox": {
"x0": 123.45,
"y0": 123.45,
"x1": 123.45,
"y1": 123.45
},
"description": "string",
"created_at": "string",
"updated_at": "string"
}
]
⌘I