Reference · Type registry

pub.techne.draft.registry.getType

query · GETIn the SDK, techne.platform.pub.techne.draft.registry.getType

One record type the platform knows: a platform type, a community draft or a requested foreign type, with its lexicon, query roles, creator, state, record count and sidecars.

Public. The answer carries the type's techne.pub page; share it.

Input query parameters

NameTypeWhat it is
nsidrequirednsid

Output application/json · typeView

NameTypeWhat it is
nsidrequirednsid
namerequiredstringThe NSID's last segment, which is how the type reads.
descriptionstringThe lexicon's own description of its main def (else of the document), as written: its length is the lexicon's.
originrequiredstringplatform: a type the platform ships. community: a draft someone published, pub.techne.draft.c.<id>.<name>. requested: a type defined elsewhere on the network that someone asked the platform to index. One of platform, community, requested.
staterequiredstringindexed: a platform or community type, or an approved request. An approved request's existing records are read from the network (a walk of its history) from the approval on; its new writes on the network reach the platform once a release adds the type to what the platform subscribes to, and until then only those written through the platform arrive. pending: a request not yet decided; only records written through the platform are indexed. declined: an operator declined the request; it stays as pending does. blocked: an operator stopped indexing it. One of indexed, pending, declined, blocked.
creatordidWho published a community type, or who requested a foreign one. Only the creator may change a community type.
sidecarOfnsidThe type this one extends: its records carry a subject naming a record of that type.
forkOfnsidThe community type this one was forked from.
recordCountrequiredintegerPublic records of this type the platform holds now.
pagerequireduriThe type's page on techne.pub. Share it with the person you are working with.
lexiconrequiredobjectThe type's current lexicon document.
queryobjectThe type's {nsid}.query document: which fields fill the shared query roles (the time, the place, the text, the references). Absent when the type has none; its records can then only be got and listed.
versionintegerA community or requested type's version. A community type's is 1 at its first publish and one more at each additive change; a requested type's is 1. Absent for a platform type.
schemastrongRefThe com.atproto.lexicon.schema record this lexicon is published as (in the registry's repo for a community type, in its authority's repo for a foreign one).
sidecarsnsid[]Types that extend this one, most used first.
requestrequestViewFor a requested type, its request.
createdAtdatetime
updatedAtdatetime

Errors: UnknownType (The platform does not know this type. A type defined elsewhere can be asked for with pub.techne.draft.registry.requestType). The full lexicon is at getType.registry.draft.techne.pub.

requestView A request to index a type defined elsewhere on the network.

NameTypeWhat it is
nsidrequirednsid
requesterrequireddid
staterequiredstringpending until an operator decides. approved: an operator's live commons credential pinned this request's CID when the platform read it; the approval stands after that, even if the credential is later withdrawn (only a block, registry.purgeType, ends it). Approval starts a walk of the type's existing records on the network; its new writes there reach the platform once a release adds the type to what the platform subscribes to. declined: an operator declined it; records written through the platform are still indexed. blocked: an operator stopped indexing the type (registry.purgeType); nothing of it is indexed, and an approval or a decline no longer changes that. One of pending, approved, declined, blocked.
urirequiredat-uriThe pub.techne.draft.registry.typeRequest record, in the registry's repo.
cidrequiredcidIts CID, which an approval pins.
queryobjectThe query roles the requester mapped, as a {nsid}.query document.
previewpreview
decidedBydidThe operator who approved or declined it.
decidedAtdatetime
decisionat-uriThe record that decided it: the approving credential or the declining verdict.
createdAtrequireddatetime
pagerequireduriThe type's page on techne.pub.

preview What indexing a foreign type would take on, read when it was requested: where its schema is published and how big it is on the network.

NameTypeWhat it is
schemarequiredstrongRefThe com.atproto.lexicon.schema record its NSID authority's _lexicon TXT record led to.
schemaCreatedAtdatetimeWhen that schema record was first written, as far as the platform can tell.
fieldsrequiredstring[]The main record's top-level fields, each as name: type.
reposintegerAccounts the relay lists as holding records of it (com.atproto.sync.listReposByCollection), counted up to a ceiling.
reposCappedbooleanWhether repos stopped at the ceiling.
sampledRecordsintegerRecords read from a sample of those accounts.
sampledValidintegerHow many of the sampled records satisfy the schema.
estimatedRecordsintegerRecords of it on the network, estimated from the sample.
readAtdatetime
One type, with its lexicon and query roles

The SDK's generated client has every platform method on techne.platform, typed from its lexicon. The call goes through the user's PDS, which signs it for the platform.

One type, with its lexicon and query roles
What comes back

Public: no session needed. Every answer carries page, the type’s techne.pub page; share it.