Qodex.ai lets you go from zero to automated API testing in minutes. Here’s how to get up and running — fast.

​
1. Sign Up

Go to app.qodex.ai → Create your account → You’ll land in AI Agent.

Screenshot2025 06 25at10 59 17 Pn

​
2. Import or Discover your APIs

In the top-left dropdown, click “Add Collection.”

You can upload:

  • Postman Collections (.json)
  • Swagger/OpenAPI files (.yaml, .json)
  • Or use our API Discovery SDK (if no spec is available)

Once uploaded, the collection will be automatically selected and ready for test generation.

Add Collection Gi

​
3. Generate Test Scenarios in Chat

In the AI Agent chat, describe what you want to test using plain English.

Example prompts:

  • “Test login with valid and invalid credentials”
  • “Check error response when email is missing in signup”
  • “Verify token expiration and redirect on protected routes”

The AI Agent will respond with:

  • A list of proposed test scenarios
  • An option to confirm and save

Click Save and the test scenario will be added to your workspace.

For more details: Test Scenario Creation Agent

Generate Ts Ai Agent Gi

​
4. Generate Request Data (AI or Manual)

Once your scenario is created:

  • Click “Create Request Data” in the scenario page
  • The AI will auto-generate request payloads, headers, query params, etc.
  • You can edit any of this manually as needed

If the API requires tokens or custom environment values, select the correct environment (.env.staging, etc.) from the right panel.

Request Data Gi

​
5. Apply or Write Test Rules

Scroll to the Test Rules section under each test case.

Here you can:

  • Use AI-suggested rules (auto-populated for common validations)

  • Write your own custom rules in plain English

    (e.g., “Response time should be < 1000ms” or “Status should be 401 if token is invalid”)

These rules are converted into test assertions.

Test Rules Pn

​
6. Run Your Tests in One Click

Click Run on any individual test scenario — or run an entire suite.

Before running:

  • Select your environment (e.g., staging, production, QA)
  • Ensure request data is populated
  • Hit Run

Results will show up instantly in the Build panel on the right.

For detailed logs, visit the Build Reports tab.

For more details: Running Tests from the Qodex Web App

Run Pn

​
7. Debug Failed Tests with “Fix Me”

If a test fails:

  • You’ll see a red ❌ in the Build Report
  • Click “Fix Me” to ask the AI why the test failed
  • Get suggestions for how to update the request, test rules, or data

This speeds up troubleshooting and reduces back-and-forth guesswork.

For more details: Build Reports

Screenshot2025 06 25at11 24 13 Pn

From the Test Scenarios tab (click “Test Scenarios” in the top nav):

  • On the top-right, click “Sync to GitHub”
  • Choose your repo and branch

Qodex will push test code (YAML + JavaScript) under /tests/qodex/.

This enables:

  • Version control of test logic
  • Local test execution via CLI
  • CI/CD integration with GitHub Actions

Screen Recording2025 06 30at13 15 03 Gi

​
9. Create Test Plans & Schedule Runs

From the Test Suites tab:

  • Select active scenarios you want to run together and click “+Add to Test Suite”
  • Select Suites you want to schedule and click “+ Add to Test Plan”
  • Give the plan a name and define a schedule from the **Details **tab on the right

You can schedule tests to run:

  • Daily
  • Weekly
  • On every deploy (via webhook trigger)

Set up Slack or Email alerts in the Details tab for failure notifications.

Test Plan Gi

​
That’s it — You’re Ready

You’ve now:

  • Uploaded your APIs
  • Created test scenarios
  • Generated data and rules
  • Run tests
  • Set up alerts & version control

Qodex is now your full-stack AI QA engineer — working with you to scale testing, improve coverage, and catch bugs before they ship.

​
Need Help?