Skip to main content
GET
Get RAMS mandate
Send x-api-key. These reads are also x402-payable: call without a key and, where x402 is enabled for the chain, the API answers 402 Payment Required with the amount in the PAYMENT-REQUIRED header. Reads are priced at the cheaper GETTER tier than writes — take the amount from the response rather than from a table. Query by chainId, agent, and principal; agentMandateAddress is an optional contract override. The response includes the raw mandate, derived status (none, pending, active, expired, or revoked), agent freeze state, and the principal’s current EIP-712 nonce. On-chain read failures are returned as errors and never replaced with defaults.

Authorizations

x-api-key
string
header
required

Query Parameters

chainId
string
default:11155111
required

Target chain ID. RAMS is available on Ethereum Sepolia (11155111) only at launch. Decimal and 0x hex values are accepted.

agent
string
required

Agent wallet address.

Pattern: ^0x[a-fA-F0-9]{40}$
principal
string
required

Principal wallet address.

Pattern: ^0x[a-fA-F0-9]{40}$
agentMandateAddress
string

Optional AgentMandate contract override.

Pattern: ^0x[a-fA-F0-9]{40}$

Response

200 - application/json

Successful response

data
object