SN-API Reference

POST /api/v1/actions/cascade
Content-Type: multipart/form-data

{
  "task_id": "uuid-task-id"
}

GET /api/v1/actions/cascade/tasks/{task_id}

{
  "task_id": "uuid",
  "status": "processing",
  "progress": 45,
  "created_at": "2024-01-01T00:00:00Z"
}

GET /api/v1/actions/cascade/tasks/{task_id}/status

POST /api/v1/actions/cascade/{action_id}/downloads
Content-Type: application/json

{
  "signature": "base64-encoded ADR-036 signature of the action_id"
}

{
  "task_id": "uuid-download-task-id"
}

GET /api/v1/downloads/cascade/{task_id}/status
Accept: text/event-stream

data: {"status": "processing", "progress": 0}

data: {"status": "processing", "progress": 50}

data: {"status": "completed", "progress": 100}

const es = new EventSource(
  `https://snapi.testnet.lumera.io/api/v1/downloads/cascade/${taskId}/status`
);
 
es.onmessage = (event) => {
  const data = JSON.parse(event.data);
  console.log(`Progress: ${data.progress}%`);
  if (data.status === "completed") {
    es.close();
  }
};

GET /api/v1/downloads/cascade/{task_id}/file

{
  "error": "action not found",
  "code": "NOT_FOUND"
}

{
  "error": "invalid signature",
  "code": "UNAUTHORIZED"
}

{
  "error": "supernodes unavailable",
  "code": "SERVICE_UNAVAILABLE"
}