Generate Metadata

Helping you to generate and pin HIP412 compliant metadata for your minted NFTs in your collection inside of IPFS through NFT storage.

Overview

Metadata is what we refer to as a structure that conforms to HIP412, to ensure that it is processable for down-stream clients such as wallets like Hashpack. Upon successful validation, you will be provided a CID as a unique reference to an IPFS pin for minting NFTs.

You should handle the media uploads by default, this is handled through the tools provided by nft.storage, or using NFTup for directories.

Below is an example of valid metadata, but the validation has been handcrafted in the API to strictly handle many variations of HIP412, based on spec and examples.

If your JSON structure does not comply with the rules of the aforementioned HIP a status of 422 will be returned with a detailed error response on the issue.

Basic metadata to generate CID

Environment Variables

Remember, for complete management of NFT over an API for the creation, minting, metadata generation, and advanced transfer feature you need both the NFT_STORAGE_TOKEN and MIRROR_NODE_URL set.

pageEnvironment Variables

POST https://hedera-serverless-consensus.vercel.app/api/nft/metadata

Generate the metadata based on a valid structure

Headers

Name	Type	Description
x-api-key*	String	The API_SECRET_KEY from the client's environment variables.

Request Body

Name	Type	Description
{}*	json	Compliant HIP412 JSON structure

200: OK Returns a CID

{
    // Response
}

401: Unauthorized Header Auth Missing/invalid

{
    // Response
}

422: Unprocessable Entity JSON structure does not comply with HIP412

{
    // Response
}