pub.chive.moderation.createReport Documentation (EN)

main procedure

Report content for moderation review. Requires authentication. Duplicate reports from the same user for the same content are idempotent.

Input

Encodingapplication/json

description string Optional

Optional additional details about the report

maxLength: 2000 bytes

reason string Required

Reason for reporting

targetCollection string Required

Collection NSID of the target content

targetUri stringat-uri Required

AT-URI of the content to report

Output

Encodingapplication/json

id integer Required

Report ID

success boolean Required

Whether the report was created

Errors

AuthenticationRequired

InvalidRequest

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": {
    "schema": {
      "type": "object",
      "required": [
        "targetUri",
        "targetCollection",
        "reason"
      ],
      "properties": {
        "reason": {
          "type": "string",
          "description": "Reason for reporting",
          "knownValues": [
            "spam",
            "inappropriate",
            "copyright",
            "misinformation",
            "other"
          ]
        },
        "targetUri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the content to report"
        },
        "description": {
          "type": "string",
          "maxLength": 2000,
          "description": "Optional additional details about the report"
        },
        "targetCollection": {
          "type": "string",
          "description": "Collection NSID of the target content"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "InvalidRequest"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "success",
        "id"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "description": "Report ID"
        },
        "success": {
          "type": "boolean",
          "description": "Whether the report was created"
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Report content for moderation review. Requires authentication. Duplicate reports from the same user for the same content are idempotent."
}