Get Shading Results
curl --request GET \
--url https://api.example.com/shadingscenes/{scene_id}/resultsimport requests
url = "https://api.example.com/shadingscenes/{scene_id}/results"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/shadingscenes/{scene_id}/results', 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/shadingscenes/{scene_id}/results",
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/shadingscenes/{scene_id}/results"
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/shadingscenes/{scene_id}/results")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/shadingscenes/{scene_id}/results")
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_bodyShading Scenes
Get Shading Results
Get consolidated shading simulation results for a scene
GET
/
shadingscenes
/
{scene_id}
/
results
Get Shading Results
curl --request GET \
--url https://api.example.com/shadingscenes/{scene_id}/resultsimport requests
url = "https://api.example.com/shadingscenes/{scene_id}/results"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/shadingscenes/{scene_id}/results', 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/shadingscenes/{scene_id}/results",
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/shadingscenes/{scene_id}/results"
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/shadingscenes/{scene_id}/results")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/shadingscenes/{scene_id}/results")
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_bodyGET /shadingscenes//results
Retrieve the consolidated shading simulation results for a scene. Because shading computation runs asynchronously, the response shape depends on whether the simulation has completed.Notes
- Shading simulation is an async process. Results may not be available immediately after scene creation or refresh.
- The
includeStatusquery parameter controls the response shape:false(default) — completed scenes return the raw results payload directly; non-ready scenes return a legacy pending payload with task progress metadata.true— always returns a status envelope containingstatus,results, task metadata, and position-level progress counters.
- Status values include:
completed,running,pending, andfailed. - When
includeStatus=true, the envelope includes granular progress fields:completedPositions,runningPositions,failedPositions,expectedPositions, andremainingPositions. - Returns
404if the scene does not exist in the current workspace. - Poll this endpoint to track async shading computation progress, or use GET /tasks/ to monitor the underlying task directly.
- Related: POST /shadingscenes//refresh to re-queue computation if results are stale or failed.
