net.atpix.gallery.createCollectionRule

lexicon.atpix.net

Documentation

Create a collection rule for follow-graph and/or hashtag sourcing.

main procedure

Create a collection rule for follow-graph and/or hashtag sourcing.

Input

Encodingapplication/json
active boolean Optional

No description available.

description string Optional

No description available.

maxLength: 2000 bytes
followedActors array Optional

No description available.

maxLength: 500 items
hashtags array Optional

No description available.

maxLength: 50 items
includeOwnPhotos boolean Optional

No description available.

name string Required

No description available.

maxLength: 200 bytes
targetAlbumUri stringat-uri Optional

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

useFollowGraph boolean Optional

No description available.

Output

Encodingapplication/json
cid stringcid Required

A content identifier (CID) referencing immutable data.

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",
        "targetScope"
      ],
      "properties": {
        "name": {
          "type": "string",
          "maxLength": 200
        },
        "active": {
          "type": "boolean",
          "default": true
        },
        "hashtags": {
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 64
          },
          "maxLength": 50
        },
        "description": {
          "type": "string",
          "maxLength": 2000
        },
        "targetScope": {
          "ref": "net.atpix.gallery.defs#targetScope",
          "type": "ref"
        },
        "followedActors": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "did"
          },
          "maxLength": 500
        },
        "targetAlbumUri": {
          "type": "string",
          "format": "at-uri"
        },
        "useFollowGraph": {
          "type": "boolean",
          "default": false
        },
        "includeOwnPhotos": {
          "type": "boolean",
          "default": true
        }
      }
    },
    "encoding": "application/json"
  },
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "cid"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid"
        },
        "uri": {
          "type": "string",
          "format": "at-uri"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Create a collection rule for follow-graph and/or hashtag sourcing."
}

Lexicon Garden

@