Skip to main content

​
Endpoint

POST /v1/auth/agent-register
Content-Type: application/json
No authentication required. Creates a new agent account with an API key — no email or password needed.
This endpoint is designed for autonomous agents that need to self-register and start using Engram without human intervention.

​
Request Body

{
  "name": "my-research-agent"
}
FieldTypeRequiredDescription
namestringNoAgent display name. Auto-generated if omitted.

​
Response (201)

{
  "agentId": "adb2658d-8ea2-4ff8-b779-61f53a831a52",
  "developerId": "a24d7e21-34e8-4acf-91ae-3b91cd1eff0e",
  "name": "my-research-agent",
  "apiKey": "sk_live_your_api_key_here",
  "rotationSecret": "sk_live_your_rotation_secret_here",
  "aptosAddress": "0x43a8683868bb2e58a77b5ea77b73fe62ded9b0b60028829ca4ee26b2aa06cedf",
  "creditBalance": 100,
  "depositInfo": {
    "address": "0x43a868...",
    "supportedTokens": ["APT"],
    "network": "testnet",
    "note": "Send APT to this address, then call POST /v1/billing/agent/deposit { txHash } to credit your account."
  }
}

​
Fields

FieldTypeDescription
agentIdstringUnique agent identifier
developerIdstringParent developer account ID
namestringAgent display name
apiKeystringAPI key for all subsequent requests (sk_live_...)
rotationSecretstringSecret for self-rotating the API key (shown once)
aptosAddressstringAptos wallet address for depositing credits
creditBalancenumberStarting balance (100 free starter credits)
depositInfoobjectInstructions for depositing APT to purchase credits
Save your API key and rotation secret immediately. They are only shown once and cannot be retrieved later. The rotation secret is required to self-rotate your API key.

​
What You Get

1

API Key

A sk_live_... key for authenticating all Engram API requests.
2

Rotation Secret

A sk_live_... secret for self-rotating your API key without developer intervention.
3

Aptos Wallet

A dedicated deposit address on the Aptos network for purchasing credits.
4

100 Free Credits

Starter credits to begin storing memories immediately.

​
Next Steps

After registration, your agent can:
  1. Store memories using the API key (see Quick Start)
  2. Rotate your API key when needed (see Key Rotation)
  3. Top up credits by sending APT to the aptosAddress (see Agent Deposit)
  4. Check balance at any time (see Agent Balance)