Sepurux logo

Docs / Getting Started

Go from zero to your first reliability run.

This guide gets a team from initial setup to a working trace and campaign execution path with production-safe defaults.

API guideCI/CD guide

Prerequisites

Before writing code, make sure you have the right project-level credentials.

Project API key

Generate from the Sepurux app workspace settings.

Project ID

Use a project-scoped UUID for all /v1 requests.

Campaign ID

Create one campaign first, then reuse it in SDK and CI.

Environment Setup

Define these variables once in local shell, `.env`, or CI secrets.

env
SEPURUX_API_BASE_URL=https://app.sepurux.dev/api/backend
SEPURUX_UI_BASE_URL=https://app.sepurux.dev
SEPURUX_API_KEY=<project_api_key>
SEPURUX_PROJECT_ID=<project_uuid>
SEPURUX_CAMPAIGN_ID=<campaign_uuid>

Create Your First Trace

Post a minimal trace payload and confirm it appears in the Sepurux dashboard.

bash
curl -X POST https://app.sepurux.dev/api/backend/v1/traces \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $SEPURUX_API_KEY" \
  -H "X-Project-Id: $SEPURUX_PROJECT_ID" \
  -d '{
    "trace_version": "0.1",
    "source": "getting_started",
    "task": {"name": "customer_refund_flow"},
    "events": [
      {"type": "model", "name": "classify_ticket", "input": {"ticket_id": "t-101"}},
      {"type": "tool_call", "tool": "payments.refund", "input": {"amount": 4200}}
    ]
  }'

Run a Seeded Reliability Pack

Execute a baseline mutation pack to validate your integration before custom packs or policy tuning.

bash
curl -X POST https://app.sepurux.dev/api/backend/v1/campaigns/$SEPURUX_CAMPAIGN_ID/run-pack \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $SEPURUX_API_KEY" \
  -H "X-Project-Id: $SEPURUX_PROJECT_ID" \
  -d '{
    "pack": "sepurux.core.reliability"
  }'