pub.chive.backlink.create

chive.pub

Documentation

Create a backlink record. Internal/plugin use only. Requires authentication.

main procedure

Create a backlink record. Internal/plugin use only. Requires authentication.

Input

Encodingapplication/json
context string Optional

Optional context about the backlink

maxLength: 500 bytes
sourceType string Required

Type of the source record

sourceUri stringat-uri Required

AT-URI of the source record

targetUri stringat-uri Required

AT-URI of the target eprint

Output

Encodingapplication/json
Schema#backlink

Errors

AuthenticationRequired
InvalidRequest
Try It

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

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "sourceUri",
        "sourceType",
        "targetUri"
      ],
      "properties": {
        "context": {
          "type": "string",
          "maxLength": 500,
          "description": "Optional context about the backlink"
        },
        "sourceUri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the source record"
        },
        "targetUri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the target eprint"
        },
        "sourceType": {
          "type": "string",
          "description": "Type of the source record",
          "knownValues": [
            "cosmik.collection",
            "leaflet.list",
            "whitewind.blog",
            "bluesky.post",
            "bluesky.embed",
            "other"
          ]
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "InvalidRequest"
    }
  ],
  "output": {
    "schema": {
      "ref": "#backlink",
      "type": "ref"
    },
    "encoding": "application/json"
  },
  "description": "Create a backlink record. Internal/plugin use only. Requires authentication."
}
backlink object

Backlink record

Properties

context string Optional

Optional context about the backlink

maxLength: 500 bytes
deleted boolean Required

Whether the backlink has been deleted

id integer Required

Backlink ID

indexedAt string datetime Required

Timestamp when the backlink was indexed

sourceType string Required

Type of the source record

Known values: cosmik.collection, leaflet.list, whitewind.blog, bluesky.post, bluesky.embed, other
sourceUri string at-uri Required

AT-URI of the source record

targetUri string at-uri Required

AT-URI of the target eprint

View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "sourceUri",
    "sourceType",
    "targetUri",
    "indexedAt",
    "deleted"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "Backlink ID"
    },
    "context": {
      "type": "string",
      "maxLength": 500,
      "description": "Optional context about the backlink"
    },
    "deleted": {
      "type": "boolean",
      "description": "Whether the backlink has been deleted"
    },
    "indexedAt": {
      "type": "string",
      "format": "datetime",
      "description": "Timestamp when the backlink was indexed"
    },
    "sourceUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the source record"
    },
    "targetUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT-URI of the target eprint"
    },
    "sourceType": {
      "type": "string",
      "description": "Type of the source record",
      "knownValues": [
        "cosmik.collection",
        "leaflet.list",
        "whitewind.blog",
        "bluesky.post",
        "bluesky.embed",
        "other"
      ]
    }
  },
  "description": "Backlink record"
}

Lexicon Garden

@