Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vane.build/llms.txt

Use this file to discover all available pages before exploring further.

​
GET /v1/ws

WebSocket endpoint for real-time attestation events. Every call to POST /v1/attest broadcasts a message to all connected clients immediately after the record is written and verified. The connection is unauthenticated at the transport level — all clients receive all attestation events for all companies. Only connect from trusted, internal infrastructure. In production, place the WebSocket endpoint behind a firewall or VPN.

​
Connection

const ws = new WebSocket('ws://localhost:3000/v1/ws');

ws.onmessage = (event) => {
  const data = JSON.parse(event.data);
  console.log(data);
};

​
Message format

FieldTypeDescription
type"record"Always "record" for attestation events.
recordAttestationRecordThe newly appended record.
validbooleanWhether the full chain passed verification after this record was added.
merkleRootstringPresent when valid is true. The new Merkle root.
failedAtIndexnumberPresent when valid is false. The first record that failed verification.

​
Example message

{
  "type": "record",
  "record": {
    "index": 7,
    "timestamp": "2026-01-01T12:00:00.000Z",
    "payload": {
      "agentId": "researcher-1",
      "companyId": "acme",
      "actionType": "web-search",
      "payload": { "query": "..." }
    },
    "hash": "f651a7c3...",
    "signature": "vdv-nC4o..."
  },
  "valid": true,
  "merkleRoot": "a3f9b2c1..."
}

​
Use case: real-time audit dashboard

const ws = new WebSocket('ws://localhost:3000/v1/ws');

ws.onopen = () => console.log('Connected to Vane attestation stream');

ws.onmessage = (event) => {
  const { type, record, valid, merkleRoot } = JSON.parse(event.data);
  if (type === 'record') {
    console.log(`[${record.index}] ${record.payload.actionType} by ${record.payload.agentId}`);
    if (!valid) {
      console.error('Chain integrity failure detected at index', record.index);
    }
  }
};

ws.onclose = () => console.log('Disconnected');
ws.onerror = (err) => console.error('WebSocket error:', err);