Rendering

RecipeSet Render

GET https://api.spectrumcustomizer.com/api/assets/generated/recipeset/readable/:readableId/:viewAngleHandle

This endpoint allows you to render all items within a RecipeSet at the predefined view angle.

Path Parameters

Name	Type	Description
viewAngleHandle	string	Handle for the angle of the product to display. (e.g. “north”, “south”, “east”, “west”, “northeast”, etc.)
readableId	string	8 digit alphanumeric RecipeSet readable identifier.

Query Parameters

Name	Type	Description
width	integer	Optional output width in pixels (minimum 1). May be supplied independently of height; if only one dimension is given, the other is calculated from the original aspect ratio. When neither is supplied, the default dimensions apply.
height	integer	Optional output height in pixels (minimum 1). May be supplied independently of width; if only one dimension is given, the other is calculated from the original aspect ratio. When neither is supplied, the default dimensions apply.
state	string	Overrides a named render state, in the form state=<parameter>:<value>. Repeatable; supply it once per override (e.g. ?state=blade:open&state=orientation:vertical). Commas are not permitted. State names are case-insensitive, and the last value for a state wins.

Example (width only, height derived from aspect ratio): GET https://api.spectrumcustomizer.com/api/assets/generated/recipeset/readable/AB12CD34/north?width=1000

Example (state overrides): GET https://api.spectrumcustomizer.com/api/assets/generated/recipeset/readable/AB12CD34/north?state=blade:open&state=orientation:vertical

Additional image transformation query parameters are also supported. See Image Transforms.

200 Direct image download of byte array with appropriate content type. Spectrum will return an image directly when transformations are applied. See: Image Transformations in API section.

HTTP/1.1 200 OK
Cache-Control: no-cache
Pragma: no-cache
Content-Length: 215919
Content-Type: image/png
Expires: -1
Server: Microsoft-IIS/10.0
X-AspNet-Version: 4.0.30319
Request-Context: appId=cid-v1:3563b4f7-e3dc-42cf-9689-3d04e3f8ace6
Access-Control-Expose-Headers: Request-Context
X-Powered-By: ASP.NET
Date: Fri, 22 Jan 2021 21:17:42 GMT

[File Content]

302 Redirect to location of asset within Spectrum CDN with no resizing or transformations applied.

HTTP/1.1 302 Found
Cache-Control: no-cache
Pragma: no-cache
Expires: -1
Location: https://cdn.spectrumcustomizer.com/assets/generated/recipeset/example.png
Server: Microsoft-IIS/10.0
X-AspNet-Version: 4.0.30319
Request-Context: appId=cid-v1:3563b4f7-e3dc-42cf-9689-3d04e3f8ace6
Access-Control-Expose-Headers: Request-Context
X-Powered-By: ASP.NET
Date: Fri, 22 Jan 2021 21:12:33 GMT
Content-Length: 0

400 Invalid query parameter, for example a malformed state override (missing :, empty name/value, or a comma-separated value).

Invalid value for state

404 Could not find valid RecipeSet Readable Id.

RecipeSet was not found

500 Spectrum encountered an error in processing.

// An RFC 7807 ProblemDetails document is returned with a link to the log entry
// in the `detail` field for further investigation.
{
    "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1",
    "title": "An error occurred while processing your request.",
    "status": 500,
    "detail": "Error generating recipeset render - https://api.spectrumcustomizer.com/logentry/detail/{logId}"
}