Fetch the logo a hosted page shows
const url = 'https://api.pixonaut.app/l/example?fit=cover';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.pixonaut.app/l/example?fit=cover'Operation ID: logos.get
The image a tenant’s hosted pages show as its logo, through the link their share link’s page is answered with. The token in the path is signed by the api and expires within two hours; no key is needed. A link to a logo the tenant has since replaced or cleared no longer opens. width serves it no larger than the box it is drawn in.
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”The width in pixels the image is drawn at. The long edge served is derived from the image’s own ratio, never larger than the stored image, and clamped to the sizes the api serves.
The width in pixels the image is drawn at. The long edge served is derived from the image’s own ratio, never larger than the stored image, and clamped to the sizes the api serves.
cover when the image is cropped to fill its box: width is then its short edge.
cover when the image is cropped to fill its box: width is then its short edge.
Responses
Section titled “Responses”The file’s bytes
Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
The uploaded file’s height in pixels, when it is known. The bytes served may be a smaller preview.
The uploaded file’s width in pixels, when it is known. The bytes served may be a smaller preview.
Not modified: the If-None-Match etag still holds
Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
The token does not verify or has expired, or the image is no longer the tenant’s logo (plain text)
Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: invalid_query
object
Examples
invalid_query
{ "error": "invalid_query"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: rate_limited
object
Examples
rate_limited
{ "error": "rate_limited"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
The request failed unexpectedly.
Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Questions? Write to [email protected].