Sign in

v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB
NFTs

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

put/2022-06-09/collections/{collectionId}/nfts/{id}

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

idstring required
Example:my-idempotency-key

Custom ID of the NFT, which is used as an idempotency key

Request body

recipientstring required

Allowed formats:

<chain>:<address> or

email:<email_address>:<chain> or

userId:<userId>:<chain> or

twitter:<twitter_handle>:<chain>

see here for more info

sendNotificationboolean

Notify recipient via email notification about successful mint [Default: true]. For legacy projects created before Sep 16, 2024, this is set to false by default.

localestring

Specify the locale for the email content [Default: en-US]

reuploadLinkedFilesboolean

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

compressedboolean

Solana only Use NFT compression for cheaper mint costs [Default: true]

Example request

{
  "metadata": {
    "name": "Crossmint Example NFT",
    "image": "https://www.crossmint.com/assets/crossmint/logo.png",
    "description": "My NFT created via the mint API!"
  },
  "recipient": "email:testy@crossmint.com:polygon",
  "locale": "en-US"
}

Response

The request has been accepted.

OR
OR
OR

Example response

{
  "onChain": {
    "status": "success",
    "chain": "solana"
  }
}