Header menu logo FSharp.ATProto

FSharp.ATProto.Core Namespace

Type/Module Description

AtpAgent (Module)

Functions for creating and authenticating AtpAgent instances.

AtpAgent (Type)

Client agent for communicating with an AT Protocol Personal Data Server (PDS). Holds the HTTP client, base URL, optional authenticated session, and extra headers.

AtpSession

An authenticated session with an AT Protocol Personal Data Server (PDS). Obtained by calling login with valid credentials.

Json

Shared JSON serialization configuration for the AT Protocol.

KnownValueConverter<'T>

Generic JSON converter for "known values" discriminated unions. Reads/writes string values, mapping known strings to fieldless DU cases (via [<JsonName>] attributes) and unknown strings to the Unknown of string fallback case.

KnownValueConverterFactory

Factory that intercepts types annotated with [<JsonConverter(typeof<KnownValueConverter<_>>)>] and creates the appropriate KnownValueConverter{T}. Must be registered before JsonFSharpConverter in options to take precedence (System.Text.Json checks Options.Converters before type-level attributes).

Plc

Client for the PLC Directory -- the public ledger for did:plc:* DIDs. Provides read operations (resolve, audit log, export) that require no authentication, and operation construction/signing helpers for DID document updates.

QueryParams

Serializes F# records to URL query strings for XRPC query parameters. Used internally by query to convert typed parameter records into query-string form.

ServiceAuth

Service-to-service JWT authentication for AT Protocol backend services (labelers, feed generators, etc.).

TaskResultCE

Xrpc

XRPC transport layer for AT Protocol API calls. Provides functions for executing queries (HTTP GET) and procedures (HTTP POST) against an authenticated AtpAgent.

XrpcError

Represents an error response from an XRPC endpoint. AT Protocol servers return JSON error bodies with optional error and message fields alongside an HTTP status code.

Type something to start searching.