blue.microcosm.repo.getRecordByUri

microcosm.blue

Documentation

Get a single record from a repository by at-uri

main query

Get a single record from a repository by at-uri

Parameters

at_uri string at-uri Required

The at-uri of the record. The identifier can be a DID or an atproto handle. The collection and rkey segments must be present.

cid string cid Optional

The CID of the version of the record. If not specified, then return the most recent version. If specified and a newer version of the record exists, returns 404 not found.

Output

Encodingapplication/json
cid stringcid Optional

A content identifier (CID) referencing immutable data.

uri stringat-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

value unknown Required

No description available.

Errors

RecordNotFound
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://api.bsky.social)
Parameters
The at-uri of the record. The identifier can be a DID or an atproto handle. The collection and rkey segments must be present.
The CID of the version of the record. If not specified, then return the most recent version. If specified and a newer version of the record exists, returns 404 not found.
View raw schema
{
  "type": "query",
  "errors": [
    {
      "name": "RecordNotFound"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "value"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "format": "cid"
        },
        "uri": {
          "type": "string",
          "format": "at-uri"
        },
        "value": {
          "type": "unknown"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "at_uri"
    ],
    "properties": {
      "cid": {
        "type": "string",
        "format": "cid",
        "description": "The CID of the version of the record. If not specified, then return the most recent version. If specified and a newer version of the record exists, returns 404 not found."
      },
      "at_uri": {
        "type": "string",
        "format": "at-uri",
        "description": "The at-uri of the record. The identifier can be a DID or an atproto handle. The collection and rkey segments must be present."
      }
    }
  },
  "description": "Get a single record from a repository by at-uri"
}

Lexicon Garden

@