pub.chive.sync.indexRecord Documentation (EN)

main procedure

Index a record from PDS (owner or admin only)

Input

Encodingapplication/json

uri stringat-uri Required

AT-URI of the record to index

Output

Encodingapplication/json

cid stringcid Optional

CID of the indexed record (if successful)

error string Optional

Error message (if failed)

indexed boolean Required

Whether indexing succeeded

uri stringat-uri Required

AT-URI of the indexed record

Errors

InvalidRequest

AuthenticationRequired

NotFound

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": "Index a record from PDS (owner or admin only)",
  "errors": [
    {
      "name": "InvalidRequest"
    },
    {
      "name": "AuthenticationRequired"
    },
    {
      "name": "NotFound"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "uri": {
          "description": "AT-URI of the record to index",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cid": {
          "description": "CID of the indexed record (if successful)",
          "format": "cid",
          "type": "string"
        },
        "error": {
          "description": "Error message (if failed)",
          "type": "string"
        },
        "indexed": {
          "description": "Whether indexing succeeded",
          "type": "boolean"
        },
        "uri": {
          "description": "AT-URI of the indexed record",
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "indexed"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}