blue.rito.service.getSchema Documentation (EN)

main procedure

Get Bookmark by NSID, including schema, OGP, tags, moderation, and comments.

Input

Encodingapplication/json

nsid string Required

No description available.

Output

Encodingapplication/json

comments array Required

Comments with titles, content, and moderation in multiple languages.

moderations array Required

Moderation result for OGP title and description

nsid string Required

Namespace ID of the service or application (e.g., 'uk.skyblur.post').

ogpDescription string Optional

The Open Graph Protocol (OGP) description for the bookmark.

ogpImage stringuri Optional

The Open Graph Protocol (OGP) image URL for the bookmark.

ogpTitle string Optional

The Open Graph Protocol (OGP) title for the bookmark.

schema string Required

The schema URL pattern associated with this NSID (e.g., 'https://skyblur.uk/post/{did}/{rkey}').

tags array Optional

This field contains tags. If registered by the owner, it may include 'Verified'.

verified boolean Required

If this comment registed by owner, this field should be true.

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": [
        "nsid"
      ],
      "properties": {
        "nsid": {
          "type": "string"
        }
      }
    },
    "encoding": "application/json"
  },
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "nsid",
        "schema",
        "moderations",
        "comments",
        "verified"
      ],
      "properties": {
        "nsid": {
          "type": "string",
          "description": "Namespace ID of the service or application (e.g., 'uk.skyblur.post')."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "This field contains tags. If registered by the owner, it may include 'Verified'."
        },
        "schema": {
          "type": "string",
          "description": "The schema URL pattern associated with this NSID (e.g., 'https://skyblur.uk/post/{did}/{rkey}')."
        },
        "comments": {
          "type": "array",
          "items": {
            "ref": "blue.rito.service.getSchema#langs",
            "type": "ref"
          },
          "description": "Comments with titles, content, and moderation in multiple languages."
        },
        "ogpImage": {
          "type": "string",
          "format": "uri",
          "description": "The Open Graph Protocol (OGP) image URL for the bookmark."
        },
        "ogpTitle": {
          "type": "string",
          "description": "The Open Graph Protocol (OGP) title for the bookmark."
        },
        "verified": {
          "type": "boolean",
          "description": "If this comment registed by owner, this field should be true."
        },
        "moderations": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Moderation result for OGP title and description"
        },
        "ogpDescription": {
          "type": "string",
          "description": "The Open Graph Protocol (OGP) description for the bookmark."
        }
      }
    },
    "encoding": "application/json",
    "description": "Returns the Bookmark data for the given NSID."
  },
  "description": "Get Bookmark by NSID, including schema, OGP, tags, moderation, and comments."
}

langs object

No description available.

Properties

comment string Optional

No description available.

lang string Required

No description available.

moderation array of string Required

No description available.

title string Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "lang",
    "title",
    "moderation"
  ],
  "properties": {
    "lang": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "comment": {
      "type": "string"
    },
    "moderation": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}