Skip to main content

​
Prerequisites

  • A Proxy account (sign up)
  • Your API key from the dashboard

​
Authentication

All API requests require a Bearer token: 
Authorization: Bearer your_api_key

​
Step 1: Create a Customer

curl -X POST https://api.useproxy.ai/v1/customers \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "consumer",
    "email": "alice@example.com",
    "name": { "first": "Alice", "last": "Smith" }
  }'

​
Step 2: Register an Agent

curl -X POST https://api.useproxy.ai/v1/agents \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "cust_xxx",
    "externalId": "my-agent-123",
    "name": "Shopping Agent"
  }'

​
Step 3: Issue a Card

curl -X POST https://api.useproxy.ai/v1/cards \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "customerId": "cust_xxx",
    "agentId": "agent_xxx",
    "usage": "multi"
  }'

​
Step 4: Declare Intent & Access Card

# Declare intent
curl -X POST https://api.useproxy.ai/v1/cards/card_xxx/intents \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "purpose": "Purchase supplies from Amazon",
    "expectedAmount": 5000,
    "expectedMerchant": "Amazon"
  }'

# Get card details
curl -X POST https://api.useproxy.ai/v1/cards/card_xxx/details \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "intentId": "int_xxx",
    "purpose": "Purchase supplies from Amazon"
  }'

​
Next Steps

Concepts

Deep dive into core concepts

API Reference

Full API documentation