List scenes in scope
curl --request GET \
--url http://localhost:8080/v1/scenes \
--header 'x-hyphae-key: <api-key>'import requests
url = "http://localhost:8080/v1/scenes"
headers = {"x-hyphae-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-hyphae-key': '<api-key>'}};
fetch('http://localhost:8080/v1/scenes', 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/v1/scenes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-hyphae-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"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/v1/scenes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-hyphae-key", "<api-key>")
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/v1/scenes")
.header("x-hyphae-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/v1/scenes")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-hyphae-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"scenes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"project_id": "<string>",
"centroid": [
123
],
"summary": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"next_cursor": "<string>"
}{
"error": {
"code": "not_found",
"message": "<string>"
}
}{
"error": {
"code": "not_found",
"message": "<string>"
}
}{
"error": {
"code": "not_found",
"message": "<string>"
}
}{
"error": {
"code": "not_found",
"message": "<string>"
}
}{
"error": {
"code": "not_found",
"message": "<string>"
}
}Scenes
List scenes in scope
List the scenes in the caller’s read scope with opaque cursor pagination (FR-13). Returns a SceneList envelope: omit cursor for the first page, then pass the prior page’s next_cursor back as cursor to fetch the next page. A null next_cursor marks the last page.
GET
/
v1
/
scenes
List scenes in scope
curl --request GET \
--url http://localhost:8080/v1/scenes \
--header 'x-hyphae-key: <api-key>'import requests
url = "http://localhost:8080/v1/scenes"
headers = {"x-hyphae-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-hyphae-key': '<api-key>'}};
fetch('http://localhost:8080/v1/scenes', 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/v1/scenes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-hyphae-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"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/v1/scenes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-hyphae-key", "<api-key>")
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/v1/scenes")
.header("x-hyphae-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/v1/scenes")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["x-hyphae-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"scenes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"project_id": "<string>",
"centroid": [
123
],
"summary": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"next_cursor": "<string>"
}{
"error": {
"code": "not_found",
"message": "<string>"
}
}{
"error": {
"code": "not_found",
"message": "<string>"
}
}{
"error": {
"code": "not_found",
"message": "<string>"
}
}{
"error": {
"code": "not_found",
"message": "<string>"
}
}{
"error": {
"code": "not_found",
"message": "<string>"
}
}Authorizations
The API key issued for the calling agent. Required on every endpoint except GET /healthz.
Query Parameters
Opaque cursor from a prior page's next_cursor
Page size; clamped to the server max; omitted = default
Required range:
x >= 1