The app's own thumbnail image

GET

/api/workspaces/{workspaceId}/apps/{id}/thumbnail

const url = 'http://localhost:8080/api/workspaces/example/apps/example/thumbnail';
const options = {method: 'GET', headers: {cookie: 'auth_session=<auth_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/workspaces/example/apps/example/thumbnail \
  --cookie auth_session=<auth_session>

The image the app ships at its root (thumbnail.png, or .webp/.jpg/.jpeg/.svg) as of main; /apps/discovery says which apps have one (and its oid, the cache version). With w, a raster thumbnail comes back as a WebP at most that wide (snapped to 320/480/640/960/1200, never upscaled); SVG is always the original. Private caching: immutable for a year when v names the current blob, revalidate (ETag by oid and width) otherwise. 404 when the app ships none. SVG is served with a script-free, sandboxed CSP.

Authorizations

cookieAuth
bearerAuth

Parameters

Path Parameters

workspaceId

required

string

required

string

Query Parameters

The thumbnail’s blob oid (cache version).

string

The thumbnail’s blob oid (cache version).

Desired width in px; snapped to the nearest of 320, 480, 640, 960, 1200. Omit for the original.

string

Desired width in px; snapped to the nearest of 320, 480, 640, 960, 1200. Omit for the original.

Responses

2XX

Successful response

application/json

object

success

Whether the request succeeded.

boolean

data

Endpoint-specific response payload.

message

string

error

string

Example

{
  "message": "Operation completed",
  "error": "Error message"
}

4XX

Invalid request

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}

5XX

Internal server error

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}