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.

Repository @atiproto.com did:plc:4x5dcv6u4wlkjcssto7f22nu namespace authority
Details · defs
Kinddefs
Authorityatiproto.com
Indexed

#create

object

Instructs the agent to call com.atproto.repo.createRecord on the user's PDS.

Properties

collection

requiredstring · nsid

name

requiredstring

Server-assigned name for this action; echoed back on the corresponding response so the server can correlate.

  • maxLength: 64

record

requiredunknown

repo

requiredstring · did

DID of the repo to write to. The PDS auth check is the source of truth for whether the write is allowed.

rkey

string

Optional. 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

object

Instructs the agent to call com.atproto.repo.deleteRecord on the user's PDS.

Properties

collection

requiredstring · nsid

name

requiredstring
  • maxLength: 64

repo

requiredstring · did

rkey

requiredstring
  • maxLength: 128

swapCommit

string · cid

#error

object

Populated by the agent when an action fails. The server's error branch uses this to construct compensating actions and a final raise.

Properties

action

requiredstring

The verb of the action that failed (create/update/delete).

  • maxLength: 32

code

string
  • maxLength: 64

message

requiredstring
  • maxLength: 1024

name

string
  • maxLength: 64

#inboundWorkflow

object

Agent → server callback envelope. Echoes the server's intent verbatim, except when the agent overrides to "error" after an action failure.

Properties

Reference

intent

requiredstring
  • maxLength: 64

responses

requiredarray
itemsref
Reference

#outboundWorkflow

object

Server → 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`.

Properties

actions

requiredarray
itemsunion

intent

requiredstring
  • maxLength: 64

#raise

object

Terminal action: the agent throws a WorkflowRaisedError carrying message and code. Subsequent actions in the same batch are not executed.

Properties

code

string
  • maxLength: 64

message

requiredstring
  • maxLength: 1024

#recordResult

object

Properties

cid

string · cid

Present on create/update responses; absent on delete (the record is gone).

uri

requiredstring · at-uri

#response

object

Result 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

action

requiredstring
  • maxLength: 32
  • knownValues: create | update | delete

name

requiredstring
  • maxLength: 64

result

requiredref
Reference

#update

object

Instructs the agent to call com.atproto.repo.putRecord on the user's PDS.

Properties

collection

requiredstring · nsid

name

requiredstring
  • maxLength: 64

record

requiredunknown

repo

requiredstring · did

rkey

requiredstring
  • maxLength: 128

swapCommit

string · cid

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.