This is still a work in progress and it may be subject to change.
​
category
string
required

Defines part of the metadata type associated with the IP being registered. For example: registering data from TikTok, the category could be set as Social.

​
source
string
required

Specifies the data source of the IP. This is often the name of the platform whose url is being provided. For example: TikTok.

​
url
url_string
required

URL of the TLS session the data is originated from. This must adhere to the hostname for the source server, it can be found in the data providers section at the dev portal. For example: for TikTok, the hostname could be api.tiktok.com.

​
name
string
required

Name of the IP being registered. This should be specified by the user and will be used as the name of both the SPG_NFT that will be minted on Story.

​
address
hex_string
required

EVM wallet address of the IP owner. This is who the SPG_NFT will be minted to. This address must be a valid EVM wallet address appended with the 0x prefix.

​
app_id
string
required

Identifier of the application registering the IP. It can be derived from the dev portal and is paired alongside the app_secret for authenticated access to the network.

​
Examples

Here are some examples schemas to get you started:

{
  "category": "Social",
  "source": "TikTok",
  "url": "api.twitter.com",
  "name": "Test",
  "address": "0x0000000000000000000000000000000000000000",
  "metadata": {
    "property": {
      "key": "test",
      "description": "test desc",
      "mime": "text/plain",
      "tags": ["test"],
      "type": "url"
    },
    "owner": "test_owner"
  },
  "app_id": "ap3sd1234567890"
}