world.ptah.trace Documentation (EN)

main record

Tracks lineage between works. The paper trail from one work to another — cover, remix, adaptation, translation, sample, and more.

Record Key tid Timestamp-based ID

Properties

clearanceStatus string Optional

Whether rights clearance has been obtained

Known values: cleared, pending, disputed, notRequired

createdAt string datetime Required

Timestamp when this trace was created

creatorDID string did Required

The permanent identity of the trace record's creator

derivedWork string at-uri Required

Reference to the work that came from the source

description string Optional

Context about the relationship

maxLength: 10240 bytesmaxGraphemes: 1024 graphemes

relationship string Required

The type of relationship between the works

Known values: cover, remix, adaptation, translation, sample, interpolation, response, sequel, spinoff, excerpt, remake, fork

sourceWork string at-uri Required

Reference to the original work

worldReference string at-uri Required

Reference to the world this trace belongs to

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "creatorDID",
      "worldReference",
      "createdAt",
      "sourceWork",
      "derivedWork",
      "relationship"
    ],
    "properties": {
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp when this trace was created"
      },
      "creatorDID": {
        "type": "string",
        "format": "did",
        "description": "The permanent identity of the trace record's creator"
      },
      "sourceWork": {
        "type": "string",
        "format": "at-uri",
        "description": "Reference to the original work"
      },
      "derivedWork": {
        "type": "string",
        "format": "at-uri",
        "description": "Reference to the work that came from the source"
      },
      "description": {
        "type": "string",
        "maxLength": 10240,
        "description": "Context about the relationship",
        "maxGraphemes": 1024
      },
      "relationship": {
        "type": "string",
        "description": "The type of relationship between the works",
        "knownValues": [
          "cover",
          "remix",
          "adaptation",
          "translation",
          "sample",
          "interpolation",
          "response",
          "sequel",
          "spinoff",
          "excerpt",
          "remake",
          "fork"
        ]
      },
      "worldReference": {
        "type": "string",
        "format": "at-uri",
        "description": "Reference to the world this trace belongs to"
      },
      "clearanceStatus": {
        "type": "string",
        "description": "Whether rights clearance has been obtained",
        "knownValues": [
          "cleared",
          "pending",
          "disputed",
          "notRequired"
        ]
      }
    }
  },
  "description": "Tracks lineage between works. The paper trail from one work to another — cover, remix, adaptation, translation, sample, and more."
}