Every method
Every method an app calls, on one page, grouped by task: what it does and the scope it needs. Techne’s methods (pub.techne.draft.*) and the AT Protocol’s (com.atproto.*, served by the person’s PDS) sit side by side; each row names its NSID.
The list is made from the lexicons when the site is built. The SDK’s own calls and components are on the left.
Write and read records · Query · Type registry · Sync · Auth and moderation · Accounts and identity
Write and read records 13
Public records go to the person's own PDS with com.atproto.repo.*; private records go into a space with permissioned.*, where every write names its space and each read answers only what the caller may read.
| Method | Kind | What it does | Scope it needs |
|---|---|---|---|
repo.putRecordcom.atproto.repo.putRecord | procedure | Write a repository record, creating or updating it as needed. | repo:<collection> (the SDK's types) |
repo.createRecordcom.atproto.repo.createRecord | procedure | Create a single new repository record. | repo:<collection> (the SDK's types) |
repo.deleteRecordcom.atproto.repo.deleteRecord | procedure | Delete a repository record, or ensure it doesn't exist. | repo:<collection> (the SDK's types) |
repo.applyWritescom.atproto.repo.applyWrites | procedure | Apply a batch transaction of repository creates, updates, and deletes. | repo:<collection> for each collection it writes |
repo.getRecordcom.atproto.repo.getRecord | query | Get a single record from a repository. | None: public, no sign-in |
repo.listRecordscom.atproto.repo.listRecords | query | List a range of records in a repository, matching a specific collection. | None: public, no sign-in |
permissioned.putRecordpub.techne.draft.permissioned.putRecord | procedure | Write one record into your own repo (or a collective's or circle's whose own member space you manage) as a permissioned record, for the space it names (required: no space is InvalidRequest; public records go through com.atproto.repo.putRecord, and a record only you read goes in your space.personal). | Signed in: rpc:pub.techne.draft.permissioned.putRecord, or the authPermissioned set |
permissioned.putRecordspub.techne.draft.permissioned.putRecords | procedure | Up to 200 putRecord writes, applied in order, each in its own transaction, for one write of your rate. | Signed in: rpc:pub.techne.draft.permissioned.putRecords, or the authPermissioned or authWrite set |
permissioned.deleteRecordpub.techne.draft.permissioned.deleteRecord | procedure | Delete one of your own permissioned records (or a collective's or circle's whose own member space you manage). | Signed in: rpc:pub.techne.draft.permissioned.deleteRecord, or the authPermissioned set |
permissioned.getRecordpub.techne.draft.permissioned.getRecord | query | Read one permissioned record. | Signed in: rpc:pub.techne.draft.permissioned.getRecord, or the authPermissioned set |
permissioned.listRecordspub.techne.draft.permissioned.listRecords | query | List one repo's current permissioned records in one collection that the caller may read, in ascending record key order (there is no reverse). | Signed in: rpc:pub.techne.draft.permissioned.listRecords, or the authPermissioned or authWrite set |
permissioned.listChangespub.techne.draft.permissioned.listChanges | query | The ordered receipts of every generic private write and delete the caller may read. | Signed in: rpc:pub.techne.draft.permissioned.listChanges, or the authPermissioned set |
permissioned.getGrantspub.techne.draft.permissioned.getGrants | query | Who may read an owner's source space (pub.techne.draft.space.source) beside the owner. | Signed in: rpc:pub.techne.draft.permissioned.getGrants, or the authPermissioned set |
Query 6
Read the commons: public records with no sign-in, and private ones a signed-in app's space scopes cover.
| Method | Kind | What it does | Scope it needs |
|---|---|---|---|
query.listRecordspub.techne.draft.query.listRecords | query | The platform's generic list query: one page of the records a pub.techne.draft.query names, in its order. | None for public data. Signed in: rpc:pub.techne.draft.query.listRecords, or the authRead set, for what the app’s space scopes cover |
query.getRecordspub.techne.draft.query.getRecords | query | Records by URI, as listRecords answers them. | None for public data. Signed in: rpc:pub.techne.draft.query.getRecords, or the authRead set, for what the app’s space scopes cover |
query.countRecordspub.techne.draft.query.countRecords | query | How many records a pub.techne.draft.query names. | None for public data. Signed in: rpc:pub.techne.draft.query.countRecords, or the authRead set, for what the app’s space scopes cover |
query.composeRecordspub.techne.draft.query.composeRecords | procedure | Up to 12 generic reads in one call. | None for public data. Signed in: rpc:pub.techne.draft.query.composeRecords, or the authRead set, for what the app’s space scopes cover |
query.listRejectionspub.techne.draft.query.listRejections | query | The public records this AppView refused when it indexed them, by the shared check (lexicons/check) or its own lexicon validation. | None: public, no sign-in |
commons.getVersionspub.techne.draft.commons.getVersions | query | One public event or place as its versions. | None for public data. Signed in: rpc:pub.techne.draft.commons.getVersions, or the authRead set, for what the app’s space scopes cover |
Type registry 6
Find record types, publish your own, and ask for one defined elsewhere.
| Method | Kind | What it does | Scope it needs |
|---|---|---|---|
registry.listTypespub.techne.draft.registry.listTypes | query | Find record types: search by name, field or purpose, or list a creator's. | None: public, no sign-in |
registry.getTypepub.techne.draft.registry.getType | query | One record type the platform knows. | None: public, no sign-in |
registry.publishTypepub.techne.draft.registry.publishType | procedure | Publish a community record type, or a new version of one you published. | Signed in: rpc:pub.techne.draft.registry.publishType |
registry.requestTypepub.techne.draft.registry.requestType | procedure | Ask the platform to index a record type defined elsewhere on the network. | Signed in: rpc:pub.techne.draft.registry.requestType |
registry.getTypeRequestpub.techne.draft.registry.getTypeRequest | query | The request to index one foreign type: who asked, its query roles, its preview and whether an operator approved or declined it. | None: public, no sign-in |
registry.listTypeRequestspub.techne.draft.registry.listTypeRequests | query | Requests to index foreign types, newest first. | None: public, no sign-in |
Sync 1
Tell the platform about a public record you just wrote.
| Method | Kind | What it does | Scope it needs |
|---|---|---|---|
sync.indexRecordpub.techne.draft.sync.indexRecord | procedure | A hint, sent right after a write: "I just wrote this public record". | Signed in: rpc:pub.techne.draft.sync.indexRecord, or the authWrite set |
Auth and moderation 2
Through the person's PDS: a token for one service and method, and a report to moderation.
| Method | Kind | What it does | Scope it needs |
|---|---|---|---|
server.getServiceAuthcom.atproto.server.getServiceAuth | query | Get a signed token on behalf of the requesting DID for the requested service. | Signed in; the PDS signs a token for one service and method |
moderation.createReportcom.atproto.moderation.createReport | procedure | Submit a moderation report regarding an atproto account or record. | rpc:com.atproto.moderation.createReport |
Accounts and identity (used mostly by Techne’s own apps) 19
Accounts and the links between them: sign-in methods, collectives, link tokens and phone holds.
| Method | Kind | What it does | Scope it needs |
|---|---|---|---|
identity.listMethodspub.techne.draft.identity.listMethods | query | The caller's sign-in methods (masked) and the account's alias links. | Signed in: rpc:pub.techne.draft.identity.listMethods, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.beginAddMethodpub.techne.draft.identity.beginAddMethod | procedure | Start adding a sign-in method to the caller's account: sends a 6-digit code to the channel (email in v1). | Signed in: rpc:pub.techne.draft.identity.beginAddMethod, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.finishAddMethodpub.techne.draft.identity.finishAddMethod | procedure | Finish adding a sign-in method with the code identity.beginAddMethod sent. | Signed in: rpc:pub.techne.draft.identity.finishAddMethod, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.unlinkMethodpub.techne.draft.identity.unlinkMethod | procedure | Remove a sign-in method from the caller's account. | Signed in: rpc:pub.techne.draft.identity.unlinkMethod, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.linkpub.techne.draft.identity.link | procedure | Link the caller's account with the other account named by the token identity.finishAddMethod offered. | Signed in: rpc:pub.techne.draft.identity.link, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.foldpub.techne.draft.identity.fold | procedure | Fold an empty, new account into the caller's other account, with the token identity.finishAddMethod offered. | Signed in: rpc:pub.techne.draft.identity.fold, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.unlinkAccountpub.techne.draft.identity.unlinkAccount | procedure | End an alias link: deletes the caller's pub.techne.draft.accountLink naming other, and the other account's too when this host holds it, and removes the alsoKnownAs entries this host added. | Signed in: rpc:pub.techne.draft.identity.unlinkAccount, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.createCollectivepub.techne.draft.identity.createCollective | procedure | Make a collective account: a new DID whose credential the platform holds, with a random handle and no records. | Signed in: rpc:pub.techne.draft.identity.createCollective, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.createLinkTokenpub.techne.draft.identity.createLinkToken | procedure | Make a link token on the caller's identity PDS. | Signed in: rpc:pub.techne.draft.identity.createLinkToken, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.checkLinkTokenpub.techne.draft.identity.checkLinkToken | procedure | Whether a link token still redeems, without signing in. | None: public, no sign-in |
identity.redeemLinkTokenpub.techne.draft.identity.redeemLinkToken | procedure | Redeem a link token as the caller. | Signed in: rpc:pub.techne.draft.identity.redeemLinkToken, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.listLinkTokenspub.techne.draft.identity.listLinkTokens | procedure | The caller's live links for app and target, each with its token, in no promised order. | Signed in: rpc:pub.techne.draft.identity.listLinkTokens, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.resetLinkTokenpub.techne.draft.identity.resetLinkToken | procedure | Revoke the caller's live reusable links for app and target and make a new reusable one. | Signed in: rpc:pub.techne.draft.identity.resetLinkToken, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.revokeLinkTokenpub.techne.draft.identity.revokeLinkToken | procedure | Revoke one of the caller's links: it no longer redeems. | Signed in: rpc:pub.techne.draft.identity.revokeLinkToken, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.listLinkRedemptionspub.techne.draft.identity.listLinkRedemptions | procedure | Who redeemed one of the caller's links, and when. | Signed in: rpc:pub.techne.draft.identity.listLinkRedemptions, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.accountsForPhonespub.techne.draft.identity.accountsForPhones | procedure | Which of these phone numbers belong to an account, and whose. | Signed in: rpc:pub.techne.draft.identity.accountsForPhones, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.holdForPhonepub.techne.draft.identity.holdForPhone | procedure | Hold a write until someone proves a phone number. | Signed in: rpc:pub.techne.draft.identity.holdForPhone, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.listPhoneHoldspub.techne.draft.identity.listPhoneHolds | query | The live holds (identity.holdForPhone) that would write as actAs, oldest first, for anyone who may write as it, and of those only the holds for a space the caller may read. | Signed in: rpc:pub.techne.draft.identity.listPhoneHolds, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |
identity.releasePhoneHoldpub.techne.draft.identity.releasePhoneHold | procedure | Withdraw a hold (identity.holdForPhone) unwritten. | Signed in: rpc:pub.techne.draft.identity.releasePhoneHold, and space scopes over the whole store (authWrite; the SDK’s everything: 'write'). A narrower app token gets 403 |