Skip to main content
PUT
Update Project

Authorizations

Authorization
string
header
required

Aspect API key (sk_...) in Authorization header. 'Bearer ' optional.

Path Parameters

project_id
string<uuid>
required

Body

application/json

API request schema for updating a project

name
string | null

New name for the project

default_role
enum<string> | null

New default role for workspace members (full_access, editor, commenter, downloader, viewer, no_access)

Available options:
owner,
member,
member_limited,
full_access,
editor,
commenter,
downloader,
viewer,
no_access
icon
CustomIconUpdateRequest · object | null

Icon update request

is_active
boolean | null

New active status for the project (requires workspace admin access). Inactive projects are hidden from listing and discovery surfaces.

Response

Successful Response

API response schema for updating a project

id
string<uuid>
required

Project ID

name
string
required

Project name

root_directory_id
string<uuid>
required

Root directory ID - all user directories/assets are children of this

trash_directory_id
string<uuid>
required

Trash directory ID - deleted assets are moved here

default_role
enum<string>
required

Default role for workspace members accessing this project

Available options:
owner,
member,
member_limited,
full_access,
editor,
commenter,
downloader,
viewer,
no_access
default_actions
integer
required

Default permission bitmap inherited by children

default_features
string[]
required
deprecated

Deprecated and unused; ignore it.

is_active
boolean
required

Whether the project is active. Inactive projects are hidden from listing and discovery surfaces.

num_assets
integer
required

Number of assets in project

size_bytes
integer
required

Total size of assets in bytes

total_tokens_used
integer
required

Total tokens used

duration
number
required

Total duration in seconds

chunk_size
integer
required

Chunk size in bytes for chunked uploads

actions
integer
required

User's permission bitmap on this project

created_by_user_id
string<uuid>
required

ID of the user that created the project

created
string<date-time>
required

Creation timestamp

updated
string<date-time>
required

Last update timestamp

icon
CustomIconData · object | null

Project icon data

dominant_color
string | null

Dominant color extracted from project icon (hex format)

system_directory_id
string<uuid> | null

System directory ID - the project's Aspect Stash folder under the root where Aspect places files automatically (canvas outputs, canvas uploads, generation outputs); null until it is lazily created on first use