Sign in

v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB
IP Story Protocol

Create IP Asset

Create a new IP Asset

API scope required: nfts.create

post/v1/ip/collections/{collectionId}/ipassets

Path parameters

collectionIdstring required

Headers

X-API-KEYstring required

API key required for authentication

Request body

ownerstring 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

reuploadLinkedFilesboolean

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.

locale'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'

The locale for the recipient's notification.

Example request

{
  "owner": "email:creator@example.com:story-testnet",
  "reuploadLinkedFiles": true,
  "licenseTerms": [
    {
      "type": "non-commercial-social-remixing"
    }
  ],
  "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
    ]
  }
}

Response

IP Asset created

idstring required

The id of the IPAsset

actionIdstring required

The action id for the IPAsset creation

Example response

{
  "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"
      }
    ]
  },
  "licenseTerms": [
    {
      "type": "non-commercial-social-remixing"
    }
  ],
  "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"
  }
}