Metadata & Options

For all operations that result in a file being uploaded or added to an account, there are optional pieces of data that can be included.

​

pinataMetadata

In addition to pinning your file to Pinata, you also have the option to include metadata that is kept with Pinata that can be used for your own organization purposes.

This metadata can later be used for easy querying on what you’ve pinned with our pinList request.

The optional metadata object takes the following form:

{
    "name": "A custom name. If you don't provide this value, it will automatically be populated by the original name of the file you've uploaded",
    "keyvalues": {
      "customKey": "customValue",
      "customKey2": "customValue2"
    }
}

​

pinataOptions

Pinata supports adding additional options when pinning a file. The following options are currently supported for this endpoint:

• cidVersion - The CID Version IPFS will use when creating a hash for your content. Valid options are: “0” (CIDv0) or “1” (CIDv1)
• wrapWithDirectory - Wrap your content inside of a directory when adding to IPFS. This allows users to retrieve content via a filename instead of just a hash. For a more detailed explanation, see this informative blogpost. Valid options are: true or false
• groupId - Used to upload a file to an existing Group.

Here is an example of the object to create pinataOptions:

"pinataOptions": {
    "cidVersion": 0,
    "wrapWithDirectory": false,
    "groupId": "ID of the group you want to upload a CID to"
}