Appev API

The Appev API allows you to programmatically trigger autonomous QA audits, retrieve chaos engine reports, and integrate usability scoring into your CI/CD pipeline.

Base URL: https://api.appev.com/v1

Authentication

Appev uses API keys to allow access to the API. You can register a new API key at our developer dashboard.

Appev expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: Bearer sk_live_...
POST /audits

Create an Audit

Triggers the Chaos Engine to begin testing a specific URL. You can specify which "Personas" to deploy.

Parameters

  • url string Required

    The HTTP/HTTPS URL of the staging or production environment to test.

  • goal string Required

    A natural language description of the success state (e.g., "Buy a pro plan").

  • personas array[string]

    List of persona IDs to simulate. Defaults to ['average_joe'].
    Options: novice, power_user, attacker, senior.

GET /audits/{id}

Retrieve an Audit

Retrieves the details of an audit, including the calculated Appev Score, video assets, and detected friction points.

Client Setup 
# Install the Appev CLI
npm install -g appev-cli

# Login
appev login --key=sk_live_51M...
Request 
POST https://api.appev.com/v1/audits \
  -H "Authorization: Bearer sk_test..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://staging.myapp.com",
    "goal": "Sign up and upgrade to Pro",
    "personas": [
      "novice",
      "attacker"
    ]
  }'
Response (201 Created) 
{
  "id": "audit_992ha8s81",
  "status": "queued",
  "estimated_duration": 120,
  "stream_url": "wss://api.appev.com/s/992..."
}
Request 
GET https://api.appev.com/v1/audits/audit_992ha8s81
Response (200 OK) 
{
  "id": "audit_992ha8s81",
  "status": "completed",
  "appev_score": 82,
  "issues": [
    {
      "severity": "high",
      "type": "ux_friction",
      "persona": "novice",
      "message": "User unable to find checkout btn",
      "timestamp": "00:04:12"
    }
  ],
  "video_url": "https://assets.appev.com/..."
}