# Asset Client

## AssetClient

The `AssetClient` allows you to perform various operations related to asset metadata.

Using the `AssetClient` simplifies the process of managing and storing asset metadata for your projects.

### Methods

* uploadAsset
* uploadAssetFolder
* uploadMetadata
* uploadMetadataFolder
* generateISCC
* checkISCCSimilarity

### uploadAsset

Upload an asset to IPFS and return the CID.

| Method        | Type                                                            |
| ------------- | --------------------------------------------------------------- |
| `uploadAsset` | `(request: UploadAssetRequest) => Promise<UploadAssetResponse>` |

**Parameters**

* `request.data`: The data to be uploaded to IPFS.

**Returns**

* `response.uri`: The URI of the uploaded data.

### uploadAssetFolder

Upload an asset folder to IPFS and return the base CID.

| Method              | Type                                                                        |
| ------------------- | --------------------------------------------------------------------------- |
| `uploadAssetFolder` | `(request: UploadAssetFolderRequest) => Promise<UploadAssetFolderResponse>` |

**Parameters**

* `request.data`: The data to be uploaded to IPFS.

**Returns**

* `response.baseUri`: The Base URI of the uploaded data.

### uploadMetadata

Upload metadata to IPFS and return the CID.

| Method           | Type                                                                  |
| ---------------- | --------------------------------------------------------------------- |
| `uploadMetadata` | `(request: UploadMetadataRequest) => Promise<UploadMetadataResponse>` |

* **Parameters**:
  * `request.data` - The actual metadata content.
  * `request.name` - The name of the metadata.
  * `request.symbol` - The symbol of the metadata.
  * `request.description` - The description of the metadata.
  * `request.attributes` - An array of attributes, where each attribute is an object with `trait_type` and `value` properties.
* **Returns**:
  * `response.metadataURI` - The URI (e.g., IPFS URI) where the metadata is stored.

### uploadMetadataFolder

Upload an metadata folder to IPFS and return the base CID.

| Method                 | Type                                                                              |
| ---------------------- | --------------------------------------------------------------------------------- |
| `uploadMetadataFolder` | `(request: uploadMetadataFolderRequest) => Promise<uploadMetadataFolderResponse>` |

**Parameters**

* `request.data`: The data to be uploaded to IPFS.

**Returns**

* `response.baseUri`: The Base URI of the uploaded data.

### generateISCC

Generate the ISCC of the content.

| Method         | Type                                                              |
| -------------- | ----------------------------------------------------------------- |
| `generateISCC` | `(request: generateISCCRequest) => Promise<generateISCCResponse>` |

* **Parameters**:
  * `request.data` - The actual content.
* **Returns**:
  * `response.code` - The ISCC code of content.

### checkISCCSimilarity

Check Similarity between two ISCC Code

| Method                | Type                                                                            |
| --------------------- | ------------------------------------------------------------------------------- |
| `checkISCCSimilarity` | `(request: checkISCCSimilarityRequest) => Promise<checkISCCSimilarityResponse>` |

* **Parameters**:
  * `request.ISCC1` - First ISCC Code.
  * `request.ISCC2` - Second ISCC Code
* **Returns**:
  * `response.percentage` - Similarity percentage of two ISCC code.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://techdocs.korprotocol.io/sdk-reference/client_methods/asset_client.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.