OpenQAOpenQA
API Reference

SaaS Config API

API endpoints for configuring your target application.

GET/api/saas-config

Get the current SaaS configuration

Response
{
  "name": "My E-commerce App",
  "description": "Online store with user accounts...",
  "url": "https://my-store.com",
  "repoUrl": "https://github.com/myorg/my-store",
  "directives": [
    "Focus on checkout flow",
    "Test with guest users"
  ],
  "auth": {
    "type": "session"
  }
}
POST/api/saas-config

Set the full SaaS configuration

Request Body
{
  "name": "My E-commerce App",
  "description": "Online store with user accounts, product catalog, shopping cart, and Stripe checkout",
  "url": "https://my-store.com",
  "repoUrl": "https://github.com/myorg/my-store",
  "directives": [
    "Focus on the checkout flow",
    "Test with both logged-in and guest users"
  ],
  "auth": {
    "type": "session",
    "credentials": {
      "username": "test@example.com",
      "password": "testpass"
    }
  }
}
Response
{
  "success": true,
  "message": "Configuration saved"
}
POST/api/saas-config/quick

Quick setup with minimal configuration

Request Body
{
  "name": "My SaaS App",
  "description": "E-commerce platform with user auth, product catalog, and checkout",
  "url": "https://my-app.com"
}
Response
{
  "success": true,
  "message": "Quick configuration saved"
}
PATCH/api/saas-config

Update specific configuration fields

Request Body
{
  "url": "https://staging.my-store.com"
}
Response
{
  "success": true,
  "message": "Configuration updated"
}
POST/api/saas-config/directive

Add a new directive

Request Body
{
  "directive": "Pay special attention to the new refund feature"
}
Response
{
  "success": true,
  "directives": [
    "Focus on checkout flow",
    "Pay special attention to the new refund feature"
  ]
}
POST/api/saas-config/repository

Set the repository URL for code analysis

Request Body
{
  "url": "https://github.com/myorg/my-app"
}
Response
{
  "success": true,
  "message": "Repository URL set. Clone will start on next analysis."
}
POST/api/saas-config/local-path

Set a local path for code analysis

Request Body
{
  "path": "/path/to/your/project"
}
Response
{
  "success": true,
  "message": "Local path set"
}

Configuration Fields

FieldTypeRequiredDescription
namestringYesApplication name
descriptionstringYesDetailed description
urlstringYesApplication URL
repoUrlstringNoRepository URL
directivesstring[]NoCustom instructions
authobjectNoAuthentication config