AxUCPClientOptions Generated TypeScript API reference. typescript api api/reference build/apidocs/Interface.AxUCPClientOptions.md interface AxUCPClientOptions

AxUCPClientOptions

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/ucp/types.ts#L114

Properties

PropertyTypeDescription
agentProfilestringPublic platform profile URL injected into every request.
evaluationMode?"live" | "replay" | "sandbox"Marks a configured endpoint as an evaluation sandbox or replay source.
getIdentityToken?() => | null | AxMCPTokenSet | Promise<null | AxMCPTokenSet>Host-managed user identity token for pre-authorized commerce calls.
headers?Record<string, string>-
httpMessageSignature?AxUCPHTTPMessageSignatureOptionsBuilt-in RFC 9421 header construction with caller-provided key signing.
httpMessageVerification?AxUCPHTTPMessageVerificationOptionsBuilt-in RFC 9421 response verification using business profile keys.
identityLinkingOAuth?AxMCPOAuthOptionsOAuth/PKCE account linking used after UCP identity challenges.
mcp?AxMCPStreamableHTTPTransportOptions-
namespace?string-
platformCapabilities?Record<string, readonly AxUCPVersionedDeclaration[]>-
profileUrlstringBusiness origin or explicit /.well-known/ucp profile URL.
schemaValidation?| false | AxUCPSchemaValidationOptionsValidate outcomes against negotiated capability schema documents.
signRequest?(request: Readonly<{ body: string; headers: Record<string, string>; method: string; url: string; }>) => | Record<string, string> | Promise<Record<string, string>>Optional request signer. Return additional or replacement headers.
skipMCPInitialization?booleanCompatibility mode for UCP MCP endpoints that reject initialize.
transport?"auto" | AxUCPTransportKind-
trustedBusinessProfileUrls?readonly string[]Additional business profile URLs trusted to sign lifecycle webhooks.
verifyResponse?(response: Response, context: Readonly<{ profile: AxUCPNegotiatedProfile; }>) => void | Promise<void>Optional response verifier for RFC 9421 or deployment-specific policy.
version?string-
webhookMaxAgeSeconds?number-
Docs