Authentication

All orbserv API requests require an API key.

API key format

orbserv API keys follow this format:

orb_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

A 32-character alphanumeric string prefixed with orb_. Keys are case-sensitive.

Using your API key

Pass your key in the Authorization header as a Bearer token:

Authorization: Bearer orb_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

SDK initialization

import { OrbWallet } from '@orbserv-labs/orb-wallet'
 
const orb = new OrbWallet({
  apiKey: process.env.ORB_API_KEY!,
})

Raw HTTP request

curl https://api.orbserv.co/v1/wallets \
  -H "Authorization: Bearer orb_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Managing API keys

Via the dashboard

1. Sign in at app.orbserv.co
2. Navigate to Settings → API Keys
3. Click Create key — give it a descriptive name (e.g. prod-agent, staging-worker)
4. Copy the key immediately — it will not be shown again

To revoke a key, click the trash icon next to it. Revocation is immediate.

Via the REST API

Create a key programmatically:

const newKey = await orb.apiKeys.create({
  name: 'prod-agent-v2',
})
 
console.log(newKey.key) // orb_...

List all active keys:

const keys = await orb.apiKeys.list()
// [{ id, name, createdAt, lastUsed }, ...]

Delete a key by ID:

await orb.apiKeys.delete('key_abc123')

Security recommendations

• Store API keys in environment variables, never in source code
• Use separate keys per environment (development, staging, production)
• Apply the principle of least privilege — create keys scoped to specific agents
• Rotate keys periodically or immediately if you suspect a compromise
• Monitor key usage via the dashboard to detect anomalous activity