📖 Usage & Studio Interface

Veloctra offers an intuitive Web Studio for visually designing, validating, and publishing pipelines, as well as an OpenAPI/Swagger compliant REST API for automated CI/CD workflows.

1. Visual Pipeline Studio

Access the web studio at http://localhost:8008/studio:

• Pipeline Dropdown: Select and modify existing pipeline definitions.
• Visual Modeler & YAML: Edit data sources, transformations, rules, and destination sinks with live JSON schema validation.
• 1-Click Publish to Engine: Pushes pipeline definitions into MongoDB veloctra_system and automatically syncs double-encrypted database connections.

2. REST API Reference

Authenticate and trigger pipelines programmatically:

# 1. Obtain JWT Bearer Token
TOKEN=$(curl -s -X POST http://localhost:8008/auth/login \
  -H "Content-Type: application/json" \
  -d '{"username": "admin", "password": "changeme"}' | jq -r .access_token)

# 2. Estimate Migration Size & KEDA Shard Replicas
curl -s -X POST http://localhost:8008/pipelines/csv_to_postgres/estimate-size \
  -H "Authorization: Bearer $TOKEN" | jq .

# 3. Trigger Pipeline Execution
curl -s -X POST http://localhost:8008/pipelines/start \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"pipeline_id": "csv_to_postgres"}' | jq .

# 4. Scrape Prometheus Metrics (Kubernetes / KEDA Scraper)
curl -s http://localhost:8008/metrics

# 5. Query Live Observability Telemetry
curl -s http://localhost:8008/metrics/live | jq .

3. Real-Time WebSockets Telemetry

Connect to /ws/telemetry/{job_id}?token={jwt_token} to stream live chunk events, MemoryGuard backpressure notifications, and row throughput directly into custom monitoring dashboards.