v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB

NFT Templates

Create Template with ID

Create a token template with preconfigured metadata

API scope required: nfts.create

put/2022-06-09/collections/{collectionId}/templates/{templateId}

Path parameters

collectionIdstring required

This is the identifier for the collection related to the request. Every project has default collections: default-solana and default-polygon.

The create-collection API will result in collections with UUID formatted collectionId. Example: 9c82ef99-617f-497d-9abb-fd355291681b

The create-collection-idempotent API allows you to specify an arbitrary identifier during the initial request. Example: your-custom-identifier

templateIdstring required

The template ID

Request body

reuploadLinkedFilesboolean

Any URLs in the metadata object will be resolved and reuploaded to IPFS [Default: true]

Example request

{
  "onChain": {
    "tokenId": "1"
  },
  "supply": {
    "limit": 10
  }
}

Response

Success

templateIdstring uuid

Example response

{
  "templateId": "20ed0963-0185-49af-b4a0-2de3169bb367",
  "metadata": {
    "name": "My Token",
    "image": "ipfs://QmaToZn4VEjF7q4CAudPaNka6AD484xuuEZSXmTLJPDLVE",
    "description": "Sample Token Template",
    "symbol": "A shorthand identifier for the token (Solana only)"
  },
  "onChain": {
    "tokenId": 1
  },
  "supply": {
    "limit": 1
  }
}