Sign in

v1

latestOpenAPI 3.0.12026-07-2699111970.1 KB
IP Story Protocol

Create Collection (Idempotent)

Create a new collection with a pre-computed id, or get an existing one if the id already exists

API scope required: collections.create

post/v1/ip/collections

Headers

X-API-KEYstring required

API key required for authentication

Request body

reuploadLinkedFilesboolean

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.

chainstring required

The chain of the collection

supplyLimitnumber

The supply limit of the collection

Example request

{
  "reuploadLinkedFiles": true,
  "metadata": {
    "name": "My Collection",
    "symbol": "MYCOL",
    "description": "My Collection Description",
    "image": "https://example.com/image.png"
  },
  "chain": "story-testnet",
  "supplyLimit": 100
}

Response

Collection created

idstring required

The id of the collection

actionIdstring required

The action id of the collection

Example response

{
  "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "actionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "metadata": {
    "name": "My Collection",
    "symbol": "MYCOL",
    "description": "My Collection Description",
    "image": "https://example.com/image.png"
  },
  "onChain": {
    "chain": "story-testnet",
    "contractAddress": "0x123",
    "explorerLink": "https://portal.story.foundation/collections/0xAC6062FF53fa41e61Fe01B89B83d9dB96b5F9280"
  }
}