# world.ptah.collection

> Published by [ptah.world](https://lexicon.garden/identity/did:plc:l45z35sxxjuobp5q65a5vu22)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:l45z35sxxjuobp5q65a5vu22/world.ptah.collection)
- [Documentation](https://lexicon.garden/lexicon/did:plc:l45z35sxxjuobp5q65a5vu22/world.ptah.collection/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:l45z35sxxjuobp5q65a5vu22/world.ptah.collection/examples)

## Definitions

### `world.ptah.collection`

**Type**: `record`

Bundles multiple works together. An album, anthology, season, or any curated set of related works.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes | The name of the collection |
| `items` | `array` | Yes | References to the works in this collection |
| `ordering` | `string` | No | How items in this collection are ordered |
| `createdAt` | `string` (datetime) | Yes | Timestamp when this collection was created |
| `coverImage` | `blob` | No | Cover artwork for the collection |
| `creatorDID` | `string` (did) | Yes | The permanent identity of the collection's creator |
| `description` | `string` | No | What this collection is about |
| `worldReference` | `string` (at-uri) | Yes | Reference to the world this collection belongs to |
| `canonicalStatus` | `string` | No | The canonical standing of this collection |

## Raw Schema

```json
{
  "id": "world.ptah.collection",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "name",
          "creatorDID",
          "worldReference",
          "createdAt",
          "items"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 640,
            "description": "The name of the collection",
            "maxGraphemes": 64
          },
          "items": {
            "type": "array",
            "items": {
              "type": "string",
              "format": "at-uri"
            },
            "description": "References to the works in this collection"
          },
          "ordering": {
            "type": "string",
            "description": "How items in this collection are ordered",
            "knownValues": [
              "sequential",
              "unordered",
              "chronological"
            ]
          },
          "createdAt": {
            "type": "string",
            "format": "datetime",
            "description": "Timestamp when this collection was created"
          },
          "coverImage": {
            "type": "blob",
            "accept": [
              "image/png",
              "image/jpeg",
              "image/webp"
            ],
            "maxSize": 1000000,
            "description": "Cover artwork for the collection"
          },
          "creatorDID": {
            "type": "string",
            "format": "did",
            "description": "The permanent identity of the collection's creator"
          },
          "description": {
            "type": "string",
            "maxLength": 10240,
            "description": "What this collection is about",
            "maxGraphemes": 1024
          },
          "worldReference": {
            "type": "string",
            "format": "at-uri",
            "description": "Reference to the world this collection belongs to"
          },
          "canonicalStatus": {
            "type": "string",
            "description": "The canonical standing of this collection",
            "knownValues": [
              "world.ptah.defs#canonicalStatusOfficial",
              "world.ptah.defs#canonicalStatusCommunity",
              "world.ptah.defs#canonicalStatusApocryphal"
            ]
          }
        }
      },
      "description": "Bundles multiple works together. An album, anthology, season, or any curated set of related works."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```