QodexAI Platform Documentation
Getting Started with Qodex.ai
Overview
Qodex.ai is an AI-powered platform that automates API testing and security — from discovery to execution.
It scans your repo, auto-discovers endpoints, and generates unit, regression, and OWASP Top 10 tests — all in plain English. Tests evolve as your APIs change, and run anywhere: CI/CD, cloud, or locally via GitHub.
No manual scripts. No QA bottlenecks. Just fast, intelligent testing.
Getting Started with Qodex.ai
Sign up at app.qodex.ai.
Upload API specifications (Swagger, Postman Collections, or use our SDK for auto-discovery).
Create test scenarios using plain English.
Run tests manually, on a schedule, or through your CI/CD pipeline.
Monitor and analyze test results with real-time alerts and reports.
Sync with GitHub to version-control your tests, enable team collaboration, and support local/CI execution.
Overview
Qodex.ai is an AI-powered platform that automates API testing and security — from discovery to execution.
It scans your repo, auto-discovers endpoints, and generates unit, regression, and OWASP Top 10 tests — all in plain English. Tests evolve as your APIs change, and run anywhere: CI/CD, cloud, or locally via GitHub.
No manual scripts. No QA bottlenecks. Just fast, intelligent testing.
Getting Started with Qodex.ai
Sign up at app.qodex.ai.
Upload API specifications (Swagger, Postman Collections, or use our SDK for auto-discovery).
Create test scenarios using plain English.
Run tests manually, on a schedule, or through your CI/CD pipeline.
Monitor and analyze test results with real-time alerts and reports.
Sync with GitHub to version-control your tests, enable team collaboration, and support local/CI execution.
Overview
Qodex.ai is an AI-powered platform that automates API testing and security — from discovery to execution.
It scans your repo, auto-discovers endpoints, and generates unit, regression, and OWASP Top 10 tests — all in plain English. Tests evolve as your APIs change, and run anywhere: CI/CD, cloud, or locally via GitHub.
No manual scripts. No QA bottlenecks. Just fast, intelligent testing.
Getting Started with Qodex.ai
Sign up at app.qodex.ai.
Upload API specifications (Swagger, Postman Collections, or use our SDK for auto-discovery).
Create test scenarios using plain English.
Run tests manually, on a schedule, or through your CI/CD pipeline.
Monitor and analyze test results with real-time alerts and reports.
Sync with GitHub to version-control your tests, enable team collaboration, and support local/CI execution.
Steps
Step 1: Importing Your API
In the AI-Agent, Select the drop down in the top-left corner of your chat and
1. Upload a Swagger or Postman Collection File
Click Import Collection - Dropdown in the left corner
Upload your
swagger.json,swagger.yaml, or.postman_collection.json
2. Select from Existing Collections
Choose from previously imported collections in your workspace
3. Use the Qodex SDK for API Discovery
You can generate a Swagger JSON file using our script:
curl -sSL <https://raw.githubusercontent.com/qodex-ai/swagger-bot/refs/heads/main/run.sh> -o script.sh && chmod +x script.sh && ./script.sh --project-api-key YOUR_PROJECT_KEY
This method auto-generates a Swagger spec from your running backend (Rails, Node.js, etc.) and imports it into Qodex automatically.
Step 1: Importing Your API
In the AI-Agent, Select the drop down in the top-left corner of your chat and
1. Upload a Swagger or Postman Collection File
Click Import Collection - Dropdown in the left corner
Upload your
swagger.json,swagger.yaml, or.postman_collection.json
2. Select from Existing Collections
Choose from previously imported collections in your workspace
3. Use the Qodex SDK for API Discovery
You can generate a Swagger JSON file using our script:
curl -sSL <https://raw.githubusercontent.com/qodex-ai/swagger-bot/refs/heads/main/run.sh> -o script.sh && chmod +x script.sh && ./script.sh --project-api-key YOUR_PROJECT_KEY
This method auto-generates a Swagger spec from your running backend (Rails, Node.js, etc.) and imports it into Qodex automatically.
Step 1: Importing Your API
In the AI-Agent, Select the drop down in the top-left corner of your chat and
1. Upload a Swagger or Postman Collection File
Click Import Collection - Dropdown in the left corner
Upload your
swagger.json,swagger.yaml, or.postman_collection.json
2. Select from Existing Collections
Choose from previously imported collections in your workspace
3. Use the Qodex SDK for API Discovery
You can generate a Swagger JSON file using our script:
curl -sSL <https://raw.githubusercontent.com/qodex-ai/swagger-bot/refs/heads/main/run.sh> -o script.sh && chmod +x script.sh && ./script.sh --project-api-key YOUR_PROJECT_KEY
This method auto-generates a Swagger spec from your running backend (Rails, Node.js, etc.) and imports it into Qodex automatically.
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
Create via AI Agent
Start a chat with the assistant and type what you want to test in plain English.
Example Prompts:
Test the login flow with valid and invalid credentials
Check if the user creation API throws an error on missing email field
Verify token expiration and redirect behavior on protected routes
The AI Agent will respond with test scenario ideas. Confirm or refine them.
Once approved, click or type Save to add them to your project.
The system will automatically:
Generate the proposed Test Scenarios
Create Test Cases in each Scenario
Propose Test Rules for each test case
API Chaining will take place
You can edit the scenario, the test cases, add new or delete test cases and edit test rules
The code corresponding to the test scenario will also be available in the Code tab inside the test scenario
If additional information is needed, the AI will ask for it during the flow.
Everything happens inside the chat — no need to manually add test scenarios through the UI.
If you prefer to define your own test logic, follow these steps:
Navigate to the API Testing tab in app.qodex.ai
Click on Test Scenarios in the sidebar.
Press the “Add New Test Scenario” button in the top right.
Choose Manual from the available options.
Provide a title, choose API Collection and specific endpoint
You can add request data and test rules or click on “Create request data” and the AI-Agent will take care of it.
After saving:
Click Run and select an environment (e.g.,
.env.staging)View the result in the Build tab and debug if needed
The report will also be present in the Build Reports tab in app.qodex.ai
Step 2: Creating Test Scenarios
Create via AI Agent
Start a chat with the assistant and type what you want to test in plain English.
Example Prompts:
Test the login flow with valid and invalid credentials
Check if the user creation API throws an error on missing email field
Verify token expiration and redirect behavior on protected routes
The AI Agent will respond with test scenario ideas. Confirm or refine them.
Once approved, click or type Save to add them to your project.
The system will automatically:
Generate the proposed Test Scenarios
Create Test Cases in each Scenario
Propose Test Rules for each test case
API Chaining will take place
You can edit the scenario, the test cases, add new or delete test cases and edit test rules
The code corresponding to the test scenario will also be available in the Code tab inside the test scenario
If additional information is needed, the AI will ask for it during the flow.
Everything happens inside the chat — no need to manually add test scenarios through the UI.
If you prefer to define your own test logic, follow these steps:
Navigate to the API Testing tab in app.qodex.ai
Click on Test Scenarios in the sidebar.
Press the “Add New Test Scenario” button in the top right.
Choose Manual from the available options.
Provide a title, choose API Collection and specific endpoint
You can add request data and test rules or click on “Create request data” and the AI-Agent will take care of it.
After saving:
Click Run and select an environment (e.g.,
.env.staging)View the result in the Build tab and debug if needed
The report will also be present in the Build Reports tab in app.qodex.ai
Step 2: Creating Test Scenarios
Create via AI Agent
Start a chat with the assistant and type what you want to test in plain English.
Example Prompts:
Test the login flow with valid and invalid credentials
Check if the user creation API throws an error on missing email field
Verify token expiration and redirect behavior on protected routes
The AI Agent will respond with test scenario ideas. Confirm or refine them.
Once approved, click or type Save to add them to your project.
The system will automatically:
Generate the proposed Test Scenarios
Create Test Cases in each Scenario
Propose Test Rules for each test case
API Chaining will take place
You can edit the scenario, the test cases, add new or delete test cases and edit test rules
The code corresponding to the test scenario will also be available in the Code tab inside the test scenario
If additional information is needed, the AI will ask for it during the flow.
Everything happens inside the chat — no need to manually add test scenarios through the UI.
If you prefer to define your own test logic, follow these steps:
Navigate to the API Testing tab in app.qodex.ai
Click on Test Scenarios in the sidebar.
Press the “Add New Test Scenario” button in the top right.
Choose Manual from the available options.
Provide a title, choose API Collection and specific endpoint
You can add request data and test rules or click on “Create request data” and the AI-Agent will take care of it.
After saving:
Click Run and select an environment (e.g.,
.env.staging)View the result in the Build tab and debug if needed
The report will also be present in the Build Reports tab in app.qodex.ai
Step 3: Request Data, Environment Context & Test Rules
Qodex ensures your API test scenarios are highly accurate by dynamically generating requests, capturing responses, and validating behavior through flexible rules — all while respecting your selected environment.
Generating Request Data
When you create a test (via AI or manually):
In the Test Scenario you can click on “Create Request Data” on the top-right corner
Test data will be generated accordingly
The Agent will ask you questions, if you need additional information.
Writing and Applying Test Rules
Test rules validate that your APIs behave as expected.
How to Add Rules:
Navigate to any test scenario.
Scroll to the Test Rules section under any test case.
Choose from common suggestions like:
Status code is 200
Response body contains field
user_idResponse time is less than 1000ms
Or write rules in plain English — Qodex converts them into executable assertions.
Example: “If the token is missing, status should be 401.”
Step 3: Request Data, Environment Context & Test Rules
Qodex ensures your API test scenarios are highly accurate by dynamically generating requests, capturing responses, and validating behavior through flexible rules — all while respecting your selected environment.
Generating Request Data
When you create a test (via AI or manually):
In the Test Scenario you can click on “Create Request Data” on the top-right corner
Test data will be generated accordingly
The Agent will ask you questions, if you need additional information.
Writing and Applying Test Rules
Test rules validate that your APIs behave as expected.
How to Add Rules:
Navigate to any test scenario.
Scroll to the Test Rules section under any test case.
Choose from common suggestions like:
Status code is 200
Response body contains field
user_idResponse time is less than 1000ms
Or write rules in plain English — Qodex converts them into executable assertions.
Example: “If the token is missing, status should be 401.”
Step 3: Request Data, Environment Context & Test Rules
Qodex ensures your API test scenarios are highly accurate by dynamically generating requests, capturing responses, and validating behavior through flexible rules — all while respecting your selected environment.
Generating Request Data
When you create a test (via AI or manually):
In the Test Scenario you can click on “Create Request Data” on the top-right corner
Test data will be generated accordingly
The Agent will ask you questions, if you need additional information.
Writing and Applying Test Rules
Test rules validate that your APIs behave as expected.
How to Add Rules:
Navigate to any test scenario.
Scroll to the Test Rules section under any test case.
Choose from common suggestions like:
Status code is 200
Response body contains field
user_idResponse time is less than 1000ms
Or write rules in plain English — Qodex converts them into executable assertions.
Example: “If the token is missing, status should be 401.”
Step 4: Organizing Your Tests
How to Create a Test Plan:
Select Test Suites you want in a Test Plan and click on "+ Create/Add to Test Plan”
Give your plan a name and schedule tests it in the details tab in the right.
Define your schedule:
Daily, weekly, on deployment, or custom
Configure notification settings:
Add recipients (team members)
Choose delivery method (Slack, Email, etc.)
Save the plan — Qodex will now run your selected suites automatically on the schedule you defined.
Use Test Plans to stay ahead of regressions and performance issues without manual triggers.
Step 4: Organizing Your Tests
How to Create a Test Plan:
Select Test Suites you want in a Test Plan and click on "+ Create/Add to Test Plan”
Give your plan a name and schedule tests it in the details tab in the right.
Define your schedule:
Daily, weekly, on deployment, or custom
Configure notification settings:
Add recipients (team members)
Choose delivery method (Slack, Email, etc.)
Save the plan — Qodex will now run your selected suites automatically on the schedule you defined.
Use Test Plans to stay ahead of regressions and performance issues without manual triggers.
Step 4: Organizing Your Tests
How to Create a Test Plan:
Select Test Suites you want in a Test Plan and click on "+ Create/Add to Test Plan”
Give your plan a name and schedule tests it in the details tab in the right.
Define your schedule:
Daily, weekly, on deployment, or custom
Configure notification settings:
Add recipients (team members)
Choose delivery method (Slack, Email, etc.)
Save the plan — Qodex will now run your selected suites automatically on the schedule you defined.
Use Test Plans to stay ahead of regressions and performance issues without manual triggers.
Step 5: Running Tests
Once your test scenarios are ready, you can execute them using one of the following methods based on your workflow preferences:
Option 1: Run Tests from Qodex Web App
Go to the Test Scenarios or Test Suites tab.
Select the test(s) or suite you want to execute.
Click "Run"
Choose the environment (e.g., staging, production, QA) from your configured environments.
View results directly in the UI in the Build tab on the right or in the Build Reports section.
Option 2: Run Tests Locally with CLI
Ensure test scenarios are synced to GitHub from the Qodex UI.
Clone your repository locally.
Set up your
.envfile (e.g.,.env.localor.env.staging) with environment variables.Run tests using:
Option 3: Run Tests via CI/CD Pipelines
You can integrate Qodex with platforms like GitHub Actions, Jenkins, or CircleCI to run tests automatically on every push or deployment.
Step 5: Running Tests
Once your test scenarios are ready, you can execute them using one of the following methods based on your workflow preferences:
Option 1: Run Tests from Qodex Web App
Go to the Test Scenarios or Test Suites tab.
Select the test(s) or suite you want to execute.
Click "Run"
Choose the environment (e.g., staging, production, QA) from your configured environments.
View results directly in the UI in the Build tab on the right or in the Build Reports section.
Option 2: Run Tests Locally with CLI
Ensure test scenarios are synced to GitHub from the Qodex UI.
Clone your repository locally.
Set up your
.envfile (e.g.,.env.localor.env.staging) with environment variables.Run tests using:
Option 3: Run Tests via CI/CD Pipelines
You can integrate Qodex with platforms like GitHub Actions, Jenkins, or CircleCI to run tests automatically on every push or deployment.
Step 5: Running Tests
Once your test scenarios are ready, you can execute them using one of the following methods based on your workflow preferences:
Option 1: Run Tests from Qodex Web App
Go to the Test Scenarios or Test Suites tab.
Select the test(s) or suite you want to execute.
Click "Run"
Choose the environment (e.g., staging, production, QA) from your configured environments.
View results directly in the UI in the Build tab on the right or in the Build Reports section.
Option 2: Run Tests Locally with CLI
Ensure test scenarios are synced to GitHub from the Qodex UI.
Clone your repository locally.
Set up your
.envfile (e.g.,.env.localor.env.staging) with environment variables.Run tests using:
Option 3: Run Tests via CI/CD Pipelines
You can integrate Qodex with platforms like GitHub Actions, Jenkins, or CircleCI to run tests automatically on every push or deployment.
Step 6: Code Visibility and Sync with GitHub
All test code generated by Qodex is transparent and editable.
Viewing Test Code
Navigate to the Test Scenarios tab
Click on any test to open the preview panel.
Next to the preview, click on the "Code" tab to view the complete YAML and JavaScript-based test logic.
You can edit parameters, assertions, and logic directly in this view.
You can also sync your test scenarios to GitHub using the Sync to GitHub option. This exports the entire test suite into your repository under the /tests/qodex/ directory, allowing you to:
Version control and collaborate with your team
Run tests locally or through CI/CD pipelines
Keep your test logic aligned with your source code
Syncing with GitHub
After reviewing your tests, click “Sync to GitHub” to:
Push test definitions to your repo under
/tests/qodex/Enable version control and team collaboration
Allow tests to be run via GitHub Actions or locally with CLI
Step 6: Code Visibility and Sync with GitHub
All test code generated by Qodex is transparent and editable.
Viewing Test Code
Navigate to the Test Scenarios tab
Click on any test to open the preview panel.
Next to the preview, click on the "Code" tab to view the complete YAML and JavaScript-based test logic.
You can edit parameters, assertions, and logic directly in this view.
You can also sync your test scenarios to GitHub using the Sync to GitHub option. This exports the entire test suite into your repository under the /tests/qodex/ directory, allowing you to:
Version control and collaborate with your team
Run tests locally or through CI/CD pipelines
Keep your test logic aligned with your source code
Syncing with GitHub
After reviewing your tests, click “Sync to GitHub” to:
Push test definitions to your repo under
/tests/qodex/Enable version control and team collaboration
Allow tests to be run via GitHub Actions or locally with CLI
Step 6: Code Visibility and Sync with GitHub
All test code generated by Qodex is transparent and editable.
Viewing Test Code
Navigate to the Test Scenarios tab
Click on any test to open the preview panel.
Next to the preview, click on the "Code" tab to view the complete YAML and JavaScript-based test logic.
You can edit parameters, assertions, and logic directly in this view.
You can also sync your test scenarios to GitHub using the Sync to GitHub option. This exports the entire test suite into your repository under the /tests/qodex/ directory, allowing you to:
Version control and collaborate with your team
Run tests locally or through CI/CD pipelines
Keep your test logic aligned with your source code
Syncing with GitHub
After reviewing your tests, click “Sync to GitHub” to:
Push test definitions to your repo under
/tests/qodex/Enable version control and team collaboration
Allow tests to be run via GitHub Actions or locally with CLI
Need Help?
Email support@qodex.ai or book a session with our team.
Qodex is here to make API testing and security effortless. 🚀
Need Help?
Email support@qodex.ai or book a session with our team.
Qodex is here to make API testing and security effortless. 🚀
Need Help?
Email support@qodex.ai or book a session with our team.
Qodex is here to make API testing and security effortless. 🚀
FAQs
Why should you choose Qodex.ai?
Why should you choose Qodex.ai?
Why should you choose Qodex.ai?
Remommended posts
Discover, Test, and Secure your APIs — 10x Faster.
Product
All Rights Reserved.
Copyright © 2025 Qodex
Discover, Test, and Secure your APIs — 10x Faster.
Product
All Rights Reserved.
Copyright © 2025 Qodex
Discover, Test, and Secure your APIs — 10x Faster.
Product
All Rights Reserved.
Copyright © 2025 Qodex