social.colibri.community.create

Documentation

Creates a community, bootstrapping its DID repo with a default category, channel, owner role, and member record.

main procedure

Creates a community, bootstrapping its DID repo with a default category, channel, owner role, and member record.

Parameters

description string Optional

No description available.

identifier string Optional

Bring-your-own DID or handle.

name string Required

No description available.

password string Optional

Bring-your-own account password.

pds string Optional

Bring-your-own PDS endpoint.

requiresApprovalToJoin boolean Optional

No description available.

Input

Encodingmultipart/form-data

Accepts raw binary data

Output

Encodingapplication/json

category stringat-uri Required

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

channel stringat-uri Required

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

community stringat-uri Required

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

did stringdid Required

A decentralized identifier (DID).

member stringat-uri Required

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

ownerRole stringat-uri Required

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

Errors

AuthRequired Missing, malformed, or unverifiable service auth.

InvalidRequest A parameter or body field was missing or malformed.

PdsUnavailable The PDS this operation needs is unreachable or is not a PDS.

UpstreamFailure A service outside this AppView failed.

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "encoding": "multipart/form-data",
    "description": "Optional community image blobs, as `picture` and `banner` parts."
  },
  "errors": [
    {
      "name": "AuthRequired",
      "description": "Missing, malformed, or unverifiable service auth."
    },
    {
      "name": "InvalidRequest",
      "description": "A parameter or body field was missing or malformed."
    },
    {
      "name": "PdsUnavailable",
      "description": "The PDS this operation needs is unreachable or is not a PDS."
    },
    {
      "name": "UpstreamFailure",
      "description": "A service outside this AppView failed."
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "did",
        "community",
        "category",
        "channel",
        "ownerRole",
        "member"
      ],
      "properties": {
        "did": {
          "type": "string",
          "format": "did"
        },
        "member": {
          "type": "string",
          "format": "at-uri"
        },
        "channel": {
          "type": "string",
          "format": "at-uri"
        },
        "category": {
          "type": "string",
          "format": "at-uri"
        },
        "community": {
          "type": "string",
          "format": "at-uri"
        },
        "ownerRole": {
          "type": "string",
          "format": "at-uri"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "name"
    ],
    "properties": {
      "pds": {
        "type": "string",
        "description": "Bring-your-own PDS endpoint."
      },
      "name": {
        "type": "string"
      },
      "password": {
        "type": "string",
        "description": "Bring-your-own account password."
      },
      "identifier": {
        "type": "string",
        "description": "Bring-your-own DID or handle."
      },
      "description": {
        "type": "string"
      },
      "requiresApprovalToJoin": {
        "type": "boolean"
      }
    }
  },
  "description": "Creates a community, bootstrapping its DID repo with a default category, channel, owner role, and member record."
}