LumenClip DocsData
Workspace, collections, and assets
Workspace runtime data and reusable media, image, word, product, and asset structures.
Workspace, collections, and assets
These objects represent reusable inputs and workspace-level media available to generation paths.
Workspace, collections, and assets. Optionality and accepted values are included in each field description.
RealFarmData
| Field | Type | Example | Description |
|---|---|---|---|
brand.name | string literal | "LumenClip" | Required. Product/brand name. Accepted format: LumenClip. |
brand.owner | string | "Example" | Optional. Optional owner label. |
assets.music | LocalAsset[] | [] | Required. Music catalog. Accepted format: Array. |
assets.ugcAvatarVideos | LocalAsset[] | [] | Required. UGC avatar video catalog. Accepted format: Array. |
assets.demoVideos | LocalAsset[] | [] | Required. Demo video catalog. Accepted format: Array. |
assets.greenscreenMemes | LocalAsset[] | [] | Required. Greenscreen catalog. Accepted format: Array. |
assets.ctas | LocalAsset[] | [] | Required. CTA text/media catalog. Accepted format: Array. |
LocalAsset
| Field | Type | Example | Description |
|---|---|---|---|
id | string | "record-123" | Required. Asset ID. Accepted format: Stable identifier. |
name | string | "Example" | Required. Display name. |
path | string | "assets/example.png" | Required. Storage compatibility path. Accepted format: Data-relative path. |
url | string | "/api/local-assets/**" | Required. Stream URL. Accepted format: /api/local-assets/** URL. |
kind | string enum | "audio" | Required. Bundled local asset kind. Accepted format: audio, video, text. |
text | string | "Example" | Optional. Text asset contents. |
MediaLibraryAsset
| Field | Type | Example | Description |
|---|---|---|---|
id | string | "record-123" | Required. Asset ID. Accepted format: Deterministic path-derived ID. |
name | string | "Example" | Required. Display name. |
path | string | "assets/example.png" | Required. Storage path. Accepted format: Data-relative path. |
url | string | "/api/local-assets/**" | Required. Stream URL. Accepted format: /api/local-assets/** URL. |
kind | string enum | "audio" | Required. Media kind. Accepted format: audio, video, text. |
collection | string enum | "music" | Required. Catalog partition. Accepted format: music, ugc_avatar_videos, demo_videos, greenscreen_memes, ctas. |
text | string | "Example" | Optional. Text asset contents. |
StoredImageCollection
| Field | Type | Example | Description |
|---|---|---|---|
ownerId | string | "record-123" | Optional. Owner. Accepted format: Railway user ID. |
name | string | "Example" | Required. Effective upsert identity. Accepted format: Non-empty string. |
created_at | ISO datetime | "2026-08-01T09:00:00.000Z" | Required. Creation time; paired with name for deletion. Accepted format: ISO 8601. |
pinned | boolean | true | Optional. Pin state. Accepted format: true, false. |
mediaType | string enum | "image" | Optional. Collection media family. Accepted format: image, video. |
deletedAt | ISO datetime | "Example" | Optional. Soft-deletion time. Accepted format: ISO 8601. |
deletedUntil | ISO datetime | "Example" | Optional. Recovery/purge deadline. Accepted format: ISO 8601. |
images | media item[] | [] | Required. Collection contents. Accepted format: Array; compatibility field name also used for videos. |
images[].image_link | string | "https://example.com/item" | Required. Media URL. Accepted format: URL/path. |
images[].caption | string | "Example" | Required. Search/generation caption. |
images[].hash | string | "Example" | Optional. Content identity. Accepted format: Digest. |
images[].last_used_at | ISO datetime | "2026-08-01T09:00:00.000Z" | Optional. Latest confirmed use. Accepted format: ISO 8601. |
WordCollectionRecord
| Field | Type | Example | Description |
|---|---|---|---|
id | string | "YEAR" | Required. Runtime variable ID. Accepted format: Hook-variable tag; YEAR is rejected. |
name | string | "Example" | Required. Display name. Accepted format: Non-empty string. |
description | string | "Example" | Optional. Description. |
words | string[] | [] | Required. Candidate substitutions. Accepted format: Normalized non-empty values. |
source | string enum | "manual" | Required. Creation source. Accepted format: manual, ai. |
created_at | ISO datetime | "2026-08-01T09:00:00.000Z" | Required. Creation time. Accepted format: ISO 8601. |
updated_at | ISO datetime | "2026-08-01T09:00:00.000Z" | Required. Last update. Accepted format: ISO 8601. |
ProductCollection
| Field | Type | Example | Description |
|---|---|---|---|
ownerId | string | "record-123" | Optional. Owner. Accepted format: Railway user ID. |
id | string | "record-123" | Required. Collection ID. Accepted format: Stable domain ID. |
name | string | "Example" | Required. Display name. Accepted format: Non-empty string. |
description | string | "Example" | Required. Description. |
items | ProductCollectionItem[] | [] | Required. Products. Accepted format: Array. |
createdAt | ISO datetime | "2026-08-01T09:00:00.000Z" | Required. Creation time. Accepted format: ISO 8601. |
updatedAt | ISO datetime | "2026-08-01T09:00:00.000Z" | Required. Last update. Accepted format: ISO 8601. |
commissionDisclaimer | string | "Example" | Required. Required disclosure. |
commissionSourceUrl | string | "https://example.com/item" | Optional. Commission source. Accepted format: URL. |
ProductCollectionItem
| Field | Type | Example | Description |
|---|---|---|---|
id | string | "record-123" | Required. Product ID. Accepted format: Stable domain ID. |
marketplace | string enum | "amazon" | Required. Marketplace. Accepted format: amazon, shopee. |
marketplaceUrl | string | "https://example.com/item" | Required. Product URL. Accepted format: URL. |
name | string | "Example" | Required. Product name. |
currency | string literal | "SGD" | Required. Currency. Accepted format: SGD. |
price | number | 1 | Required. Numeric price. Accepted format: Non-negative. |
priceLabel | string | "Example" | Required. Display price. |
commissionRate | number | 1 | Required. Commission rate. Accepted format: Numeric rate. |
estimatedCommission | number | 1 | Required. Estimated amount. Accepted format: Non-negative. |
storeImageUrl | string | "https://example.com/item" | Required. Marketplace image. Accepted format: URL/path. |
generatedImageUrl | string | "https://example.com/item" | Required. Generated lifestyle image. Accepted format: URL/path. |
media | ProductCollectionMedia[] | [] | Optional. Stored product gallery. Accepted format: Array. |
salesInspirations | ProductSalesInspiration[] | [] | Optional. Source hook/script mappings adapted to sell this product. Accepted format: Array. |
rating | number | 1 | Optional. Marketplace rating. Accepted format: 0–5. |
reviewCount | number | 1 | Optional. Marketplace review count. Accepted format: Non-negative integer. |
useCase | string | "Example" | Required. Creative use case. |
sourcedAt | ISO datetime | "Example" | Required. Source time. Accepted format: ISO 8601. |
AssetRecord
| Field | Type | Example | Description |
|---|---|---|---|
ownerId | string | "record-123" | Optional. Owner. Accepted format: Railway user ID. |
id | string | "record-123" | Required. Asset ID. Accepted format: Stable domain ID. |
kind | string enum | "image" | Required. Media kind. Accepted format: image, video, audio, text. |
source | string enum | "upload" | Required. Creation source. Accepted format: upload, ai_generated. |
status | string enum | "processing" | Required. Asset lifecycle. Accepted format: processing, ready, failed. |
scope | string enum | "ugc_ad" | Required. Feature scope. Accepted format: ugc_ad, ugc_demo, greenscreen, global. |
category | string enum | "outfit" | Optional. Semantic category. Accepted format: outfit, accessory, background, product, reference, sound, other. |
name | string | "Example" | Required. Display name. |
caption | string | "Example" | Required. Search/generation caption. |
prompt | string | "Example" | Optional. Generation prompt. |
model | string | "Example" | Optional. Generation model. Accepted format: Provider model ID. |
mimeType | string | "Example" | Optional. Content type. Accepted format: MIME type. |
fileName | string | "Example" | Optional. Original/stored name. Accepted format: File name. |
fileUrl | string | "https://example.com/item" | Optional. Media URL. Accepted format: URL/path. |
thumbnailUrl | string | "https://example.com/item" | Optional. Preview. Accepted format: URL/path. |
createdAt | ISO datetime | "2026-08-01T09:00:00.000Z" | Required. Creation time. Accepted format: ISO 8601. |
updatedAt | ISO datetime | "2026-08-01T09:00:00.000Z" | Required. Last update. Accepted format: ISO 8601. |
metadata | object | { "key": "value" } | Optional. Provider/feature metadata. Accepted format: JSON object. |
error | string | "Example" | Optional. Failure detail. |