Skip to main content

Python API reference

This inventory is generated from the package's public export surface. Unknown or internal symbols are deliberately excluded.

  • __version__ — Constant. Public __version__ constant.
  • ACCOUNT_TOKEN_LOCKS — Constant. Public ACCOUNT_TOKEN_LOCKS constant.
  • AccountRefreshResult — Class. What a refresh did, without the Account Token itself.
  • AccountRevocationResult — Class. A revocation the company acknowledged; the local copy is gone.
  • AccountTokenClient — Class. Use a stored Account Token without ever handing it to a caller.
  • AccountTokenContext — Class. Where an Account Token is used, and for whom (all non-secret).
  • AccountTokenLock — Class. Serialize every use of one Account Token (PAP §4.8 rotation).
  • AgentIdentityClient — Class. Fetch and verify a personal agent's public identity documents.
  • ApiClient — Class. Read and change through a company's API, the credentials host-owned.
  • ApiError — Class. The company refused an API call; code is its error, never its body.
  • ApiResponse — Class. A successful API answer: the body, or the operation it proposes.
  • APPROVAL_SURFACES — Constant. Public APPROVAL_SURFACES constant.
  • ApprovalRequest — Class. A live-session action that changes or ends what the user holds, to approve first.
  • ApprovalSurface — Class. The host's own approval surface: the user, not a model, answers.
  • approve — Function. Record the user's approval of the revision the host just showed them.
  • ApprovedUrl — Class. A URL the safety policy approved, and the addresses it approved for its host.
  • AUTHORIZATION_STATE_STORES — Constant. Public AUTHORIZATION_STATE_STORES constant.
  • AuthorizationCodeGrant — Class. Redacted PAP authorization-code exchange values.
  • AuthorizationError — Class. An authorization flow failed without exposing callback secrets.
  • AuthorizationStateStore — Class. Persist and atomically consume short-lived authorization state.
  • BROWSER_ASSERTION_TYPE — Constant. Public BROWSER_ASSERTION_TYPE constant.
  • BROWSER_FORM_POSTS — Constant. Public BROWSER_FORM_POSTS constant.
  • BROWSER_HANDOFFS — Constant. Public BROWSER_HANDOFFS constant.
  • BrowserAssertionClaims — Class. Claims that bind a controlled browser to one PAP Session.
  • BrowserAssertionReplayCache — Class. Public BrowserAssertionReplayCache class.
  • BrowserFormPost — Class. Submit protected fields as a controlled top-level browser navigation.
  • BrowserHandoff — Class. Hand a human-only authorization URL to a trusted browser surface.
  • BrowserSessionClient — Class. Sign and POST a browser assertion without putting it in a URL.
  • BrowserSessionError — Class. A browser-session handoff or assertion failed safely.
  • BrowserSessionStart — Class. Safe status after a controlled form POST has started.
  • build_browser_assertion_claims — Function. Build unsigned PAP section 5 claims for protected signing.
  • build_direct_sign_in_request — Function. Build a user-browser authorization URL with random state and S256 PKCE.
  • build_pap_reactor — Function. Build a PAP Reactor host with plugins and return any HTTP client it owns.
  • build_session_assertion_claims — Function. Build unsigned PAP 4.2 claims; a key-custody provider signs them.
  • CACHES — Constant. Public CACHES constant.
  • ClientMetadata — Class. Public ClientMetadata class.
  • Clock — Class. Supply timezone-aware wall-clock time to expiring protocol state.
  • CLOCKS — Constant. Public CLOCKS constant.
  • ConfirmOutcome — Class. What a confirmation did.
  • ConversationClient — Class. Start and continue PAP conversations through a proof-bound transport.
  • ConversationError — Class. A PAP conversation request failed without exposing its body.
  • ConversationEvent — Class. One ordered PAP conversation event, including unknown future types.
  • ConversationEventPage — Class. A cursor page returned by a PAP conversation read or waited write.
  • ConversationReceipt — Class. State returned after a message when the caller does not wait for events.
  • ConversationResponse — Constant. Public ConversationResponse constant.
  • covers — Function. Whether a standing permission covers this revision, term by term.
  • create_resolving_client — Function. An httpx client whose every request goes through a ResolvingTransport.
  • CursorExpiredHandler — Constant. Public CursorExpiredHandler constant.
  • DEVICE_CODE_GRANT — Constant. Public DEVICE_CODE_GRANT constant.
  • DeviceAuthorizationResponse — Class. Validated response from the OAuth device authorization endpoint.
  • DeviceSignInClient — Class. Start and poll PAP Device Sign-In without exposing the device code.
  • DeviceSignInPoll — Class. One poll result; pending responses tell callers when to try again.
  • DeviceSignInStart — Class. User-facing device instructions without the private device code.
  • DirectSignInCallback — Class. Validated one-time authorization code.
  • DirectSignInClient — Class. Orchestrate one-use browser authorization and proof-bound code exchange.
  • DirectSignInRequest — Class. Authorization request state that redacts its URL and PKCE values.
  • DirectSignInResult — Class. Signed-in Session plus any scopes the company did not grant.
  • DirectSignInStart — Class. Non-secret status returned after handing authorization to the user.
  • DiscoveredCompany — Class. Public DiscoveredCompany class.
  • DISCOVERY_TRANSPORTS — Constant. Public DISCOVERY_TRANSPORTS constant.
  • DiscoveryClient — Class. Discover and authenticate a company's PAP declaration.
  • DiscoveryDocument — Class. Public DiscoveryDocument class.
  • DiscoveryError — Class. Discovery could not be completed safely.
  • DPOP_PROOF_PROVIDERS — Constant. Public DPOP_PROOF_PROVIDERS constant.
  • DpopHttpClient — Class. Send replay-safe DPoP requests without forwarding credentials across origins.
  • DpopKeyMaterial — Class. Private signing handle and separately exportable public JWK.
  • DpopProofProvider — Class. Create a fresh DPoP proof while keeping its private key protected.
  • DpopProofRequest — Class. Inputs for one fresh proof-of-possession JWT.
  • DpopReplayCache — Class. Atomically remember a proof ID until its acceptance window ends.
  • FINAL_STATES — Constant. Public FINAL_STATES constant.
  • generate_message_id — Function. Generate a user-global message ID with at least 128 random bits.
  • generate_pairwise_user_id — Function. Generate a non-PII user ID to persist for one user/company issuer pair.
  • IdentityError — Class. Personal-agent metadata or public keys could not be verified safely.
  • InMemoryProtocolCache — Class. Default pap.cache: a bounded, least-recently-used map in one process.
  • InMemoryStandingPermissionStore — Class. A single-process store of standing permissions, for examples and tests.
  • InProcessAccountTokenLock — Class. Default Account Token lock for a single process.
  • JoseAlgorithm — Constant. Public JoseAlgorithm constant.
  • JoseDpopProofProvider — Class. Create fresh RFC 9449 proofs using per-user/company key material.
  • JoseSigner — Class. Sign PAP assertions with an injected asymmetric private key or handle.
  • JsonWebKey — Class. One asymmetric public signing key published by a personal agent.
  • JsonWebKeySet — Class. A non-empty set of public keys suitable for PAP assertion verification.
  • JWT_BEARER_GRANT — Constant. Public JWT_BEARER_GRANT constant.
  • JWT_CLIENT_ASSERTION — Constant. Public JWT_CLIENT_ASSERTION constant.
  • MediatedSignInClient — Class. Relay a user's credentials to the company's mediated endpoint, once.
  • MediatedSignInResult — Class. Where a Mediated Sign-In stands, without any credential.
  • Message — Class. Message sent by either side or returned in a conversation event.
  • MetadataFetch — Class. The bounds of one public metadata fetch: size, total time, approved addresses.
  • OAuthServerMetadata — Class. Public OAuthServerMetadata class.
  • openapi_url — Function. The company's OpenAPI description, when it advertises one.
  • OpenTelemetrySink — Class. pap.telemetry as OpenTelemetry spans, one per event, under the current span.
  • Operation — Class. Public Operation class.
  • OperationConfirmation — Class. Public OperationConfirmation class.
  • OperationError — Class. An operation could not be read, confirmed, or cancelled.
  • OperationResult — Class. Public OperationResult class.
  • operations_endpoint — Function. The company's operations endpoint when both sides list version 1, else None.
  • OPERATIONS_EXTENSION — Constant. Public OPERATIONS_EXTENSION constant.
  • OPERATIONS_VERSION — Constant. Public OPERATIONS_VERSION constant.
  • OperationsClient — Class. Read, confirm, and cancel operations at a negotiated endpoint.
  • PAIRWISE_USER_ID_STORES — Constant. Public PAIRWISE_USER_ID_STORES constant.
  • PairwiseUserIdStore — Class. Persist stable random identities by tenant, local user, and issuer.
  • PapCorePlugin — Class. Contribute PAP's secure defaults through Reactor.
  • PersonalAgentProtocolError — Class. Base error whose string representation never includes response bodies.
  • pin_connections — Function. Make client's socket transports dial approved addresses during metadata fetches.
  • PinnedNetworkBackend — Class. Dial the address the URL safety policy approved, never the host name again.
  • ProofError — Class. A signed assertion or proof-of-possession value is invalid.
  • PROTECTED_INPUTS — Constant. Public PROTECTED_INPUTS constant.
  • ProtectedInput — Class. Collect protected values from the user outside model context (PAP §4.7).
  • ProtectedInputField — Class. One field a human types into the host's own trusted surface.
  • ProtectedInputRequest — Class. What the host must ask the user for, and for which company.
  • PROTOCOL_PROFILE — Constant. Public PROTOCOL_PROFILE constant.
  • PROTOCOL_REVISION — Constant. Public PROTOCOL_REVISION constant.
  • ProtocolCache — Class. Bound cached public protocol data by an absolute expiry.
  • ProtocolValidationError — Class. A protocol document is malformed or internally inconsistent.
  • RANDOM_SOURCES — Constant. Public RANDOM_SOURCES constant.
  • RandomSource — Class. Supply cryptographically secure random bytes.
  • RATE_LIMIT_BUDGETS — Constant. Public RATE_LIMIT_BUDGETS constant.
  • RateLimitBudget — Class. A company's request budget, shared by every task and user of the host.
  • RecordingTelemetrySink — Class. pap.telemetry in memory: every event, in order.
  • REFRESH_TOKEN_GRANT — Constant. Public REFRESH_TOKEN_GRANT constant.
  • resolve_pairwise_user_id — Function. Resolve the active Reactor store and return its stable pairwise ID.
  • ResolvingTransport — Class. Every request to an untrusted host resolved, vetted, and pinned.
  • RETRY_POLICIES — Constant. Public RETRY_POLICIES constant.
  • RetryPolicy — Class. When to retry a refused request (Guides, retries).
  • SessionAssertionClaims — Class. Claims signed by the personal agent when starting or renewing a session.
  • SessionClient — Class. Start and renew signed-out PAP sessions over the OAuth token endpoint.
  • SessionError — Class. A session request failed without exposing response secrets.
  • SessionGrant — Class. Redacted form values for a PAP JWT-bearer session request.
  • SessionToken — Class. Opaque token response returned by a PAP company.
  • SharedRateLimitBudget — Class. Default pap.rateLimitBudget: per-company budgets in one process.
  • Signer — Class. Sign a compact assertion without exposing private key material.
  • SIGNERS — Constant. Public SIGNERS constant.
  • SqlitePairwiseUserIdStore — Class. Atomically persist random pairwise IDs in a local SQLite database.
  • STANDING_PERMISSION_STORES — Constant. Public STANDING_PERMISSION_STORES constant.
  • StandingPermission — Class. What the user allowed in advance: one company, account, and action.
  • StandingPermissionRequest — Class. Public StandingPermissionRequest class.
  • StandingPermissionStore — Class. Reserve, commit, and release uses of standing permissions.
  • StreamItem — Constant. Public StreamItem constant.
  • StreamReconnected — Class. The stream was reopened from Last-Event-ID.
  • SystemClock — Class. Default UTC wall clock.
  • SystemRandomSource — Class. Default operating-system cryptographic randomness.
  • TELEMETRY_ATTRIBUTES — Constant. Public TELEMETRY_ATTRIBUTES constant.
  • TELEMETRY_EVENTS — Constant. Public TELEMETRY_EVENTS constant.
  • TELEMETRY_SINKS — Constant. Public TELEMETRY_SINKS constant.
  • TelemetryEvent — Class. One finished protocol stage: a span for traces, an event for analytics.
  • TelemetrySink — Class. Receive each finished protocol stage (telemetry.TelemetryEvent), redacted already.
  • TermLimit — Class. A bound on one term, named by its dotted path in terms.
  • terms_digest — Function. A digest of exactly what a revision says: its summary and its terms.
  • TextDelta — Class. A piece of a message still being written (SSE text-delta, §7.6).
  • TOKEN_STORES — Constant. Public TOKEN_STORES constant.
  • TokenStore — Class. Keep credentials behind opaque references and explicit deletion.
  • TransportError — Class. An authenticated PAP resource request failed safely.
  • URL_SAFETY_POLICIES — Constant. Public URL_SAFETY_POLICIES constant.
  • UserApproval — Class. The user approved this revision, as it was shown to them.
  • validate_direct_sign_in_callback — Function. Validate redirect location, state, and issuer before exposing the code.
  • VerifiedBrowserAssertion — Class. Public VerifiedBrowserAssertion class.
  • VerifiedDpopProof — Class. Safe identity of a verified, newly accepted DPoP proof.
  • verify_browser_assertion — Function. Verify type, signature, bindings, lifetime, return target, and replay.
  • verify_dpop_proof — Function. Verify signature, binding, freshness, nonce, token hash, and replay state.