science.alt.dataset.resolveSchema Documentation (EN)

main query

Resolve a schema by its permanent NSID identifier. When version is omitted, resolves to the most recently created schema with the given NSID.

Parameters

handle string Required

DID or handle of the schema owner

schemaId string Required

The permanent NSID identifier for the schema (the {NSID} part of the rkey {NSID}@{semver})

version string Optional

Specific version to resolve. If omitted, resolves to latest.

Output

Encodingapplication/json

cid string Required

CID of the resolved schema record

record refscience.alt.dataset.schema Required

The full schema record

uri stringat-uri Required

AT-URI of the resolved schema record

Errors

SchemaNotFound No schema found with the given NSID

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)

Parameters

handle * DID or handle of the schema owner

schemaId * The permanent NSID identifier for the schema (the {NSID} part of the rkey {NSID}@{semver})

version Specific version to resolve. If omitted, resolves to latest.

View raw schema

{
  "type": "query",
  "errors": [
    {
      "name": "SchemaNotFound",
      "description": "No schema found with the given NSID"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "uri",
        "cid",
        "record"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "description": "CID of the resolved schema record"
        },
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT-URI of the resolved schema record"
        },
        "record": {
          "ref": "science.alt.dataset.schema",
          "type": "ref",
          "description": "The full schema record"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "handle",
      "schemaId"
    ],
    "properties": {
      "handle": {
        "type": "string",
        "description": "DID or handle of the schema owner"
      },
      "version": {
        "type": "string",
        "maxLength": 20,
        "description": "Specific version to resolve. If omitted, resolves to latest."
      },
      "schemaId": {
        "type": "string",
        "maxLength": 500,
        "description": "The permanent NSID identifier for the schema (the {NSID} part of the rkey {NSID}@{semver})"
      }
    }
  },
  "description": "Resolve a schema by its permanent NSID identifier. When version is omitted, resolves to the most recently created schema with the given NSID."
}