Skip to main content
PUT
/
v1
/
ip
/
collections
/
{collectionId}
/
ipassets
/
{customerFacingId}
Create IP Asset (Idempotent)
curl --request PUT \
  --url https://staging.crossmint.com/api/v1/ip/collections/{collectionId}/ipassets/{customerFacingId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data @- <<EOF
{
  "owner": "email:creator@example.com:story-testnet",
  "nftMetadata": {
    "name": "Art #123",
    "description": "A unique story NFT",
    "image": "https://example.com/nft/123.png"
  },
  "ipAssetMetadata": {
    "title": "Harry Potter and the Philosopher's Stone",
    "createdAt": "1997-06-26T00:00:00",
    "ipType": "literature",
    "image": "https://example.com/book-cover.jpg",
    "imageHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "mediaUrl": "link_to_epub",
    "mediaHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "mediaType": "application/epub+zip",
    "creators": [
      {
        "name": "JK Rowling",
        "email": "JKRowling@example.com",
        "crossmintUserLocator": "email:JKRowling@example.com:story",
        "description": "Author",
        "contributionPercent": 80,
        "socialMedia": [
          {
            "platform": "Wikipedia",
            "url": "https://en.wikipedia.org/wiki/J._K._Rowling"
          }
        ]
      },
      {
        "name": "Thomas Taylor",
        "address": "0x1234567890123456789012345678901234567890",
        "description": "Illustrator",
        "contributionPercent": 15
      },
      {
        "name": "Bloomsbury Publishing",
        "email": "BloomsburyPublishing@example.com",
        "address": "0x1234567890123456789012345678901234567890",
        "description": "Publisher",
        "contributionPercent": 5,
        "socialMedia": [
          {
            "platform": "Website",
            "url": "https://www.bloomsbury.com/"
          }
        ]
      }
    ],
    "media": [
      {
        "name": "ePub",
        "url": "link_to_epub",
        "mimeType": "application/epub+zip"
      },
      {
        "name": "Book Summary PDF",
        "url": "link_to_book_summary_pdf",
        "mimeType": "application/pdf"
      }
    ],
    "attributes": [
      {
        "key": "ISBN",
        "value": "978-0-7475-3269-0"
      },
      {
        "key": "Genre",
        "value": "Fantasy"
      }
    ]
  },
  "derivData": {
    "parentIpIds": [
      "0x123"
    ],
    "licenseTermsIds": [
      1
    ]
  },
  "reuploadLinkedFiles": true,
  "licenseTerms": [
    {
      "type": "non-commercial-social-remixing"
    }
  ],
  "sendNotification": true
}
EOF
{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "actionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "nftMetadata": {
    "name": "Art #123",
    "description": "A unique story NFT",
    "image": "https://example.com/nft/123.png"
  },
  "ipAssetMetadata": {
    "title": "Harry Potter and the Philosopher's Stone",
    "createdAt": "1997-06-26T00:00:00",
    "ipType": "literature",
    "image": "https://example.com/book-cover.jpg",
    "imageHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "mediaUrl": "link_to_epub",
    "mediaHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
    "mediaType": "application/epub+zip",
    "creators": [
      {
        "name": "JK Rowling",
        "email": "JKRowling@example.com",
        "crossmintUserLocator": "email:JKRowling@example.com:story",
        "description": "Author",
        "contributionPercent": 80,
        "socialMedia": [
          {
            "platform": "Wikipedia",
            "url": "https://en.wikipedia.org/wiki/J._K._Rowling"
          }
        ]
      },
      {
        "name": "Thomas Taylor",
        "address": "0x1234567890123456789012345678901234567890",
        "description": "Illustrator",
        "contributionPercent": 15
      },
      {
        "name": "Bloomsbury Publishing",
        "email": "BloomsburyPublishing@example.com",
        "address": "0x1234567890123456789012345678901234567890",
        "description": "Publisher",
        "contributionPercent": 5,
        "socialMedia": [
          {
            "platform": "Website",
            "url": "https://www.bloomsbury.com/"
          }
        ]
      }
    ],
    "media": [
      {
        "name": "ePub",
        "url": "link_to_epub",
        "mimeType": "application/epub+zip"
      },
      {
        "name": "Book Summary PDF",
        "url": "link_to_book_summary_pdf",
        "mimeType": "application/pdf"
      }
    ],
    "attributes": [
      {
        "key": "ISBN",
        "value": "978-0-7475-3269-0"
      },
      {
        "key": "Genre",
        "value": "Fantasy"
      }
    ]
  },
  "derivData": {
    "parentIpIds": [
      "0x123"
    ],
    "licenseTermsIds": [
      1
    ],
    "maxMintingFee": 0,
    "maxRevenueShare": 100,
    "maxRts": 10000000
  },
  "onChain": {
    "chain": "story-testnet",
    "contractAddress": "0x123",
    "status": "success",
    "ipAssetId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "tokenId": "1",
    "txId": "0x123",
    "owner": "0x123",
    "explorerLink": "https://portal.story.foundation/assets/0xAC6062FF53fa41e61Fe01B89B83d9dB96b5F9280"
  },
  "licenseTerms": [
    {
      "type": "non-commercial-social-remixing"
    }
  ]
}
This API is still under development. Contact support for early access.

Headers

​
X-API-KEY
string
required

API key required for authentication

Path Parameters

​
collectionId
string
required
​
customerFacingId
string
required

Body

application/json
​
owner
string
required

The owner (main creator) of the IP asset: Allowed formats:

<chain>:<address> or

email:<email_address>:<chain> or

userId:<userId>:<chain> or

twitter:<twitter_handle>:<chain>

see here for more info

Example:

"email:creator@example.com:story-testnet"

​
nftMetadata
object
required

Metadata for the NFT representation of this IP asset

Example:
{
  "name": "Art #123",
  "description": "A unique story NFT",
  "image": "https://example.com/nft/123.png"
}
​
ipAssetMetadata
object
required

Metadata containing information about the IP asset itself

Example:
{
  "title": "Harry Potter and the Philosopher's Stone",
  "createdAt": "1997-06-26T00:00:00",
  "ipType": "literature",
  "image": "https://example.com/book-cover.jpg",
  "imageHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "mediaUrl": "link_to_epub",
  "mediaHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "mediaType": "application/epub+zip",
  "creators": [
    {
      "name": "JK Rowling",
      "email": "JKRowling@example.com",
      "crossmintUserLocator": "email:JKRowling@example.com:story",
      "description": "Author",
      "contributionPercent": 80,
      "socialMedia": [
        {
          "platform": "Wikipedia",
          "url": "https://en.wikipedia.org/wiki/J._K._Rowling"
        }
      ]
    },
    {
      "name": "Thomas Taylor",
      "address": "0x1234567890123456789012345678901234567890",
      "description": "Illustrator",
      "contributionPercent": 15
    },
    {
      "name": "Bloomsbury Publishing",
      "email": "BloomsburyPublishing@example.com",
      "address": "0x1234567890123456789012345678901234567890",
      "description": "Publisher",
      "contributionPercent": 5,
      "socialMedia": [
        {
          "platform": "Website",
          "url": "https://www.bloomsbury.com/"
        }
      ]
    }
  ],
  "media": [
    {
      "name": "ePub",
      "url": "link_to_epub",
      "mimeType": "application/epub+zip"
    },
    {
      "name": "Book Summary PDF",
      "url": "link_to_book_summary_pdf",
      "mimeType": "application/pdf"
    }
  ],
  "attributes": [
    {
      "key": "ISBN",
      "value": "978-0-7475-3269-0"
    },
    { "key": "Genre", "value": "Fantasy" }
  ]
}
​
derivData
object
required

Data for the parent IP asset and license terms (for derivative IP assets only)

Example:
{
  "parentIpIds": ["0x123"],
  "licenseTermsIds": [1]
}
​
reuploadLinkedFiles
boolean
default:true

Controls whether external files (like images) in the NFT metadata should be reuploaded to decentralized storage (IPFS) (true) or referenced with their original URLs (false). Default is True.

Example:

true

​
licenseTerms
(Non-commercial Social Remixing License Terms · object | Commercial Use License Terms · object | Commercial Remix License Terms · object)[]

Licensing parameters for the IP asset, NOTE: For detailed and updated license terms, refer to the 'Get IP Asset License' endpoint

License parameters

Example:
{ "type": "non-commercial-social-remixing" }
​
sendNotification

Whether to send a notification to the custodial wallet address, or the recipient if it was minted to an email address.

​
locale
enum<string>

The locale for the recipient's notification.

Available options:
en-US,
es-ES,
fr-FR,
it-IT,
ko-KR,
pt-PT,
ja-JP,
zh-CN,
zh-TW,
de-DE,
ru-RU,
tr-TR,
uk-UA,
th-TH,
vi-VN,
Klingon

Response

200 - application/json

IP Asset created

​
id
string
required

The id of the IPAsset

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

​
actionId
string
required

The action id for the IPAsset creation

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

​
nftMetadata
object
required

Metadata for the NFT representation of this IP asset

Example:
{
  "name": "Art #123",
  "description": "A unique story NFT",
  "image": "https://example.com/nft/123.png"
}
​
ipAssetMetadata
object
required

Metadata containing information about the IP asset itself

Example:
{
  "title": "Harry Potter and the Philosopher's Stone",
  "createdAt": "1997-06-26T00:00:00",
  "ipType": "literature",
  "image": "https://example.com/book-cover.jpg",
  "imageHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "mediaUrl": "link_to_epub",
  "mediaHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "mediaType": "application/epub+zip",
  "creators": [
    {
      "name": "JK Rowling",
      "email": "JKRowling@example.com",
      "crossmintUserLocator": "email:JKRowling@example.com:story",
      "description": "Author",
      "contributionPercent": 80,
      "socialMedia": [
        {
          "platform": "Wikipedia",
          "url": "https://en.wikipedia.org/wiki/J._K._Rowling"
        }
      ]
    },
    {
      "name": "Thomas Taylor",
      "address": "0x1234567890123456789012345678901234567890",
      "description": "Illustrator",
      "contributionPercent": 15
    },
    {
      "name": "Bloomsbury Publishing",
      "email": "BloomsburyPublishing@example.com",
      "address": "0x1234567890123456789012345678901234567890",
      "description": "Publisher",
      "contributionPercent": 5,
      "socialMedia": [
        {
          "platform": "Website",
          "url": "https://www.bloomsbury.com/"
        }
      ]
    }
  ],
  "media": [
    {
      "name": "ePub",
      "url": "link_to_epub",
      "mimeType": "application/epub+zip"
    },
    {
      "name": "Book Summary PDF",
      "url": "link_to_book_summary_pdf",
      "mimeType": "application/pdf"
    }
  ],
  "attributes": [
    {
      "key": "ISBN",
      "value": "978-0-7475-3269-0"
    },
    { "key": "Genre", "value": "Fantasy" }
  ]
}
​
derivData
object
required

Data for the parent IP asset and license terms (for derivative IP assets only)

Example:
{
  "parentIpIds": ["0x123"],
  "licenseTermsIds": [1],
  "maxMintingFee": 0,
  "maxRevenueShare": 100,
  "maxRts": 10000000
}
​
onChain
object
required
​
licenseTerms
(Non-commercial Social Remixing License Terms · object | Commercial Use License Terms · object | Commercial Remix License Terms · object)[]

Licensing parameters for the IP asset, NOTE: For detailed and updated license terms, refer to the 'Get IP Asset License' endpoint

License parameters

Example:
{ "type": "non-commercial-social-remixing" }