world.ptah.usage Documentation (EN)

main record

Terms and permissions for a work. What's allowed, where, for how long, and under what conditions.

Record Key tid Timestamp-based ID

Properties

allowCommercial boolean Optional

Whether commercial use is permitted

allowDerivatives boolean Optional

Whether derivative works are permitted

allowPerformance boolean Optional

Whether public performance is permitted

createdAt string datetime Required

Timestamp when this usage record was created

creatorDID string did Required

The permanent identity of the usage record's creator

licenseType string Optional

The type of license

Known values: allRightsReserved, creativeCommons, publicDomain, custom

requireAttribution boolean Optional

Whether attribution is required

terms string Optional

Human-readable terms description

maxLength: 10240 bytesmaxGraphemes: 1024 graphemes

territories array of string Optional

Geographic territories where these terms apply (empty = worldwide)

validUntil string datetime Optional

When these terms expire (empty = perpetual)

workReference string at-uri Required

Reference to the work these terms apply to

worldReference string at-uri Required

Reference to the world this usage record belongs to

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "creatorDID",
      "worldReference",
      "createdAt",
      "workReference"
    ],
    "properties": {
      "terms": {
        "type": "string",
        "maxLength": 10240,
        "description": "Human-readable terms description",
        "maxGraphemes": 1024
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp when this usage record was created"
      },
      "creatorDID": {
        "type": "string",
        "format": "did",
        "description": "The permanent identity of the usage record's creator"
      },
      "validUntil": {
        "type": "string",
        "format": "datetime",
        "description": "When these terms expire (empty = perpetual)"
      },
      "licenseType": {
        "type": "string",
        "description": "The type of license",
        "knownValues": [
          "allRightsReserved",
          "creativeCommons",
          "publicDomain",
          "custom"
        ]
      },
      "territories": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 128
        },
        "description": "Geographic territories where these terms apply (empty = worldwide)"
      },
      "workReference": {
        "type": "string",
        "format": "at-uri",
        "description": "Reference to the work these terms apply to"
      },
      "worldReference": {
        "type": "string",
        "format": "at-uri",
        "description": "Reference to the world this usage record belongs to"
      },
      "allowCommercial": {
        "type": "boolean",
        "description": "Whether commercial use is permitted"
      },
      "allowDerivatives": {
        "type": "boolean",
        "description": "Whether derivative works are permitted"
      },
      "allowPerformance": {
        "type": "boolean",
        "description": "Whether public performance is permitted"
      },
      "requireAttribution": {
        "type": "boolean",
        "description": "Whether attribution is required"
      }
    }
  },
  "description": "Terms and permissions for a work. What's allowed, where, for how long, and under what conditions."
}