Skip to main content
GET
/
shadingscenes
/
{scene_id}
/
results
Get Shading Results
curl --request GET \
  --url https://api.example.com/shadingscenes/{scene_id}/results

​
GET /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 includeStatus query 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 containing status, results, task metadata, and position-level progress counters.
  • Status values include: completed, running, pending, and failed.
  • When includeStatus=true, the envelope includes granular progress fields: completedPositions, runningPositions, failedPositions, expectedPositions, and remainingPositions.
  • Returns 404 if 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.