charcoal

The charcoal transformation creates a charcoal drawing effect, converting images into sketches that appear to be drawn with charcoal or pencil. Perfect for artistic effects, creating hand-drawn appearances, or stylizing photographs into illustrations.

Serving Content via CDN

The Media API is a CDN-based service that serves transformed images via GET requests. When you request a transformed image URL, the transformation is applied dynamically on the first request and then cached for subsequent requests.

URL Pattern

https://media.vyso.io/charcoal:radius=AMOUNT/ASSET_ID.jpg

Examples

Light Charcoal Effect

curl -i GET https://media.vyso.io/charcoal:radius=1/ASSET_ID.jpg

Standard Charcoal Effect

curl -i GET https://media.vyso.io/charcoal/ASSET_ID.jpg

Medium Charcoal Sketch

curl -i GET https://media.vyso.io/charcoal:radius=3/ASSET_ID.jpg

Strong Charcoal Effect

curl -i GET https://media.vyso.io/charcoal:radius=5/ASSET_ID.jpg

Extreme Charcoal Sketch

curl -i GET https://media.vyso.io/charcoal:radius=8/ASSET_ID.jpg

On the first request, you'll receive a X-Cache: MISS header while the transformation is applied and cached. Subsequent requests will return X-Cache: HIT.

Parameters

radiusOPTIONAL

Radius of the charcoal effect kernel. Accepted values:

  • Range: 0.5 to 10.0
  • 2.0 - Standard charcoal (default)
  • 1.0 - Fine, detailed charcoal lines
  • 3.0-5.0 - Heavier charcoal strokes
  • Higher values create broader, more artistic strokes

Response

The API returns a charcoal-drawn version of the image with sketch-like appearance. The response format depends on the format of the asset stored in the Vyso asset cloud.

Content-Type: Determined by the stored asset format (e.g., image/jpeg, image/png)

← Back to Transformations