Documentation/Getting Started

Getting Started

Run your first stress test in under 5 minutes

What you'll accomplish

  • Create your first project and upload an OpenAPI spec
  • Run a complete test suite (Smoke, Ramp, Spike, and Chaos tests)
  • Understand your API's breaking point and performance bottlenecks
1

Sign Up and Claim Free Credits

Create your account and claim 50 free credits to run your first tests at no cost.

50 free credits = 2 full test suites or 10 individual tests

View pricing →
2

Create a Project

Projects organize your API tests. Each project represents one API you want to test.

  1. 1.Go to your Dashboard
  2. 2.Click "New Project"
  3. 3.Enter a name (e.g., "My API") and optional description
  4. 4.Set your API base URL (e.g., https://api.example.com)
3

Configure API Settings

Set your API's base URL and authentication before uploading your OpenAPI spec.

  1. 1.Click on your project name to open the configuration page
  2. 2.Enter your API base URL (e.g., https://staging-api.example.com)
  3. 3.If your API requires authentication, select the type and enter credentials
  4. 4.Click "Save Configuration"

Supported Auth Types:

  • Bearer Token
  • API Key (header or query parameter)
  • Basic Auth
  • Custom Headers
4

Upload OpenAPI Specification

Your OpenAPI spec (Swagger) tells us about your API's endpoints, so we can generate realistic test scenarios.

  1. 1.Scroll down to the "OpenAPI Specs" section
  2. 2.Click "Upload Spec"
  3. 3.Select your openapi.json or openapi.yaml file
5

Generate Test Scenarios

Our AI analyzes your OpenAPI spec to create realistic test scenarios that match real-world usage patterns.

  1. 1.Click "Generate Scenarios" (AI-powered, takes ~30 seconds)
  2. 2.Review the generated scenarios - the system automatically saves them

AI-Generated Scenarios

The AI identifies critical user flows (e.g., login → fetch data → update) and assigns realistic traffic weights to each endpoint.

6

Run Your First Test Suite

A full test suite runs 4 different test profiles to thoroughly evaluate your API's performance and resilience.

🧪

Smoke Test

3 VUs, 15 seconds - Basic health check under minimal load

📈

Ramp Test

8 VUs ramping up, 20 seconds - Find breaking point gradually

Spike Test

10 VUs with sudden burst, 15 seconds - Test traffic spike resilience

💥

Chaos Test

5 VUs with latency injection and errors, 20 seconds - Test resilience

Cost: ~20 credits per full suite

Your 50 free credits include 2 complete test suites.

  1. 1.Select your scenario
  2. 2.Click "Run Full Suite"
  3. 3.Watch the tests execute in real-time (~70 seconds total)
7

Analyze Results

After your test suite completes, you'll get comprehensive insights powered by AI analysis.

📊 Performance Metrics

  • • Requests per second (RPS)
  • • Latency percentiles (P50, P95, P99)
  • • Error rates and status code distribution
  • • Per-endpoint breakdown

🤖 AI Analysis

  • • Breaking point identification
  • • Bottleneck detection (database, CPU, memory)
  • • Production readiness verdict
  • • Prioritized fix recommendations
  • • Concurrent user capacity estimates

📈 Suite Comparison

  • • Best vs worst performing profiles
  • • Resilience score across all tests
  • • Specific recommendations per test type