Skip to content

Assets API

Query assets from your Clarento library.

Get a Single Asset

bash
GET ?assetId=asset_abc123

Response:

json
{
  "_status": 200,
  "asset": {
    "id": "asset_abc123",
    "name": "campaign-banner.png",
    "description": "Summer 2026 campaign hero banner",
    "type": "image",
    "mimeType": "image/png",
    "ext": "PNG",
    "sizeBytes": 524288,
    "cdnUrl": "https://abc.supabase.co/storage/v1/object/public/clarento-assets/campaign-banner.png",
    "thumbnailUrl": "https://abc.supabase.co/storage/v1/object/public/clarento-assets/thumbs/campaign-banner.png",
    "tags": ["campaign", "banner", "summer"],
    "autoTags": ["outdoor", "people", "bright"],
    "autoDescription": "A colorful banner featuring people outdoors",
    "approved": true,
    "status": "active",
    "uploadedAt": "2026-03-15T10:30:00.000Z",
    "uploadedBy": "user123",
    "dominantColors": ["#ff6b35", "#004e89", "#ffffff"],
    "embed": {
      "html": "<img src=\"https://...\" alt=\"campaign-banner.png\" />",
      "markdown": "![campaign-banner.png](https://...)",
      "url": "https://..."
    }
  }
}

Search Assets

bash
GET ?q=campaign+banner

Searches asset names, descriptions, and tags. All terms must match (AND logic).

Filter by Tag

bash
GET ?tag=campaign

Matches both manual tags and AI-generated auto-tags (case-insensitive).

Filter by Type

bash
GET ?type=image

Valid types: image, video, document, font, other

Filter by Approval Status

bash
GET ?approved=true

Get Collection Assets

bash
GET ?collectionId=coll_xyz789

Returns the collection metadata and its assets:

json
{
  "_status": 200,
  "collection": {
    "id": "coll_xyz789",
    "name": "Summer Campaign",
    "description": "All assets for summer 2026"
  },
  "assets": [],
  "total": 15,
  "limit": 50,
  "offset": 0
}

Pagination

bash
GET ?q=logo&limit=10&offset=20
ParameterDefaultMaxDescription
limit50100Number of assets per page
offset0Number of assets to skip

Combining Filters

Filters can be combined:

bash
GET ?tag=campaign&type=image&approved=true&limit=10

Built by Norda