net.atpix.gallery.createAlbum

lexicon.atpix.net

Documentation

Create an album. When visibility is permissioned, provisions a HappyView space (type net.atpix.gallery.albumSpace) and links spaceUri.

main procedure

Create an album. When visibility is permissioned, provisions a HappyView space (type net.atpix.gallery.albumSpace) and links spaceUri.

Input

Encodingapplication/json
collectionRuleUris array Optional

No description available.

maxLength: 20 items
description string Optional

No description available.

maxLength: 5000 bytes
name string Required

No description available.

maxLength: 200 bytes
seedFromRules boolean Optional

When true, evaluate linked collectionRuleUris and create initial albumItem records.

spaceKey string Optional

No description available.

maxLength: 64 bytes

Output

Encodingapplication/json
cid stringcid Required

A content identifier (CID) referencing immutable data.

spaceUri string Optional

No description available.

uri stringat-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "name",
        "visibility"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 200
        },
        "spaceKey": {
          "type": "string",
          "maxLength": 64
        },
        "visibility": {
          "ref": "net.atpix.gallery.defs#visibility",
          "type": "ref"
        },
        "description": {
          "type": "string",
          "maxLength": 5000
        },
        "seedFromRules": {
          "type": "boolean",
          "default": false,
          "description": "When true, evaluate linked collectionRuleUris and create initial albumItem records."
        },
        "collectionRuleUris": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "at-uri"
          },
          "maxLength": 20
        }
      }
    },
    "encoding": "application/json"
  },
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "cid"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid"
        },
        "uri": {
          "type": "string",
          "format": "at-uri"
        },
        "spaceUri": {
          "type": "string",
          "maxLength": 512
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Create an album. When visibility is permissioned, provisions a HappyView space (type net.atpix.gallery.albumSpace) and links spaceUri."
}

Lexicon Garden

@