Filter Media by Usage

Filter source IDs into available vs used for a named media use-case

Endpoint

POST https://api.ugc.inc/media/filter

Request Body

source_ids · string[] · required

Source IDs to evaluate.

name · string · required

Use-case name (for example profile_picture).

urls · string[]

Optional parallel array of URLs corresponding to each source ID. When provided, also filters out source IDs whose URLs are already used (catches duplicates where the same image has different source IDs).

Response

data · { available: string[]; used_count: number; available_count: number }

Usage filter result.

TypeScript

const res = await client.media.filter({
  source_ids: ['source_1', 'source_2'],
  name: 'profile_picture',
});