Create IP Asset
Create a new IP Asset
API scope required: nfts.create
Headers
API key required for authentication
Path Parameters
Body
Input schema for creating a new IP asset on Story Protocol
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>
[
"email:creator@example.com:story-testnet",
"twitter:creator:story",
"userId:123:story-testnet",
"0x742d35Cc6634C0532925a3b844Bc454e4438f44e:story"
]
Metadata for the NFT representation of this IP asset
{
"name": "Art #123",
"description": "A unique story NFT",
"image": "https://example.com/nft/123.png"
}
Metadata containing information about the IP asset itself
{
"title": "Harry Potter and the Philosopher's Stone",
"createdAt": "1997-06-26T00:00:00",
"ipType": "literature",
"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" }
]
}
Controls whether external files (like images) in the metadata should be reuploaded to decentralized storage (IPFS) (true) or referenced with their original URLs (false). Default is True.
true
Optional licensing parameters for the IP asset
License parameters
[
{ "type": "non-commercial-social-remixing" }
]
Data for the parent IP asset and license terms (for derivative IP assets only)
[
{
"parentIpIds": ["0x123"],
"licenseTermsIds": [1]
}
]
Whether to send a notification to the custodial wallet address, or the recipient if it was minted to an email address.
The locale for the recipient's notification.
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
IPAsset response DTO
The id of the IPAsset
"d290f1ee-6c54-4b01-90e6-d701748f0851"
The action id for the IPAsset creation
"d290f1ee-6c54-4b01-90e6-d701748f0851"
Metadata for the NFT representation of this IP asset
{
"name": "Art #123",
"description": "A unique story NFT",
"image": "https://example.com/nft/123.png"
}
Metadata containing information about the IP asset itself
{
"title": "Harry Potter and the Philosopher's Stone",
"createdAt": "1997-06-26T00:00:00",
"ipType": "literature",
"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" }
]
}
Licensing parameters for the IP asset
License parameters
[
{ "type": "non-commercial-social-remixing" }
]
Data for the parent IP asset and license terms (for derivative IP assets only)
{
"parentIpIds": ["0x123"],
"licenseTermsIds": [1],
"maxMintingFee": 0,
"maxRevenueShare": 100,
"maxRts": 10000000
}
Was this page helpful?