Talos docs

GET /environment

Since 0.6

The sky as it resolved, for an agent that wants to know what it is looking at before it decides whether to change it.

Plain text

Response

Response: EnvironmentView

GET /environment — the sky as it actually resolved.

FieldTypePresentDescription
kindstringalways"procedural", "hdr" or "color".
presetstringsometimesThe preset name, for a procedural sky.
assetstringsometimesThe asset id behind an hdr sky that loaded.
asset_pathstringsometimesThe file that asset resolved to, as the engine opened it.
intensitynumberalwaysScalar on the whole environment.
rotationnumberalwaysYaw applied to the sky, radians.
sun_directionnumber[3]sometimesTravel direction of the sun the sky casts (sun -> scene), when it has one. A color sky has none.
sun_colornumber[3]sometimesLinear RGB of that sun.
sun_intensitynumbersometimesIts scene-referred irradiance. 0 when the sun is below the horizon.
sun_from_skybooleanalwaysWhether the scene's directional light is following that sun.
ambientnumbersometimesThe flat fill added on top of the image-based diffuse, when the scene has no sky field and ambient therefore still means what it meant before this change.
findingsstring[]sometimesWhy this is not what the scene asked for: a missing panorama, an undecodable file. Empty when the sky is exactly what was written.
persistedbooleanalwaysAlways false: this endpoint reports the live sky, and a live sky is never on disk until someone edits the scene file. Present so a client does not have to infer it.

Example

curl "http://127.0.0.1:7700/environment"

Start a server with argus run --serve; the port is --port (7700 by default). The request and response fields are in the query API guide.