OpenQAOpenQA
Configuration

SaaS Configuration

Configure your application for OpenQA to test. Just 3 fields to get started!

Quick Setup (3 Lines)

The minimum configuration requires just name, description, and URL:

bash
1curl -X POST http://localhost:3000/api/saas-config/quick \
2  -H "Content-Type: application/json" \
3  -d '{
4    "name": "My SaaS App",
5    "description": "E-commerce platform with user auth, product catalog, and checkout",
6    "url": "https://my-app.com"
7  }'

💡 Pro tip: The more detailed your description, the better tests OpenQA will generate. Include features, tech stack, and known problem areas.

Full Configuration

For more control, use the full configuration endpoint:

bash
1curl -X POST http://localhost:3000/api/saas-config \
2  -H "Content-Type: application/json" \
3  -d '{
4    "name": "My E-commerce App",
5    "description": "Online store with user accounts, product catalog, shopping cart, and Stripe checkout. Built with Next.js and PostgreSQL.",
6    "url": "https://my-store.com",
7    "repoUrl": "https://github.com/myorg/my-store",
8    "directives": [
9      "Focus on the checkout flow - it has had bugs before",
10      "Test with both logged-in and guest users",
11      "Check that discount codes work correctly",
12      "Verify email notifications are sent"
13    ],
14    "auth": {
15      "type": "session",
16      "credentials": {
17        "username": "test@example.com",
18        "password": "testpass"
19      }
20    }
21  }'

Configuration Fields

FieldRequiredDescription
name✅ YesYour application name
description✅ YesDetailed description of what your app does
url✅ YesURL where your app is running
repoUrlOptionalGitHub/GitLab repository URL for code analysis
directivesOptionalArray of custom instructions for the agent
authOptionalAuthentication configuration

Writing Good Descriptions

A good description helps OpenQA understand your app better:

❌ Bad Description

text
1"An e-commerce website"

✅ Good Description

text
1"E-commerce platform built with Next.js and Stripe. Features include:
2- User registration and login with email/password
3- Product catalog with search and filters
4- Shopping cart with persistent storage
5- Checkout with Stripe payment processing
6- Order history and tracking
7- Admin dashboard for inventory management
8 
9Known issues: The cart sometimes loses items on page refresh.
10Tech stack: Next.js 14, PostgreSQL, Prisma, Stripe, NextAuth.js"

Get Current Configuration

bash
1curl http://localhost:3000/api/saas-config
2 
3# Response:
4{
5  "name": "My E-commerce App",
6  "description": "...",
7  "url": "https://my-store.com",
8  "repoUrl": "https://github.com/myorg/my-store",
9  "directives": ["..."],
10  "auth": { "type": "session" }
11}

Update Configuration

You can update individual fields:

bash
1# Update URL
2curl -X PATCH http://localhost:3000/api/saas-config \
3  -H "Content-Type: application/json" \
4  -d '{"url": "https://staging.my-store.com"}'
5 
6# Add a directive
7curl -X POST http://localhost:3000/api/saas-config/directive \
8  -H "Content-Type: application/json" \
9  -d '{"directive": "Pay special attention to the new refund feature"}'

Next Steps

Directives

Custom instructions for the agent

Authentication

Configure login for testing