Get package-scoped asset by slug

GET

/api/assets/{configId}/_package/{packageName}/slug/{slug}/{rendition}

const url = 'https://example.com/api/assets/example/_package/example/slug/example/example?format=webp&version=latestpublished&download=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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://example.com/api/assets/example/_package/example/slug/example/example?format=webp&version=latestpublished&download=true' \
  --header 'Authorization: Bearer <token>'

Retrieves a package-scoped asset by its URL slug and rendition.

Authorizations

bearerAuth

Parameters

Path Parameters

configId

required

string

packageName

required

string

slug

required

string

rendition

required

string

Query Parameters

format

Output format for the asset (e.g., webp, jpg)

string

Example

webp

version

Version of the asset to retrieve (e.g., ‘latest’, ‘latestpublished’, or specific version number)

string

Example

latestpublished

download

If set, forces download with Content-Disposition header

string

Example

true

Responses

200

Asset binary data

string format: binary

206

Partial content (for range requests)

application/octet-stream

string format: binary

304

Not Modified (ETag match)

404

Asset not found

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}