> ## Documentation Index > Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt > Use this file to discover all available pages before exploring further. # assets > sift/assets/v1/assets.proto ## Services *RPC methods exposed by this API.* ### AssetService | Method | Request | Response | Description | | :----------- | :------------------------------------------ | :-------------------------------------------- | :------------------------------------------------------------------ | | DeleteAsset | [DeleteAssetRequest](#deleteassetrequest) | [DeleteAssetResponse](#deleteassetresponse) | Delete will archive an asset. Deprecated: Use ArchiveAsset instead. | | CreateAsset | [CreateAssetRequest](#createassetrequest) | [CreateAssetResponse](#createassetresponse) | Creates a new, empty asset. | | GetAsset | [GetAssetRequest](#getassetrequest) | [GetAssetResponse](#getassetresponse) | Retrieves an asset. | | ListAssets | [ListAssetsRequest](#listassetsrequest) | [ListAssetsResponse](#listassetsresponse) | Retrieves assets using an optional filter. | | UpdateAsset | [UpdateAssetRequest](#updateassetrequest) | [UpdateAssetResponse](#updateassetresponse) | | | ArchiveAsset | [ArchiveAssetRequest](#archiveassetrequest) | [ArchiveAssetResponse](#archiveassetresponse) | Archive an asset. | ## Messages *Data models used across requests/responses.* ### ArchiveAssetRequest The request for a call to `AssetService_ArchiveAsset` to archive a single existing asset by its asset\_id. | Field | Type | Label | Description | | :------------ | :----- | :---- | :-------------------------------------------------------- | | asset\_id | string | | The id of the asset to be archived. Required. | | archive\_runs | bool | | If true, will archive all runs associated with the asset. | ### ArchiveAssetResponse The response of a call to `AssetService_ArchiveAsset`. | Field | Type | Label | Description | | :----------------- | :----- | :------- | :------------------------------------------------------------------------------------------------------------------------------------------------------ | | archived\_run\_ids | string | repeated | List of run IDs that were archived when archive\_runs was set to true. This field will be empty if archive\_runs was false or if no runs were archived. | ### Asset | Field | Type | Label | Description | | :--------------------- | :---------------------------------------------------------------- | :------- | :---------------------------------------------------------------------------------- | | asset\_id | string | | | | name | string | | | | organization\_id | string | | | | created\_date | google.protobuf.Timestamp | | | | created\_by\_user\_id | string | | | | modified\_date | google.protobuf.Timestamp | | | | modified\_by\_user\_id | string | | | | tags | string | repeated | The names of the tags associated with this asset. | | metadata | [sift.metadata.v1.MetadataValue](#sift-metadata-v1-metadatavalue) | repeated | The metadata values associated with this asset. | | archived\_date | google.protobuf.Timestamp | | The date the asset was archived. | | is\_archived | bool | | Whether the asset is archived. This is inferred from whether archived\_date is set. | ### CreateAssetRequest The request for a call to `AssetService_CreateAsset` to create a single new, empty asset. | Field | Type | Label | Description | | :------- | :---------------------------------------------------------------- | :------- | :--------------------------------------------------------------------------------- | | name | string | | The name of the asset to create. Must be unique within the organization. Required. | | tags | string | repeated | The names of the tags to associate with this asset. Optional. | | metadata | [sift.metadata.v1.MetadataValue](#sift-metadata-v1-metadatavalue) | repeated | The metadata values to associate with this asset. Optional. | ### CreateAssetResponse The response of a call to `AssetService_CreateAsset`. | Field | Type | Label | Description | | :---- | :-------------- | :---- | :----------------------- | | asset | [Asset](#asset) | | The newly created asset. | ### DeleteAssetRequest The request for a call to `AssetService_DeleteAsset` to archive a single existing asset by its asset\_id. Deprecated: Use ArchiveAssetRequest instead. | Field | Type | Label | Description | | :------------ | :----- | :---- | :-------------------------------------------------------- | | asset\_id | string | | The id of the asset to be archived. Required. | | archive\_runs | bool | | If true, will archive all runs associated with the asset. | ### DeleteAssetResponse The response of a call to `AssetService_DeleteAsset`. Deprecated: Use ArchiveAssetResponse instead. *This message has no fields.* ### GetAssetRequest The request for a call to `AssetService_GetAsset` to retrieve a single existing asset by its asset\_id. | Field | Type | Label | Description | | :-------- | :----- | :---- | :--------------------------------------------- | | asset\_id | string | | The id of the asset to be retrieved. Required. | ### GetAssetResponse | Field | Type | Label | Description | | :---- | :-------------- | :---- | :---------- | | asset | [Asset](#asset) | | | ### ListAssetsRequest The request for a call to `AssetService_ListAssets`. | Field | Type | Label | Description | | :---------- | :----- | :---- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | page\_size | uint32 | | The maximum number of assets to return. The service may return fewer than this value. If unspecified, at most 50 assets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | | page\_token | string | | A page token, received from a previous `ListAssets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAssets` must match the call that provided the page token. | | filter | string | | A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string. Available fields to filter by are `asset_id`, `created_by_user_id`, `modified_by_user_id`, `created_date`, `modified_date`, `name`, 'name\_lower', `tag_id`, `tag_name`, 'archived\_date', `is_archived`, and `metadata`. Metadata can be used in filters by using `metadata.{metadata_key_name}` as the field name. For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions). For more information about the fields used for filtering, please refer to [this definition](/docs/api/grpc/protocol-buffers/assets#asset). Optional. | | order\_by | string | | How to order the retrieved assets. Formatted as a comma-separated string i.e. "FIELD\_NAME\[ desc],...". Available fields to order\_by are `name`, `created_date`, `modified_date` and `archived_date`. If left empty, items are ordered by `created_date` in descending order (newest-first). For more information about the format of this field, read [this](https://google.aip.dev/132#ordering) Example: "created\_date desc,modified\_date" | ### ListAssetsResponse The result of a call to `AssetService_ListAssets`. | Field | Type | Label | Description | | :---------------- | :-------------- | :------- | :---------- | | assets | [Asset](#asset) | repeated | | | next\_page\_token | string | | | ### UpdateAssetRequest The request for a call to `AssetService_UpdateAsset` to update a single existing asset. | Field | Type | Label | Description | | :----------- | :------------------------------------------------------ | :---- | :------------------------------------------------------------------------------------------------------------------------------- | | asset | [Asset](#asset) | | The asset to update. The asset's `asset_id` field is used to identify asset run to update and is required. | | update\_mask | [google.protobuf.FieldMask](#google-protobuf-fieldmask) | | The list of fields to be updated. The fields available to be updated are `tags`, `metadata`, `archived_date`, and `is_archived`. | ### UpdateAssetResponse The response of a call to `AssetService_UpdateAsset`. | Field | Type | Label | Description | | :---- | :-------------- | :---- | :---------- | | asset | [Asset](#asset) | | | ## Enums *Allowed constant values used in message fields.*