Complete API documentation for integrating with AURA.
Real-time bidirectional communication for Scouts and Beacons.
Endpoint: wss://api.aura-labs.ai
const ws = new WebSocket('wss://api.aura-labs.ai');
ws.onopen = () => {
ws.send(JSON.stringify({
type: 'AUTHENTICATE',
payload: { apiKey: 'your-api-key' }
}));
};
Stateless operations for configuration and queries.
Base URL: https://api.aura-labs.ai/v1
All API requests require authentication via API key:
# WebSocket
{ "type": "AUTHENTICATE", "payload": { "apiKey": "..." } }
# REST
Authorization: Bearer your-api-key
| Type | Description |
|---|---|
INTENT_REGISTER |
Register purchase intent |
DISCOVERY_REQUEST |
Search for matching Beacons |
NEGOTIATION_REQUEST |
Start negotiation |
NEGOTIATION_ACCEPT |
Accept an offer |
TRANSACTION_REQUEST |
Complete transaction |
| Type | Description |
|---|---|
BEACON_REGISTER |
Register with AURA Core |
PROPOSITION_UPDATE |
Update available offerings |
INQUIRY_RESPONSE |
Respond to Scout inquiry |
NEGOTIATION_OFFER |
Make pricing offer |
TRANSACTION_CONFIRM |
Confirm transaction |
| Type | Description |
|---|---|
HEARTBEAT |
Keep connection alive |
ERROR |
Error response |
ACK |
Acknowledgment |
| Code | Description |
|---|---|
AUTH_FAILED |
Authentication failure |
RATE_LIMITED |
Too many requests |
INVALID_MESSAGE |
Malformed message |
NOT_FOUND |
Resource not found |
NEGOTIATION_EXPIRED |
Negotiation timed out |
| Client Type | Requests/min | Connections |
|---|---|---|
| Scout | 100 | 5 |
| Beacon | 500 | 10 |
| Enterprise | Custom | Custom |