Uploads NFT metadata to IPFS as a JSON file which is the standard format for NFT metadata. You can use the returned metadata_ipfs_uri in Customizable minting to mint your NFT.

If you prefer hosting metadata in your own servers, you can skip this step. Otherwise, we recommend using IPFS because it’s an industry standard for decentralized storage and guarantees the immutability of your metadata. For the file_url, we also recommend using IPFS with Upload a file to IPFS.
We use nft.storage to pin the files with Filecoin, which ensures that your important data is retained in IPFS.

Useful for:

  • Storing your NFT metadata easily and according to the industry standards.

Related:

Log in to see full request history
Body Params
string
required
length between 1 and 400

Name of the NFT.

string
required
length between 1 and 2000

Description of the NFT.

string
required
length ≥ 1

URL of the file that you wish to link with the metadata and turn into an NFT.

string
length ≥ 1

URL that will appear below the NFT on some of the NFT marketplaces such as OpenSea.

string
length ≥ 1

URL to a multimedia attachment with all filetypes supported. If you want to make sure the file is supported by OpenSea, then see their docs. When using animation_url, set the file_url as the multimedia preview which will be displayed on the NFT marketplaces e.g. if your animation_url is a video then set file_url as the preview image for it.

object

A dictionary which allows you to extend the metadata schema with your own arbitrary fields. You can pass anything here as long as it is follows “key”: “value” format inside a dictionary. All of the fields will be flattened and added to the top-level namespace e.g. like name, description, etc. Read more about Metadata Schema. Example:

                {
                    "youtube_url": "https://www.youtube.com/watch?v=M2mBg7xHmY8&t=1s",
                    "background_color": "ffffff",
                    "random_key": "random_value"
                }
                
array of objects

Optional list of NFT attributes. See OpenSea docs for more information. Example:

                "attributes": [
                    {
                      "trait_type": "Background", 
                      "value": "Clean"
                    }, 
                    {
                      "trait_type": "Type", 
                      "value": "Rare"
                    }, 
                    {
                      "trait_type": "Packaging", 
                      "value": "Clean"
                    },
                    {
                      "trait_type": "Personality", 
                      "value": "OG"
                    }
                ]
                
Attributes
Response

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json