Skip to main content
PUT
Set Asset Metadata Value

Authorizations

Authorization
string
header
required

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

Path Parameters

attribute_id
string<uuid>
required

Attribute ID

asset_id
string<uuid>
required

Asset ID

Body

application/json

API request schema for setting a metadata value.

value
any
required

The value to set. Its shape depends on the attribute's data_type:

  • string: A string.
  • integer, float: A number.
  • boolean: true or false.
  • datetime: An ISO 8601 string.
  • single_select: An option ID.
  • multi_select: A list of option IDs.
  • user_id: A list of user IDs.

Send null to clear the value. Attributes with is_editable false can't be set.

Response

Successful Response

API response schema for a single metadata value.

attribute_id
string<uuid>
required

ID of the attribute this value is for

data_type
enum<string>
required

Data type of the value

Available options:
string,
integer,
float,
boolean,
datetime,
single_select,
multi_select,
user_id,
person_id,
object_id,
directory_id
value
any
required

The value. Its shape depends on data_type:

  • string: A string.
  • integer, float: A number.
  • boolean: true or false.
  • datetime: An ISO 8601 string.
  • single_select: An option ID.
  • multi_select: A list of option IDs.
  • user_id: A list of users, each with id, first_name, last_name, email, and avatar_url.
  • person_id: A list of people, each with person_id, label, and source.
  • object_id: A list of objects, each with object_id, label, and source.
  • directory_id: The directories containing the asset, outermost first, each with id and name. Empty when the asset is directly in the project's top-level directory.

null when there's no value.

name
string | null

Display name of the attribute

source
enum<string>
default:user

Author of the value's current content: user for manual writes, ai for generated ones

Available options:
user,
ai