com.atiproto.actions
Workflow envelope shared between atiproto XRPC endpoints and the agent interpreter. The server emits an outboundWorkflow when it needs the agent to execute repo writes against the user's PDS; the agent runs the actions and calls back with an inboundWorkflow.
Details · defs
| Kind | defs |
|---|---|
| Authority | atiproto.com |
| Indexed |
#create
objectInstructs the agent to call com.atproto.repo.createRecord on the user's PDS.
Properties
Server-assigned name for this action; echoed back on the corresponding response so the server can correlate.
maxLength: 64
DID of the repo to write to. The PDS auth check is the source of truth for whether the write is allowed.
rkey
stringOptional. When omitted (the default), the PDS generates the rkey and returns the resulting URI on the response. Server-assigned rkeys are reserved for fixed-rkey records like com.atiproto.profile/self.
maxLength: 128
#delete
objectInstructs the agent to call com.atproto.repo.deleteRecord on the user's PDS.
Properties
#error
objectPopulated by the agent when an action fails. The server's error branch uses this to construct compensating actions and a final raise.
#inboundWorkflow
objectAgent → server callback envelope. Echoes the server's intent verbatim, except when the agent overrides to "error" after an action failure.
#outboundWorkflow
objectServer → agent envelope. Server-defined intent string acts as a phase marker; the agent treats it as opaque. Each item in `actions` is discriminated by `$type` against `#create` / `#update` / `#delete` / `#raise`.
#raise
objectTerminal action: the agent throws a WorkflowRaisedError carrying message and code. Subsequent actions in the same batch are not executed.
#recordResult
object#response
objectResult of executing one action. Carries the verb (so the server can branch without inspecting result shape) plus the action name and the resulting record reference.
Properties
maxLength: 32knownValues: create | update | delete
maxLength: 64
#update
objectInstructs the agent to call com.atproto.repo.putRecord on the user's PDS.
Properties
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
com.atproto.repo.applyWrites
procedureApply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.