QodexAI Platform Documentation

|

Kavya Ravella

|

Jan 2, 2025

Jan 2, 2025

QodexAI Platform Documentation
QodexAI Platform Documentation
QodexAI Platform Documentation

Getting Started with Qodex.ai

Overview

QodexAI is an AI-powered API testing platform that automates test generation, execution, and monitoring. It ensures accurate, up-to-date API validation with minimal manual effort and integrates seamlessly with CI/CD pipelines.

Getting Started with Qodex.ai

  1. Sign up at Qodex.ai.

  2. Upload API specifications (Swagger, OpenAPI, Supabase, Postman Collections).

  3. Create test scenarios using AI-powered generation or manual input.

  4. Run tests manually or schedule automated executions.

  5. Monitor and analyze test results with real-time alerts and reports.

Overview

QodexAI is an AI-powered API testing platform that automates test generation, execution, and monitoring. It ensures accurate, up-to-date API validation with minimal manual effort and integrates seamlessly with CI/CD pipelines.

Getting Started with Qodex.ai

  1. Sign up at Qodex.ai.

  2. Upload API specifications (Swagger, OpenAPI, Supabase, Postman Collections).

  3. Create test scenarios using AI-powered generation or manual input.

  4. Run tests manually or schedule automated executions.

  5. Monitor and analyze test results with real-time alerts and reports.

Overview

QodexAI is an AI-powered API testing platform that automates test generation, execution, and monitoring. It ensures accurate, up-to-date API validation with minimal manual effort and integrates seamlessly with CI/CD pipelines.

Getting Started with Qodex.ai

  1. Sign up at Qodex.ai.

  2. Upload API specifications (Swagger, OpenAPI, Supabase, Postman Collections).

  3. Create test scenarios using AI-powered generation or manual input.

  4. Run tests manually or schedule automated executions.

  5. Monitor and analyze test results with real-time alerts and reports.

Steps

Step 1: Connecting Your API

Head to the Collections tab, click on ”+” (Add Collection) to add your API collection. You can import collections in the following ways:

  1. Postman Exports

    • Directly import your Postman export into qodex.ai platform.

  2. Swagger Exports

    • Import your swagger.yaml or swagger.json file to add your API collection.

    • You can also use our SDK to generate a Swagger document.

  3. Export from Logs

    • Use our Rails SDK or Node.js SDK  to build your API collection directly from application logs.

  4. Generate Swagger from SDK

  5. Import from SupaBase

    • Import API collections directly from SupaBase with our seamless integration.

Note: Add the api_host value in the variables section of your collection.


Step 1: Connecting Your API

Head to the Collections tab, click on ”+” (Add Collection) to add your API collection. You can import collections in the following ways:

  1. Postman Exports

    • Directly import your Postman export into qodex.ai platform.

  2. Swagger Exports

    • Import your swagger.yaml or swagger.json file to add your API collection.

    • You can also use our SDK to generate a Swagger document.

  3. Export from Logs

    • Use our Rails SDK or Node.js SDK  to build your API collection directly from application logs.

  4. Generate Swagger from SDK

  5. Import from SupaBase

    • Import API collections directly from SupaBase with our seamless integration.

Note: Add the api_host value in the variables section of your collection.


Step 1: Connecting Your API

Head to the Collections tab, click on ”+” (Add Collection) to add your API collection. You can import collections in the following ways:

  1. Postman Exports

    • Directly import your Postman export into qodex.ai platform.

  2. Swagger Exports

    • Import your swagger.yaml or swagger.json file to add your API collection.

    • You can also use our SDK to generate a Swagger document.

  3. Export from Logs

    • Use our Rails SDK or Node.js SDK  to build your API collection directly from application logs.

  4. Generate Swagger from SDK

  5. Import from SupaBase

    • Import API collections directly from SupaBase with our seamless integration.

Note: Add the api_host value in the variables section of your collection.


Ship bug-free software, 200% faster, in 20% testing budget. No coding required

Ship bug-free software, 200% faster, in 20% testing budget. No coding required

Ship bug-free software, 200% faster, in 20% testing budget. No coding required

Step 2: Creating Test Scenarios

Navigate to the API Testing tab → Test Scenarios, then click “Add New Test Scenario” to get started.

There are two ways you can write tests:

  1. Create with AI

  2. Create Manually

Create with AI

Single Test Scenario

  • Select your collection and APIs

  • Describe your test scenario in plain English.

  • The system generates the scenario, and you’ll receive an email when it’s ready.

  • If manual input is needed, a yellow icon will prompt you for details.

Multiple Test Scenarios

  • Select your collection, APIs, and define requirements.

  • Choose scenario types: Positive, Negative, or Boundary.

  • Pick test types: Unit, Integration, or Security Tests.

  • Set complexity for Negative Test Scenarios: Low, Medium, or High.

  • Click Generate, and the system will create the scenarios automatically.

I recommend checking out our guide API Testing with AI in 10 minutes to learn more.



Create Manually

You can always build scenarios yourself. You will need to :

Add a test scenario title

  • Create a test case, add a title and select a collection and API

  • Go to the request data section and add URLs, params or body whatever is required.

  • Hit Save to get the response corresponding to the request data

  • Go to test rules section and add test rules - either pick from our suggestions or write them in plain English (qodex.ai will convert it to JavaScript)

  • You can create on Run and select an environment to run this test scenario

  • You can go to build section to see the build corresponding to this run



Organizing your tests:

Test Suites

You can group your related test scenarios into Test Suites. Select specific test scenarios and use the "+Create/Add to Test Suite" to either create a new suite or add to an existing one. These suites let you run multiple test scenarios together when needed.

Test Plans

You can combine your test suites and handle their automated execution. Select your test suites and add them to a plan through the "Create/Add to Test Plan" button. In the plan details you can specify:

  • How often your tests should run

  • Set start and end times for the testing period

  • Configure notification settings

    • Who receives them (Ensure the right team members know about test results)

    • How they are delivered (Slack, email, etc..,.)


Step 3: Running Tests

Run tests using your IDE, CLI, or Qodex.ai platform:

  • Automated scheduled run:

  • CI/CD Run:

  • Manual Run:

When tests fail, you'll see what went wrong and steps to fix it.

Step 2: Creating Test Scenarios

Navigate to the API Testing tab → Test Scenarios, then click “Add New Test Scenario” to get started.

There are two ways you can write tests:

  1. Create with AI

  2. Create Manually

Create with AI

Single Test Scenario

  • Select your collection and APIs

  • Describe your test scenario in plain English.

  • The system generates the scenario, and you’ll receive an email when it’s ready.

  • If manual input is needed, a yellow icon will prompt you for details.

Multiple Test Scenarios

  • Select your collection, APIs, and define requirements.

  • Choose scenario types: Positive, Negative, or Boundary.

  • Pick test types: Unit, Integration, or Security Tests.

  • Set complexity for Negative Test Scenarios: Low, Medium, or High.

  • Click Generate, and the system will create the scenarios automatically.

I recommend checking out our guide API Testing with AI in 10 minutes to learn more.



Create Manually

You can always build scenarios yourself. You will need to :

Add a test scenario title

  • Create a test case, add a title and select a collection and API

  • Go to the request data section and add URLs, params or body whatever is required.

  • Hit Save to get the response corresponding to the request data

  • Go to test rules section and add test rules - either pick from our suggestions or write them in plain English (qodex.ai will convert it to JavaScript)

  • You can create on Run and select an environment to run this test scenario

  • You can go to build section to see the build corresponding to this run



Organizing your tests:

Test Suites

You can group your related test scenarios into Test Suites. Select specific test scenarios and use the "+Create/Add to Test Suite" to either create a new suite or add to an existing one. These suites let you run multiple test scenarios together when needed.

Test Plans

You can combine your test suites and handle their automated execution. Select your test suites and add them to a plan through the "Create/Add to Test Plan" button. In the plan details you can specify:

  • How often your tests should run

  • Set start and end times for the testing period

  • Configure notification settings

    • Who receives them (Ensure the right team members know about test results)

    • How they are delivered (Slack, email, etc..,.)


Step 3: Running Tests

Run tests using your IDE, CLI, or Qodex.ai platform:

  • Automated scheduled run:

  • CI/CD Run:

  • Manual Run:

When tests fail, you'll see what went wrong and steps to fix it.

Step 2: Creating Test Scenarios

Navigate to the API Testing tab → Test Scenarios, then click “Add New Test Scenario” to get started.

There are two ways you can write tests:

  1. Create with AI

  2. Create Manually

Create with AI

Single Test Scenario

  • Select your collection and APIs

  • Describe your test scenario in plain English.

  • The system generates the scenario, and you’ll receive an email when it’s ready.

  • If manual input is needed, a yellow icon will prompt you for details.

Multiple Test Scenarios

  • Select your collection, APIs, and define requirements.

  • Choose scenario types: Positive, Negative, or Boundary.

  • Pick test types: Unit, Integration, or Security Tests.

  • Set complexity for Negative Test Scenarios: Low, Medium, or High.

  • Click Generate, and the system will create the scenarios automatically.

I recommend checking out our guide API Testing with AI in 10 minutes to learn more.



Create Manually

You can always build scenarios yourself. You will need to :

Add a test scenario title

  • Create a test case, add a title and select a collection and API

  • Go to the request data section and add URLs, params or body whatever is required.

  • Hit Save to get the response corresponding to the request data

  • Go to test rules section and add test rules - either pick from our suggestions or write them in plain English (qodex.ai will convert it to JavaScript)

  • You can create on Run and select an environment to run this test scenario

  • You can go to build section to see the build corresponding to this run



Organizing your tests:

Test Suites

You can group your related test scenarios into Test Suites. Select specific test scenarios and use the "+Create/Add to Test Suite" to either create a new suite or add to an existing one. These suites let you run multiple test scenarios together when needed.

Test Plans

You can combine your test suites and handle their automated execution. Select your test suites and add them to a plan through the "Create/Add to Test Plan" button. In the plan details you can specify:

  • How often your tests should run

  • Set start and end times for the testing period

  • Configure notification settings

    • Who receives them (Ensure the right team members know about test results)

    • How they are delivered (Slack, email, etc..,.)


Step 3: Running Tests

Run tests using your IDE, CLI, or Qodex.ai platform:

  • Automated scheduled run:

  • CI/CD Run:

  • Manual Run:

When tests fail, you'll see what went wrong and steps to fix it.

Step 4 - Keeping Track of Everything

Dashboard

Your dashboard provides comprehensive visibility into your testing operations.

  • Test coverage - Percentage of API under testing with enough test scenarios.

  • Tests Automated - Number of test scenarios running autonomously.

  • Success rate - Percentage of passing tests.

  • Cost savings - Financial benefits gained through automated vs manual testing (approx).

Three charts display:

  • Test distribution across systems

  • Test execution times

  • Types of tests in use

Check metrics anytime to track performance and make testing decisions.


Monitoring

You can track you API health in real-time. Set up monitoring sections by department or micro-service, create specific alert conditions, and define notification rules for when issues occur. The system will automatically notify relevant team members based on your configured escalation rules.

Build Reports

You can access detailed information about all test executions. View results of individual tests, performance data for test suites, and outcomes of scheduled test plans. The reporting system clearly identifies where issues occur in your testing workflow, helping you with troubleshooting.

Step 4 - Keeping Track of Everything

Dashboard

Your dashboard provides comprehensive visibility into your testing operations.

  • Test coverage - Percentage of API under testing with enough test scenarios.

  • Tests Automated - Number of test scenarios running autonomously.

  • Success rate - Percentage of passing tests.

  • Cost savings - Financial benefits gained through automated vs manual testing (approx).

Three charts display:

  • Test distribution across systems

  • Test execution times

  • Types of tests in use

Check metrics anytime to track performance and make testing decisions.


Monitoring

You can track you API health in real-time. Set up monitoring sections by department or micro-service, create specific alert conditions, and define notification rules for when issues occur. The system will automatically notify relevant team members based on your configured escalation rules.

Build Reports

You can access detailed information about all test executions. View results of individual tests, performance data for test suites, and outcomes of scheduled test plans. The reporting system clearly identifies where issues occur in your testing workflow, helping you with troubleshooting.

Step 4 - Keeping Track of Everything

Dashboard

Your dashboard provides comprehensive visibility into your testing operations.

  • Test coverage - Percentage of API under testing with enough test scenarios.

  • Tests Automated - Number of test scenarios running autonomously.

  • Success rate - Percentage of passing tests.

  • Cost savings - Financial benefits gained through automated vs manual testing (approx).

Three charts display:

  • Test distribution across systems

  • Test execution times

  • Types of tests in use

Check metrics anytime to track performance and make testing decisions.


Monitoring

You can track you API health in real-time. Set up monitoring sections by department or micro-service, create specific alert conditions, and define notification rules for when issues occur. The system will automatically notify relevant team members based on your configured escalation rules.

Build Reports

You can access detailed information about all test executions. View results of individual tests, performance data for test suites, and outcomes of scheduled test plans. The reporting system clearly identifies where issues occur in your testing workflow, helping you with troubleshooting.

Generate Documentation

API documentation in QodexAI stays current automatically. From the Collections section, use the "Generate Documentation" button to create comprehensive documentation of your APIs. The generated documents show all your APIs, their purposes, and how they interconnect. When you update your API collection, the documentation updates automatically to reflect any changes.

Generate Documentation

API documentation in QodexAI stays current automatically. From the Collections section, use the "Generate Documentation" button to create comprehensive documentation of your APIs. The generated documents show all your APIs, their purposes, and how they interconnect. When you update your API collection, the documentation updates automatically to reflect any changes.

Generate Documentation

API documentation in QodexAI stays current automatically. From the Collections section, use the "Generate Documentation" button to create comprehensive documentation of your APIs. The generated documents show all your APIs, their purposes, and how they interconnect. When you update your API collection, the documentation updates automatically to reflect any changes.

Need Help?

You can email us at support@qodex.ai or book a chat with our team link

Ready to make API testing less painful? Fire up Qodex.ai and let's go. 🚀

Need Help?

You can email us at support@qodex.ai or book a chat with our team link

Ready to make API testing less painful? Fire up Qodex.ai and let's go. 🚀

Need Help?

You can email us at support@qodex.ai or book a chat with our team link

Ready to make API testing less painful? Fire up Qodex.ai and let's go. 🚀

Get opensource free alternative of postman. Free upto 100 team members!

Get opensource free alternative of postman. Free upto 100 team members!

Get opensource free alternative of postman. Free upto 100 team members!

FAQs

Why should you choose Qodex.ai?

Why should you choose Qodex.ai?

Why should you choose Qodex.ai?

Remommended posts

Hire our AI Software Test Engineer

Qodex instantly connects you with skilled QA engineers, achieving 100% API test automation in days, not months.