docs.html

---
layout: main
permalink: /docs
title: Documentation
---

<h1 class="display-4">Documentation</h1>

<br>
<h3>GET /v2/image/<i>{image}</i></h3>
<p>Primary endpoint of ImageCDN.</p>

<h4>Examples</h4>
<ul>
  <li><code>https://imagecdn.app/v2/image/https%3A%2F%2Fimages.unsplash.com%2Fphoto-1540665569139-922f374b8657?width=200&height=400</code></li>
</ul>

<h4>Query Parameters</h4>
<table class="table">
  <tr>
    <th>Parameter</th>
    <th>Description</th>
  </tr>
  <tr>
    <th scope="row"><code>image</code></th>
    <td><p>
        A <a href="https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding">URL-Encoded</a> link to the image you wish to cache and apply transformations to.<br />
        Not sure what this means? Take a look at the <a href="/getting-started">Getting Started</a> guide.<br />

        <i>Note: The image <b>must</b> be reachable by the image service (contact us for whitelisting options).</i>
    </p></td>
  </tr>
  <tr>
    <th scope="row"><code>height</code></th>
    <td><p>
        Height of the desired image, in pixels.
    </p></td>
  </tr>
  <tr>
    <th scope="row"><code>width</code></th>
    <td><p>
        Width of the desired image, in pixels.
    </p></td>
  </tr>
  <tr>
    <th scope="row"><code>format</code></th>
    <td><p>
        Override the format output by the service.<br />
        Options are: `webp`, `jpg`, `png`.<br />
        <i>Defaults to the best format supported by the current browser.</i>
    </p></td>
  </tr>
  <tr>
    <th scope="row"><code>fit</code></th>
    <td><p>
        How to fill the space provided by height/width.<br />
        Options are: `cover`, `contain`, `fill`, `inside` or `outside`.<br />
        <i>Defaults to: `cover`</i>.
    </p></td>
  </tr>
</table>