pub.chive.graph.getRelations Documentation (EN)

main query

List available relation types (nodes with subkind=relation)

Output

Encodingapplication/json

relations array Required

Available relation types

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://api.bsky.social)

View raw schema

{
  "description": "List available relation types (nodes with subkind=relation)",
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "relations": {
          "description": "Available relation types",
          "items": {
            "ref": "#relationType",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "relations"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {},
    "type": "params"
  },
  "type": "query"
}

relationType object

Relation type definition

Properties

description string Optional

Relation description

inverseSlug string Optional

Slug of inverse relation

label string Required

Display label

slug string Required

Relation slug identifier

View raw schema

{
  "description": "Relation type definition",
  "properties": {
    "description": {
      "description": "Relation description",
      "type": "string"
    },
    "inverseSlug": {
      "description": "Slug of inverse relation",
      "type": "string"
    },
    "label": {
      "description": "Display label",
      "type": "string"
    },
    "slug": {
      "description": "Relation slug identifier",
      "type": "string"
    }
  },
  "required": [
    "slug",
    "label"
  ],
  "type": "object"
}