Documentation | Intents

Intents

intents

Methods

List Intents -> Cursor<

IntentResponse

get/v1/intents

List intents for an app. Returns a paginated list of intents with their current status and details.

Get Intent ->

IntentResponse

get/v1/intents/{intent_id}

Retrieve an intent by ID. Returns the intent details including its current status, authorization details, and execution result if applicable.

path Parameters

intent_id: string

ID of the intent.

Response fields

IntentResponse

Request example

curl https://api.privy.io/v1/intents/$INTENT_ID \
    -u "$PRIVY_APP_ID:PRIVY_APP_SECRET"

200Example

{
  "authorization_details": [
    {
      "members": [
        {
          "signed_at": null,
          "type": "user",
          "user_id": "did:privy:clabcd123"
        }
      ],
      "threshold": 1,
      "display_name": "Admin Key Quorum"
    }
  ],
  "created_at": 1741834854578,
  "created_by_display_name": "developer@example.com",
  "expires_at": 1741921254578,
  "intent_id": "clpq1234567890abcdefghij",
  "intent_type": "RPC",
  "request_details": {
    "body": {
      "caip2": "eip155:8453",
      "method": "eth_sendTransaction",
      "params": {
        "transaction": {
          "authorization_list": [
            {
              "chain_id": "string",
              "contract": "contract",
              "nonce": "string",
              "r": "r",
              "s": "s",
              "y_parity": 0
            }
          ],
          "chain_id": "string",
          "data": "data",
          "from": "from",
          "gas_limit": "string",
          "gas_price": "string",
          "max_fee_per_gas": "string",
          "max_priority_fee_per_gas": "string",
          "nonce": "string",
          "to": "0x0000000000000000000000000000000000000000",
          "type": 0,
          "value": 1
        }
      },
      "address": "address",
      "chain_type": "ethereum",
      "sponsor": true,
      "wallet_id": "wallet_id"
    },
    "method": "POST",
    "url": "https://api.privy.io/v1/wallets/xs76o3pi0v5syd62ui1wmijw/rpc"
  },
  "resource_id": "xs76o3pi0v5syd62ui1wmijw",
  "status": "pending",
  "action_result": {
    "executed_at": 0,
    "status_code": 0,
    "authorized_by_display_name": "authorized_by_display_name",
    "authorized_by_id": "authorized_by_id"
  },
  "created_by_id": "did:privy:clabcd123",
  "current_resource_data": {
    "id": "id",
    "additional_signers": [
      {
        "signer_id": "signer_id",
        "override_policy_ids": [
          "string"
        ]
      }
    ],
    "address": "address",
    "chain_type": "ethereum",
    "created_at": 0,
    "exported_at": 0,
    "imported_at": 0,
    "owner_id": "owner_id",
    "policy_ids": [
      "string"
    ],
    "authorization_threshold": 0,
    "custodian": {
      "name": "name"
    },
    "custody": {
      "provider": "provider",
      "provider_user_id": "provider_user_id"
    },
    "public_key": "public_key"
  },
  "dismissal_reason": "dismissal_reason",
  "dismissed_at": 0,
  "rejected_at": 0
}

Create Rpc Intent ->

RpcIntentResponse

post/v1/intents/wallets/{wallet_id}/rpc

Create an intent to execute an RPC method on a wallet. The intent must be authorized by either the wallet owner or signers before it can be executed.

Create Wallet Update Intent ->

WalletIntentResponse

patch/v1/intents/wallets/{wallet_id}

Create an intent to update a wallet. The intent must be authorized by the wallet owner before it can be executed.

Create Policy Update Intent ->

PolicyIntentResponse

patch/v1/intents/policies/{policy_id}

Create an intent to update a policy. The intent must be authorized by the policy owner before it can be executed.

Create Policy Rule Intent ->

RuleIntentResponse

post/v1/intents/policies/{policy_id}/rules

Create an intent to add a rule to a policy. The intent must be authorized by the policy owner before it can be executed.

Create Policy Rule Update Intent ->

RuleIntentResponse

patch/v1/intents/policies/{policy_id}/rules/{rule_id}

Create an intent to update a rule on a policy. The intent must be authorized by the policy owner before it can be executed.

Create Policy Rule Delete Intent ->

RuleIntentResponse

delete/v1/intents/policies/{policy_id}/rules/{rule_id}

Create an intent to delete a rule from a policy. The intent must be authorized by the policy owner before it can be executed.

Create Key Quorum Update Intent ->

KeyQuorumIntentResponse

patch/v1/intents/key_quorums/{key_quorum_id}

Create an intent to update a key quorum. The intent must be authorized by the key quorum members before it can be executed.

Domain types

BaseActionResult = { executed_at, status_code, authorized_by_display_name, 1 more... }

Common fields for intent action execution results.

IntentAuthorization = { members, threshold, display_name }

Authorization quorum for an intent

IntentAuthorizationKeyQuorumMember = { signed_at, type, user_id } | { public_key, signed_at, type }

A leaf member (user or key) of a nested key quorum in an intent authorization.

IntentAuthorizationMember = { signed_at, type, user_id } | { public_key, signed_at, type } | { key_quorum_id, members, threshold, 3 more... }

A member of an intent authorization quorum. Can be a user, key, or nested key quorum.

IntentResponse =

RpcIntentResponse

WalletIntentResponse

PolicyIntentResponse

| 2 more...

Response for an intent object

IntentStatus = "pending" | "executed" | "failed" | 3 more...

Current status of an intent.

IntentType = "KEY_QUORUM" | "POLICY" | "RULE" | 2 more...

Type of intent.

KeyQuorumIntentResponse = { authorization_details, created_at, created_by_display_name, 12 more... }

Response for a key quorum intent

PolicyIntentRequestDetails = { body, method, url }

Request details for a policy intent.

PolicyIntentResponse = { authorization_details, created_at, created_by_display_name, 12 more... }

Response for a policy intent

RpcIntentRequestDetails = { body, method, url }

Request details for an RPC intent.

RpcIntentResponse = { authorization_details, created_at, created_by_display_name, 12 more... }

Response for an RPC intent

RuleIntentCreateRequestDetails = { body, method, url }

Request details for creating a rule via intent.

RuleIntentDeleteRequestDetails = { method, url, body }

Request details for deleting a rule via intent.

RuleIntentRequestDetails =

RuleIntentCreateRequestDetails

RuleIntentUpdateRequestDetails

RuleIntentDeleteRequestDetails

The original rule request. Method is POST (create), PATCH (update), or DELETE (delete)

RuleIntentResponse = { authorization_details, created_at, created_by_display_name, 13 more... }

Response for a rule intent

RuleIntentUpdateRequestDetails = { body, method, url }

Request details for updating a rule via intent.

WalletIntentResponse = { authorization_details, created_at, created_by_display_name, 12 more... }

Response for a wallet intent