API reference
Get a vector by ID
Retrieve a single vector and its attributes by its user-provided ID.
GET
/
api
/
v1
/
vector
/
vectors
/
{id}
Get a vector by ID
curl --request GET \
--url http://localhost:8080/api/v1/vector/vectors/{id}import requests
url = "http://localhost:8080/api/v1/vector/vectors/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8080/api/v1/vector/vectors/{id}', 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 => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/vector/vectors/{id}",
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 := "http://localhost:8080/api/v1/vector/vectors/{id}"
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("http://localhost:8080/api/v1/vector/vectors/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/vector/vectors/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"status": "success",
"vector": {
"id": "doc-1",
"attributes": {
"vector": [
1,
2,
3
],
"category": "electronics"
}
}
}{
"status": "error",
"message": "<string>"
}{
"status": "error",
"message": "Document 'doc-1' not found"
}{
"status": "error",
"message": "<string>"
}Path Parameters
The user-provided vector ID.
Maximum string length:
64⌘I
Get a vector by ID
curl --request GET \
--url http://localhost:8080/api/v1/vector/vectors/{id}import requests
url = "http://localhost:8080/api/v1/vector/vectors/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8080/api/v1/vector/vectors/{id}', 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 => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/vector/vectors/{id}",
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 := "http://localhost:8080/api/v1/vector/vectors/{id}"
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("http://localhost:8080/api/v1/vector/vectors/{id}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/vector/vectors/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"status": "success",
"vector": {
"id": "doc-1",
"attributes": {
"vector": [
1,
2,
3
],
"category": "electronics"
}
}
}{
"status": "error",
"message": "<string>"
}{
"status": "error",
"message": "Document 'doc-1' not found"
}{
"status": "error",
"message": "<string>"
}