Media & Documents
This section describes all media and document-related fields returned in project payloads. Media objects in Reelly share a common structure (URL + metadata) but are used in different contexts: Project-level branding, visual galleries, plans and layout images, attached documents, building-level media, amenity icons, and video content.
This section describes all media and document-related fields returned in project payloads.
Media objects in Reelly share a common structure (URL + metadata) but are used in different contexts:
- Project-level branding (icons, cover images)
- Visual galleries (lobby, interior, architecture)
- Plans and layout images
- Attached documents (floor plans, brochures)
- Building-level media
- Amenity icons
- Video content (video_reviews).
Base media object structure
| Field | Type | Description |
|---|---|---|
url | string | Direct link to the file (vault / S3 / external). |
metadata.mime | string | MIME type, e.g. image/jpeg, image/webp, image/png, application/pdf. |
metadata.size | number | File size in bytes. |
metadata.width | number | null | Image width in pixels (for images only). |
metadata.height | number | null | Image height in pixels (for images only). |
For documents like PDFs, width / height are usually not present.
Media types by context
Project icon
Small branding image used for project branding / lists (when present).
| JSON path | Type | Description |
|---|---|---|
icon (if present) | object | Project-level icon. |
| Field | Type | Description |
|---|---|---|
icon.url | string | Icon URL. |
icon.metadata | object | Standard media metadata. |
Project cover image
Main hero image of the project.
| JSON path | Type | Description |
|---|---|---|
cover_image | object | Primary project cover image. |
| Field | Type | Description |
|---|---|---|
cover_image.url | string | Cover image URL (wide image). |
cover_image.metadata | object | MIME type, size, dimensions. |
Typical usage:
Used on project list cards and project detail pages as the primary hero image.
Amenity icons
Each amenity may contain its own icon. The project_amenities collection may have:
project_amenities[].icon— icon at the project-amenity level (may benull)project_amenities[].amenity.icon— icon at the amenity-definition level.
| JSON path | Type | Description |
|---|---|---|
project_amenities[].icon | object | null | Custom icon for this amenity in this project. |
project_amenities[].amenity.icon | object | Default icon for this amenity type. |
Both icons follow the base media structure.
Lobby images
Lobby photos are returned as an array:
| JSON path | Type | Description |
|---|---|---|
lobby[] | array<object> | Collection of lobby images. |
| Field | Type | Description |
|---|---|---|
lobby[].url | string | Lobby image URL. |
lobby[].metadata | object | MIME, size, width, height. |
Usage:
Displayed as a dedicated image set for lobby / common areas.
Interior images
Interiors (units, common spaces) are grouped under interior.
| JSON path | Type | Description |
|---|---|---|
interior[] | array<object> | Collection of interior images. |
| Field | Type | Description |
|---|---|---|
interior[].url | string | Interior photo URL. |
interior[].metadata | object | Image metadata. |
Usage:
Interior gallery on project detail page.
Architecture images
Architecture / exterior images are grouped under architecture.
| JSON path | Type | Description |
|---|---|---|
architecture[] | array<object> | Collection of exterior / architecture images. |
| Field | Type | Description |
|---|---|---|
architecture[].url | string | Architecture photo URL. |
architecture[].metadata | object | Image metadata. |
Usage:
Gallery for building exteriors, façades, skyline views, etc.
General plan
The overall site / masterplan is represented as a single media object:
| JSON path | Type | Description |
|---|---|---|
general_plan | object | General (master) plan image. |
| Field | Type | Description |
|---|---|---|
general_plan.url | string | General plan image URL. |
general_plan.metadata | object | MIME, size, width, height. |
Usage:
Full-screen view on the project page (zoomable map-like image).
Building cover images
Each building in the project can have its own cover image:
| JSON path | Type | Description |
|---|---|---|
buildings[].cover_image | object | Building-level cover image. |
| Field | Type | Description |
|---|---|---|
buildings[].cover_image.url | string | Image URL. |
buildings[].cover_image.metadata | object | Metadata for the building image. |
Usage:
Used on buildings sub-sections / tabs to visually distinguish buildings.
Unit layouts (inside typical_units)
typical_units)Each typical unit configuration can contain one or more layout images:
| JSON path | Type | Description |
|---|---|---|
typical_units[].layout[] | array<object> | Layout images for that unit configuration. |
| Field | Type | Description |
|---|---|---|
layout[].image.url | string | Layout image URL (floor plan-like image). |
layout[].image.metadata | object | MIME, size, width, height. |
layout[].order | number | Display order within the layouts collection. |
Usage:
Displayed on unit-type tabs (Studio / 1BR / 2BR / etc.) as corresponding layouts.
Video reviews
Projects may contain video content as video_reviews.
In your samples, this array is currently empty, but the field is present and should be documented.
| JSON path | Type | Description |
|---|---|---|
video_reviews[] | array<object> | List of video review objects (currently empty in samples). |
Recommendation for docs:
Document video_reviews as a reserved field for future video media (e.g. YouTube/Vimeo links + thumbnails), even if schema is not yet fully stabilized.
Documents related to the project
Aside from images, the project includes downloadable documents:
| Type | Field | Format | Description |
|---|---|---|---|
| Floor plans | floor_plans[].file | Floor-level plans, grouped by project. | |
| Marketing brochure | marketing_brochure | External PDF / link | Full marketing presentation. |
Floor plans (documents)
Floor plans are documents, usually PDFs, stored in floor_plans.
| JSON path | Type | Description |
|---|---|---|
floor_plans[] | array<object> | List of floor plan documents. |
| Field | Type | Description |
|---|---|---|
id | number | Floor plan ID. |
name | string | Human-friendly name (may include internal path). |
file | string | Direct link to the PDF file. |
file_type | string | Always "floor_plan" for floor plans. |
description | string | null | Optional description. |
Usage:
Downloadable / viewable floor plan documents.
Note:
floor_plans[].fileis the document URL, noturl+metadatalike images.
Marketing brochure
The marketing brochure is an external document, often hosted in Google Drive.
| JSON path | Type | Description |
|---|---|---|
marketing_brochure | string | null | External URL to the marketing brochure. |
Usage:
- Open in a new tab
- No guarantee that metadata (size, mime, etc.) is available from API.
Updated 21 days ago