Skip to content

Get Visual Projects

GET
/api/creative/visual-studio/projects

Get visual/creative projects and assets, scoped to the active project.

Successful Response

VisualProjectsResponse

Response model for visual studio projects listing.

Contains complete visual studio state including all projects, assets, recent items, and aggregated statistics.

Attributes: projects: List of all visual projects assets: List of all assets across projects active_project: Currently active project ID recent_assets: Recently modified/created assets total_projects: Total project count total_assets: Total asset count project_tags: All unique tags across projects

object
projects
Projects

All projects

Array<object>
VisualProject

Visual/creative project model for API responses.

Represents a complete visual project with metadata, status, and associated asset counts.

Attributes: id: Unique project identifier name: Human-readable project name description: Detailed project description status: Project status (active, archived, completed) created_at: Unix timestamp of creation updated_at: Unix timestamp of last update tags: List of categorization tags asset_count: Number of assets in project thumbnail_url: Optional thumbnail image URL

object
id
required
Id

Project ID

string
name
required
Name

Project name

string
description
required
Description

Project description

string
status
required
Status

Project status

string
createdAt
required
Createdat

Creation timestamp

integer
updatedAt
required
Updatedat

Last update timestamp

integer
tags
Tags

Project tags

Array<string>
assetCount
Assetcount

Asset count

integer
0
thumbnailUrl
Any of:
string
assets
Assets

All assets

Array<object>
VisualAsset

Visual asset model for API responses.

Represents a complete visual asset with all metadata, tags, and project association information.

Attributes: id: Unique asset identifier project_id: Parent project identifier type: Asset type (image, video, audio, etc.) name: Human-readable asset name url: Asset URL or file path metadata: Detailed asset metadata created_at: Unix timestamp of creation updated_at: Unix timestamp of last update tags: List of categorization tags

object
id
required
Id

Asset ID

string
projectId
required
Projectid

Project ID

string
type
required
Type

Asset type

string
name
required
Name

Asset name

string
url
required
Url

Asset URL

string
metadata
VisualAssetMetadata

Visual asset metadata model.

Contains detailed metadata about visual assets including file size, format, dimensions, duration, and custom fields.

Attributes: file_size: File size in bytes (optional) format: File format (PNG, JPG, MP4, etc.) dimensions: Asset dimensions (e.g., 1920x1080) duration: Duration in seconds for video/audio custom: Custom metadata key-value pairs

object
fileSize
Any of:
integer
format
Any of:
string
dimensions
Any of:
string
duration
Any of:
number
custom
Custom

Custom metadata fields

object
key
additional properties
Any of:
string
createdAt
required
Createdat

Creation timestamp

integer
updatedAt
required
Updatedat

Last update timestamp

integer
tags
Tags

Asset tags

Array<string>
description
Description

Asset description

string
""
folderId
Any of:
string
annotations
Annotations

Image annotations

Array<object>
VisualAnnotation

A spatial annotation on a visual asset.

object
id
required
Id

Annotation ID

string
text
required
Text

Annotation text

string
x
required
X

Normalized X position (0-1)

number
<= 1
y
required
Y

Normalized Y position (0-1)

number
<= 1
createdAt
required
Createdat

Creation timestamp

integer
activeProject
Any of:
string
recentAssets
Recentassets

Recent assets

Array<object>
VisualAsset

Visual asset model for API responses.

Represents a complete visual asset with all metadata, tags, and project association information.

Attributes: id: Unique asset identifier project_id: Parent project identifier type: Asset type (image, video, audio, etc.) name: Human-readable asset name url: Asset URL or file path metadata: Detailed asset metadata created_at: Unix timestamp of creation updated_at: Unix timestamp of last update tags: List of categorization tags

object
id
required
Id

Asset ID

string
projectId
required
Projectid

Project ID

string
type
required
Type

Asset type

string
name
required
Name

Asset name

string
url
required
Url

Asset URL

string
metadata
VisualAssetMetadata

Visual asset metadata model.

Contains detailed metadata about visual assets including file size, format, dimensions, duration, and custom fields.

Attributes: file_size: File size in bytes (optional) format: File format (PNG, JPG, MP4, etc.) dimensions: Asset dimensions (e.g., 1920x1080) duration: Duration in seconds for video/audio custom: Custom metadata key-value pairs

object
fileSize
Any of:
integer
format
Any of:
string
dimensions
Any of:
string
duration
Any of:
number
custom
Custom

Custom metadata fields

object
key
additional properties
Any of:
string
createdAt
required
Createdat

Creation timestamp

integer
updatedAt
required
Updatedat

Last update timestamp

integer
tags
Tags

Asset tags

Array<string>
description
Description

Asset description

string
""
folderId
Any of:
string
annotations
Annotations

Image annotations

Array<object>
VisualAnnotation

A spatial annotation on a visual asset.

object
id
required
Id

Annotation ID

string
text
required
Text

Annotation text

string
x
required
X

Normalized X position (0-1)

number
<= 1
y
required
Y

Normalized Y position (0-1)

number
<= 1
createdAt
required
Createdat

Creation timestamp

integer
totalProjects
Totalprojects

Total projects count

integer
0
totalAssets
Totalassets

Total assets count

integer
0
projectTags
Projecttags

All unique tags

Array<string>