Skip to content

get_reference_set

Fetch everything about a reference set: its metadata, files and trained finetunes.

A reference set is a curated collection of reference files (images, video, audio; optionally
captioned) describing a character, style or concept, and may carry trained finetunes. Call this to
inspect, analyze, or describe a reference set. It returns the set's name, description, category,
status and color palette, every attached reference file with its download URL, content type,
caption, and multi-view tag, the set's logo and font files as `brand_assets`, and its trained
finetunes as `trained_bindings` (a `voice` binding means the set speaks in a trained voice on that
text-to-speech model).

Use the returned `file_id` / `url` to act on individual files (e.g. analyze_media, or as a
reference input for generation). Pass a `brand_assets` logo as a guidance image only when the
user asks for it. Do not surface raw UUIDs or download URLs in prose.

For forge lifecycle guidance, call get_forge_instructions.

Parameters

ParameterTypeDefaultDescription
reference_set_idrequiredstring (uuid)—ID of the reference set — a `set_id` from `list_reference_sets`, or the id from an @-mentioned reference_set context entry.
workspace_idrequiredstring (uuid)—The user's workspace id.