Get one image asset

Search Documentation

Search across all developer documentation

assets

Get one image asset

GET /v1/assets/{id}
Auth required api.assets.view

Returns one image asset by its logical source path (percent-encoded) or its id, or 404 not_found when the handle names no asset in this org.

Path parameters

id string required

The asset's UUID or its logical source path — the same path POST /v1/assets is keyed on and {{asset "..."}} names. A path contains slashes, so percent-encode it as one path segment (/v1/assets/images%2Flogo.png). Unknown handles read as 404 not_found.

Responses

Errors follow the RFC 7807 problem format — see the error reference.

200 The image asset application/json
id string<uuid> required
source_path string required

The logical path templates reference, e.g. static/logo.png. It is the path that was supplied on upload.

url string required

Public CDN URL for the image, or "" when no Edge stack is provisioned yet.

content_hash string required

Content-addressed hash of the image bytes.

content_type string required

MIME type, e.g. image/png.

size_bytes integer<int64> required
width integer required

Pixel width, or 0 when unknown (e.g. SVG).

height integer required

Pixel height, or 0 when unknown (e.g. SVG).

created_at string<date-time> required
referenced_by array<object> required

The templates whose body references this asset's path. Always present: an empty array means the scan ran and found none, which is what a caller about to delete the asset needs to know.

Each entry in referenced_by:

id string<uuid> required
name string required
tags array<object> optional

Org-side tags/folders applied to this asset (managed via the dashboard). Filter the collection with ?tag=.

Each entry in tags:

id string<uuid> required
name string required

Full folder path (e.g. Marketing/Newsletters).

key string required

Normalized slug handle of the name.

color string optional

Chip colour token (chart-1..chart-5), or empty.

description string optional
created_at string<date-time> required
updated_at string<date-time> required
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
404 Resource not found application/problem+json
429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json