fyi.opensocial.applyLabel Documentation (EN)

main procedure

Write a label record into the subject's space. Requires label, or takedown for !hide and !takedown.

Input

Encodingapplication/json

group stringdid Required

The group DID. Every method is served by the group's host and authorized against that group's roles.

rule stringat-uri Optional

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

subject union Required

No description available.

val string Required

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.

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

{
  "description": "Write a label record into the subject's space. Requires label, or takedown for !hide and !takedown.",
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "group": {
          "description": "The group DID. Every method is served by the group's host and authorized against that group's roles.",
          "format": "did",
          "type": "string"
        },
        "rule": {
          "format": "at-uri",
          "type": "string"
        },
        "subject": {
          "refs": [
            "com.atproto.admin.defs#repoRef",
            "com.atproto.repo.strongRef"
          ],
          "type": "union"
        },
        "val": {
          "type": "string"
        }
      },
      "required": [
        "group",
        "subject",
        "val"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cid": {
          "format": "cid",
          "type": "string"
        },
        "uri": {
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "cid"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}