Mint NFT

Mint your NFTs and deliver them to a web3 wallet or an email address

API scope required: nfts.create

Authorizations

X-API-KEY

string

headerrequired

Obtained in the Crossmint developer console

Path Parameters

collectionId

string

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 intitial request. Example: your-custom-identifer

Body

application/json

• Metadata
• Template Id

metadata

required

Optional if baseURI is set.

Show child attributes

metadata.name

string

required

The name of your NFT (Max length: 32)

Maximum length: 32

metadata.image

string

required

Direct link to your NFT image

metadata.description

string

required

A brief description of the NFT (Max length: 64)

Maximum length: 64

metadata.animation_url

string

EVM only

See more info here

metadata.attributes

object[]

Add attributes to your NFT

Show child attributes

metadata.attributes.display_type

enum<string>

Display name of your attribute

Available options:

boost_number,

boost_percentage,

number

metadata.attributes.trait_type

string

required

The name of the trait

metadata.attributes.value

string

required

The value of the trait

recipient

string

required

Allowed formats:

<chain>:<address> or

email:<email_address>:<chain> or

userId:<userId>:<chain>

see here for more info

sendNotification

boolean

Notify recipient via email notification about successful mint [Default: true]. Learn how this applies to legacy projects.

locale

string

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

reuploadLinkedFiles

boolean

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

compressed

boolean

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

Response

200 - application/json

• Option 1
• Option 2

id

string

onChain

object

Show child attributes

onChain.status

string

onChain.chain

string

actionId

string