Rendered Image
This request returns the rendered image of the configuration.
Endpoints
- GET /configsessions/{sessionID}/renderers/{rendererID}/image
Url
- sessionID
-
The ID of the configuration session
- rendererID
-
The ID of the renderer in the session
Header
- Authorization
-
(optional) Bearer {token}
- X-API-KEY
-
(optional) {API key}
Query
- key
-
(optional)
- w
-
Width of the image
- h
-
Height of the image
- type
-
(optional) File type
- px
-
(optional) Camera position X
- py
-
(optional) Camera position Y
- pz
-
(optional) Camera position Z
- vx
-
(optional) Camera view vector X
- vy
-
(optional) Camera view vector Y
- vz
-
(optional) Camera view vector Z
- tx
-
(optional) Camera top vector X
- ty
-
(optional) Camera top vector Y
- tz
-
(optional) Camera top vector Z
- rx
-
(optional) Camera right vector X
- ry
-
(optional) Camera right vector Y
- rz
-
(optional) Camera right vector Z
- a
-
(optional) Camera angle of view in degrees
- s
-
(optional) Scale parameter, which is used for rendering dynamic lights that move with the camera
Response
Rendered image
Remark
This request only works with server-side renderer systems.
Remark
Adding the renderingKey that is generated when initializing the session (renderingKey in the session initialize responsse) to the query works as a substitute for the Authorization and API Key headers. That way the URL can be simply used in a browser to show the image in an img tag or trigger a download.
Example request
GET https://api.paramate.trinckle.com/configSessions/b1cf7173-f02d-44cd-b65d-bdd2fd38297b/renderers/4d205183-76f2-4683-b024-5dd9a8aaa671/image?type=png&w=800&h=600&px=892.9030&py=-823.8412&pz=-50.9561&vx=-0.8592&vy=0.5112&vz=-0.0178&tx=-0.0192&ty=0.0026&tz=0.9998&rx=0.5111&ry=0.8594&rz=0.0075&a=49&s=1143.9571
-H Authorization: Bearer eyJhbGciOiJIUzI1Ni ... 3H8gC1k2DIKNEeJpb72yvmdY
-H X-API-KEY: 5b260091e8a03ab9af7716af0d71474a
Output
HTTP/1.1 200 OK
[raw image data]
If you don't want to use headers:
Example request
GET https://api.paramate.trinckle.com/configsessions/305bdb5c-cf8f-4256-9180-fe050d119f03/model?type=png&key=eyJhbGciOiJIUzI1NiI ... mS89ueoeIMm5yige1Es7
Output
HTTP/1.1 200 OK
[raw image data]
