Tricycle Image API Help Page

Introduction

Provide a general description of your APIs here.

ColorwayTileImages

Fixed Colorway Image Retrieval for Carpet Tiles

API	Description
GET designs/{designCode}/tiles/{tileSize}/{variation}?rotation={rotation}&pixels={pixels}&dl={dl}	Retrieves the tile image for the design's representative colorway.
GET designs/{designCode}/colors/{colorCode}/tiles/{tileSize}/{variation}?rotation={rotation}&pixels={pixels}&dl={dl}	Retrieves the tile image for the requested colorway of the design.
GET designs/{designCode}/colors/{colorCode}/tileset/{tileSize}?pixels={pixels}	Retrieves the tile image for the requested colorway of the design.
GET designs/{designCode}/colors/{colorCode}/tileset/{tileSize}/preview?pixelWidth={pixelWidth}&pixelHeight={pixelHeight}	Retrieves the tile image for the requested colorway of the design.

ColorwayRoomImages

Fixed Colorway Room Scene Generation

API	Description
GET designs/{designCode}/room?surfaceRotation={surfaceRotation}&pixels={pixels}&dl={dl}	Generates the default room scene using the default colorway and installation associated with the design code.
GET designs/{designCode}/colors/{colorCode}/room?surfaceRotation={surfaceRotation}&pixels={pixels}&dl={dl}	Generates the default room scene using the default installation in the specified colorway associated with the design code.
GET designs/{designCode}/room/installs/{installId}?surfaceRotation={surfaceRotation}&pixels={pixels}&dl={dl}	Generates the default room scene using the default colorway and specified installation associated with the design code.
GET designs/{designCode}/colors/{colorCode}/room/installs/{installId}?surfaceRotation={surfaceRotation}&pixels={pixels}&dl={dl}	Generates the default room scene using the specified colorway and installation associated with the design code.
GET designs/{designCode}/rooms/{roomId}?surfaceRotation={surfaceRotation}&pixels={pixels}&dl={dl}	Generates the requested room scene using the default colorway and installation associated with the design code.
GET designs/{designCode}/colors/{colorCode}/rooms/{roomId}?surfaceRotation={surfaceRotation}&pixels={pixels}&dl={dl}	Generates the requested room scene using the default installation associated with the design code in the specified color.
GET designs/{designCode}/colors/{colorCode}/rooms/{roomId}/installs/{installId}?surfaceRotation={surfaceRotation}&pixels={pixels}&dl={dl}	Generates the requested room scene using the specified installation associated with the design code in the specified color.

DesignPalette

API	Description
GET designs/{designCode}/palette?rgbs={rgbs}&refColor={refColor}	No documentation available.
GET designs/{designCode}/clutColorway/{clutColorwayId}/palette?size={size}	No documentation available.
GET designs/{designCode}/colors/palettes?size={size}&haldClutId={haldClutId}	No documentation available.

RoomThumbnails

Thumbnail Retrieval for Room Scenes.

API	Description
GET rooms/{roomId}/thumbnail?pixels={pixels}	Retrieves the thumbnail for the room scene.

RecoloredTileImages

API	Description
GET designs/{designCode}/recolor/tiles/{tileSize}/{variation}?yarns={yarns}&muted={muted}&refColor={refColor}&texture={texture}&rotation={rotation}&pixels={pixels}&rgbs={rgbs}&clutColorwayId={clutColorwayId}	Retrieves the repeatable image for the design's representative colorway.

RecoloredInstallationImages

Custom Colorway Image Generation for Top Down Installations

API	Description
GET designs/{designCode}/recolor/install?yarns={yarns}&refColor={refColor}&texture={texture}&physWidth={physWidth}&physHeight={physHeight}&pixels={pixels}&clutColorwayId={clutColorwayId}	Generates the default top down install for the custom colorway.
GET designs/{designCode}/recolor/installs/{installId}?yarns={yarns}&muted={muted}&refColor={refColor}&texture={texture}&physWidth={physWidth}&physHeight={physHeight}&pixels={pixels}&rgbs={rgbs}&clutColorwayId={clutColorwayId}	Generates the top down install using the custom colorway and the specified installation method.

ColorwayPhotography

Colorway Photography Retrieval

API	Description
GET designs/{designCode}/photos/room/thumbnail?installId={installId}&pixels={pixels}	Retrieves the requested room photo thumbnail using the design's representative colorway.
GET designs/{designCode}/photos/room?installId={installId}&pixels={pixels}	Retrieves the requested room photo using the design's representative colorway.
GET designs/{designCode}/colors/{colorCode}/photos/room?installId={installId}&pixels={pixels}	Retrieves the requested room photo using the specified colorway of the design.
GET designs/{designCode}/colors/{colorCode}/photos/room/thumbnail?installId={installId}&pixels={pixels}	Retrieves the requested room photo thumbnail using the specified colorway of the design.

RugRoomImages

API	Description
GET rug/rooms/{roomId}?pal={pal}&designs={designs}&pos={pos}&sections={sections}&scales={scales}&texture={texture}&pixels={pixels}	Generates the requested room scene using the provided rug components.

GridInstallationImages

API	Description
POST grids/install	No documentation available.

GridRoomImages

API	Description
POST grids/room	No documentation available.

GridImages

API	Description
GET grids/images/{fileName}	No documentation available.

ColorwayInstallationImages

Fixed Colorway Image Generation for Top Down Installations

API	Description
GET designs/{designCode}/install?physWidth={physWidth}&physHeight={physHeight}&pixels={pixels}&dl={dl}	Generates the default top down install using the design's representative colorway.
GET designs/{designCode}/installs/{installId}?physWidth={physWidth}&physHeight={physHeight}&pixels={pixels}&dl={dl}	Generates the top down install using the design's representative colorway and the specified installation method.
GET designs/{designCode}/colors/{colorCode}/install?physWidth={physWidth}&physHeight={physHeight}&pixels={pixels}&dl={dl}	Generates the default top down installation for the requested colorway of the design.
GET designs/{designCode}/colors/{colorCode}/installs/{installId}?physWidth={physWidth}&physHeight={physHeight}&pixels={pixels}&dl={dl}	Generates the top down installation for the requested colorway of the design.
GET designs/{designCode}/colors/{colorCode}/installs/{installId}/repeat?pixels={pixels}&dl={dl}	Generates the repeatable top down installation for the requested colorway of the design.

RecoloredSwatchImages

API	Description
GET designs/{designCode}/recolor/swatch?yarns={yarns}&muted={muted}&refColor={refColor}&texture={texture}&physWidth={physWidth}&physHeight={physHeight}&pixels={pixels}&rgbs={rgbs}&clutColorwayId={clutColorwayId}	Generates the requested recolored swatch image for the design.

TrykProductThumbnails

Thumbnail Retrieval for Tryk products.

API	Description
GET tryk/products/{productId}/thumbnail	Retrieves the thumbnail for the Tryk product.

RecoloredRepeatableImages

API	Description
GET designs/{designCode}/recolor/repeat?yarns={yarns}&muted={muted}&refColor={refColor}&texture={texture}&rotation={rotation}&pixels={pixels}&rgbs={rgbs}&clutColorwayId={clutColorwayId}	Retrieves the repeatable image for the design's representative colorway.
GET designs/{designCode}/recolor/repeat/square?yarns={yarns}&muted={muted}&refColor={refColor}&texture={texture}&rotation={rotation}&pixels={pixels}&rgbs={rgbs}&clutColorwayId={clutColorwayId}	Retrieves a square recolored image for the design.

ColorwayAreaRugImages

Fixed Colorway Generation for Area Rug Images

API	Description
GET designs/{designCode}/arearug?sergeType={sergeType}&sergeColor={sergeColor}&shape={shape}&physWidth={physWidth}&physHeight={physHeight}&offsetX={offsetX}&offsetY={offsetY}&rotation={rotation}&pixels={pixels}	Generates the area rug image using the design's representative colorway.
GET designs/{designCode}/colors/{colorCode}/arearug?sergeType={sergeType}&sergeColor={sergeColor}&shape={shape}&physWidth={physWidth}&physHeight={physHeight}&offsetX={offsetX}&offsetY={offsetY}&rotation={rotation}&pixels={pixels}	Generates the area rug image for the requested colorway of the design.
GET designs/{designCode}/colors/{colorCode}/arearug/rooms/{roomId}?sergeType={sergeType}&sergeColor={sergeColor}&shape={shape}&physWidth={physWidth}&physHeight={physHeight}&offsetX={offsetX}&offsetY={offsetY}&rotation={rotation}&pixels={pixels}&dl={dl}&args={args}	Generates a room scene image using an area rug image for the requested colorway of the design.

ColorwaySwatchImages

Fixed Colorway Generation for Swatch Images

API	Description
GET designs/{designCode}/swatch?physWidth={physWidth}&physHeight={physHeight}&pixels={pixels}	Generates the requested swatch image using the design's representative colorway.
GET designs/{designCode}/colors/{colorCode}/swatch?physWidth={physWidth}&physHeight={physHeight}&pixels={pixels}	Generates the requested swatch image for the requested colorway of the design.

RecoloredRoomImages

API	Description
GET designs/{designCode}/recolor/room?yarns={yarns}&muted={muted}&refColor={refColor}&texture={texture}&surfaceRotation={surfaceRotation}&pixels={pixels}&rgbs={rgbs}&clutColorwayId={clutColorwayId}	Generates the default room scene and installation for the custom colorway associated with the design code.
GET designs/{designCode}/recolor/room/installs/{installId}?yarns={yarns}&muted={muted}&refColor={refColor}&texture={texture}&surfaceRotation={surfaceRotation}&pixels={pixels}&rgbs={rgbs}&clutColorwayId={clutColorwayId}	Generates the default room scene using the custom colorway and specified installation associated with the design code.
GET designs/{designCode}/recolor/rooms/{roomId}?yarns={yarns}&muted={muted}&refColor={refColor}&texture={texture}&surfaceRotation={surfaceRotation}&pixels={pixels}&rgbs={rgbs}&clutColorwayId={clutColorwayId}	Generates the requested room scene using the default installation associated with the design code in the specified custom colorway.
GET designs/{designCode}/recolor/rooms/{roomId}/installs/{installId}?yarns={yarns}&muted={muted}&refColor={refColor}&texture={texture}&surfaceRotation={surfaceRotation}&pixels={pixels}&rgbs={rgbs}&clutColorwayId={clutColorwayId}	Generates the requested room scene using the specified installation associated with the design code in the specified color.

TextureThumbnails

Thumbnail Retrieval for Textures.

API	Description
GET textures/{textureId}/thumbnail?pixels={pixels}	Retrieves the thumbnail for a texture.

ColorwayRepeatableImages

Fixed Colorway Repeatable Image Retrieval

API	Description
GET designs/{designCode}/repeat?rotation={rotation}&pixels={pixels}&dl={dl}	Retrieves the repeatable image for the design's representative colorway.
GET designs/{designCode}/repeat/square?rotation={rotation}&pixels={pixels}&dl={dl}	Retrieves the repeatable image for the design's representative colorway and repeats it out to a square output size.
GET designs/{designCode}/colors/{colorCode}/repeat?rotation={rotation}&pixels={pixels}&dl={dl}	Retrieves the repeatable image for the requested colorway of the design.
GET designs/{designCode}/colors/{colorCode}/repeat/square?rotation={rotation}&pixels={pixels}&dl={dl}	Retrieves the repeatable image for the requested colorway of the design and repeats it out to a square output size.

RugPreviewImages

API	Description
GET rug/preview?pal={pal}&designs={designs}&pos={pos}&sections={sections}&scales={scales}&texture={texture}&pixels={pixels}	Generates the requested preview using the provided rug components.

ColorwayThumbnails

Fixed Colorway Thumbnail Retrieval

API	Description
GET designs/{designCode}/thumbnail?pixels={pixels}	Retrieves the thumbnail for the design's representative colorway.
GET designs/{designCode}/colors/{colorCode}/thumbnail?pixels={pixels}	Retrieves the thumbnail for the requested colorway of the design.

Yarns

Exposes ability to retrieve yarn related images.

API	Description
GET yarns/libraries/{libraryId}/sprite?pomSize={pomSize}&columns={columns}	Retrieves the yarn library poms suitable for use as a CSS sprite.
GET yarns/thumbnail?code={code}&designCode={designCode}&pixels={pixels}	Retrieves the thumbnail image for the yarn.

RecoloredClutImages

API	Description
GET designs/{designCode}/recolor/clut?refColor={refColor}&rgbs={rgbs}	No documentation available.