Mint NFT with ID
This pathway allows you to mint NFTs and guarantee idempotency to ensure you never double mint for the same NFT.
API scope required: nfts.create
Subsequent reqeuests to this endpoint with the same id in the path will not mint additional NFTs.
Furthermore, the success responses (with status code 200) will be different once the initial request has completed and includes the metadata for the minted NFT.
Authorizations
Obtained in the Crossmint developer console
Path Parameters
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 intitial request.
Example: your-custom-identifer
Custom ID of the NFT, which is used as an idempotency key
Body
Allowed formats:
<chain>:<address> or
email:<email_address>:<chain> or
userId:<userId>:<chain> or
twitter:<twitter_handle>:<chain>
Notify recipient via email notification about successful mint [Default: true]. Learn how this applies to legacy projects.
Specify the locale for the email content [Default: en-US]
Any URLs in the metadata object will be resolved and reuploaded to IPFS [Default: true]
Solana only Use NFT compression for cheaper mint costs [Default: true]