fyi.opensocial.createGroup

lexicons.opensocial.fyi

Documentation

Host-level: create a new group on this host. Authenticated as the founder (service auth from their PDS). The founder and any listed stewards become its first admins. Mints the group DID, creates the meta and members spaces, writes the bootstrap records and, for a discoverable group, a declaration. Modality spaces are left to the apps that use them (createSpace).

main procedure

Host-level: create a new group on this host. Authenticated as the founder (service auth from their PDS). The founder and any listed stewards become its first admins. Mints the group DID, creates the meta and members spaces, writes the bootstrap records and, for a discoverable group, a declaration. Modality spaces are left to the apps that use them (createSpace).

Input

Encodingapplication/json
description string Optional

No description available.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
displayName string Required

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
handle stringhandle Required

An AT Protocol handle (e.g., alice.bsky.social).

joinPolicy string Optional

No description available.

metaReadableBy array Optional

Defaults to ['public'].

stewards array Optional

Accounts that run the group alongside the founder, as admins from the start.

Output

Encodingapplication/json
did stringdid Required

A decentralized identifier (DID).

members stringspace-ref Required

No description available.

meta stringspace-ref Required

No description available.

Errors

HandleTaken
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 
{
  "description": "Host-level: create a new group on this host. Authenticated as the founder (service auth from their PDS). The founder and any listed stewards become its first admins. Mints the group DID, creates the meta and members spaces, writes the bootstrap records and, for a discoverable group, a declaration. Modality spaces are left to the apps that use them (createSpace).",
  "errors": [
    {
      "name": "HandleTaken"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "description": {
          "maxGraphemes": 300,
          "maxLength": 3000,
          "type": "string"
        },
        "displayName": {
          "maxGraphemes": 64,
          "maxLength": 640,
          "type": "string"
        },
        "handle": {
          "format": "handle",
          "type": "string"
        },
        "joinPolicy": {
          "knownValues": [
            "fyi.opensocial.profile#open",
            "fyi.opensocial.profile#request",
            "fyi.opensocial.profile#invite"
          ],
          "type": "string"
        },
        "metaReadableBy": {
          "description": "Defaults to ['public'].",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "stewards": {
          "description": "Accounts that run the group alongside the founder, as admins from the start.",
          "items": {
            "format": "did",
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "handle",
        "displayName"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "did": {
          "format": "did",
          "type": "string"
        },
        "members": {
          "format": "space-ref",
          "type": "string"
        },
        "meta": {
          "format": "space-ref",
          "type": "string"
        }
      },
      "required": [
        "did",
        "meta",
        "members"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@