API Reference

One-shot endpoint: give it a URL, get back a job tracking handle. The AI auto-scopes the test based on the URL, optional feature description, and any previous failures for the same project.

Example — basic test

curl -X POST https://testmyvibes.com/v1/replit/test \
  -H "Authorization: Bearer tmv_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://my-app.replit.app"}'

Example — focused test

curl -X POST https://testmyvibes.com/v1/replit/test \
  -H "Authorization: Bearer tmv_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://my-app.replit.app",
    "feature": "test the new checkout flow",
    "webhookUrl": "https://my-server.com/webhook",
    "priority": "urgent"
  }'

Response 201

{
  "jobId": "j_abc123",
  "projectId": "p_xyz789",
  "status": "pending",
  "estimatedCompletionMinutes": 60,
  "creditsDeducted": 2,
  "creditsCharged": 2,
  "creditsRemaining": 18,
  "checklistItemCount": 7,
  "jobType": "Payment Flow",
  "isReplitApp": true,
  "regressionItemsIncluded": 3,
  "statusUrl": "https://testmyvibes.com/v1/replit/status/j_abc123",
  "reportUrl": "https://testmyvibes.com/v1/jobs/j_abc123/report",
  "dashboardReportUrl": "https://testmyvibes.com/projects/p_xyz789/jobs/j_abc123"
}

creditsDeducted and creditsCharged always carry the same value — pick whichever name you prefer. reportUrl is the JSON API endpoint for fetching the report; dashboardReportUrl is the operator-facing page to deep-link humans to.

Errors

// 402 — out of credits
{
  "error": "Insufficient credits",
  "code": "INSUFFICIENT_CREDITS",
  "creditsRequired": 4,
  "creditsAvailable": 1,
  "creditsShort": 3
}

// 401 — bad/missing API key
{ "error": "Invalid API key", "code": "UNAUTHORIZED" }

Branch on the code field, not error. Code values are stable across versions.

Real-time progress with percentage, item-level counts, and the full report inline when complete. Poll this every 30-60 seconds or use webhooks for push-based updates.

Example

curl https://testmyvibes.com/v1/replit/status/j_abc123 \
  -H "Authorization: Bearer tmv_live_abc123"

Response — in progress

{
  "jobId": "j_abc123",
  "status": "in_progress",
  "statusMessage": "Testing in progress — 4/7 items checked",
  "progressPercent": 58,
  "url": "https://my-app.replit.app",
  "jobType": "Payment Flow",
  "checklist": {
    "totalItems": 7,
    "checkedItems": 4,
    "passedItems": 3,
    "failedItems": 1,
    "skippedItems": 0
  }
}

Response — completed (includes full report)

{
  "jobId": "j_abc123",
  "status": "completed",
  "statusMessage": "Testing complete",
  "progressPercent": 100,
  "result": {
    "overallStatus": "fail",
    "passCount": 5,
    "failCount": 2,
    "skipCount": 0,
    "summary": "Checkout flow mostly works but...",
    "items": [
      {
        "id": "ci_1",
        "description": "Complete checkout with valid card",
        "status": "pass",
        "note": "Works correctly"
      }
    ]
  }
}

After fixing bugs, call this to prepare a focused regression test. The next deploy hook or test submission will auto-include verification items for the fixed bugs.

Request Body

{
  "projectId": "p_abc123",
  "fixedBugIds": ["ci_3", "ci_5"],
  "fixedDescriptions": ["Login button is unresponsive on mobile"]
}

fixedBugIds references item IDs from the last test's failed items. fixedDescriptions lets you describe fixes in plain text. Provide at least one.

Response

{
  "message": "Regression test prepared...",
  "regressionItems": 2,
  "descriptions": ["Login button is unresponsive on mobile", "Cart total shows wrong currency"],
  "projectId": "p_abc123"
}

Request Body

curl -X POST https://testmyvibes.com/v1/jobs \
  -H "Authorization: Bearer tmv_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://myapp.com",
    "title": "Test checkout flow",
    "description": "Complete a purchase with a test card",
    "jobType": "payment_flow",
    "priority": "normal"
  }'

const res = await fetch('https://testmyvibes.com/v1/jobs', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer tmv_live_abc123',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    url: 'https://myapp.com',
    title: 'Test checkout flow',
    description: 'Complete a purchase with a test card',
    jobType: 'payment_flow',
    priority: 'normal'
  })
});
const data = await res.json();

import requests

res = requests.post(
    "https://testmyvibes.com/v1/jobs",
    headers={"Authorization": "Bearer tmv_live_abc123"},
    json={
        "url": "https://myapp.com",
        "title": "Test checkout flow",
        "description": "Complete a purchase with a test card",
        "jobType": "payment_flow",
        "priority": "normal"
    }
)
data = res.json()

{
  "jobId": "j_abc123",
  "status": "pending",
  "estimatedCompletionMinutes": 15,
  "creditsDeducted": 3,
  "checklistItemCount": 8
}

Query Parameters

curl "https://testmyvibes.com/v1/jobs?status=completed&limit=10" \
  -H "Authorization: Bearer tmv_live_abc123"

const res = await fetch('https://testmyvibes.com/v1/jobs?status=completed&limit=10', {
  headers: { 'Authorization': 'Bearer tmv_live_abc123' }
});
const data = await res.json();

import requests

res = requests.get(
    "https://testmyvibes.com/v1/jobs",
    headers={"Authorization": "Bearer tmv_live_abc123"},
    params={"status": "completed", "limit": 10}
)
data = res.json()

{
  "jobs": [
    {
      "id": "j_abc123",
      "status": "completed",
      "title": "Test checkout flow",
      "url": "https://myapp.com",
      "jobType": "payment_flow",
      "createdAt": "2026-03-14T20:30:00Z",
      "reportId": "r_def456"
    }
  ],
  "total": 42,
  "limit": 10,
  "offset": 0
}

Path Parameters

curl https://testmyvibes.com/v1/jobs/j_abc123 \
  -H "Authorization: Bearer tmv_live_abc123"

const res = await fetch('https://testmyvibes.com/v1/jobs/j_abc123', {
  headers: { 'Authorization': 'Bearer tmv_live_abc123' }
});
const data = await res.json();

import requests

res = requests.get(
    "https://testmyvibes.com/v1/jobs/j_abc123",
    headers={"Authorization": "Bearer tmv_live_abc123"}
)
data = res.json()

{
  "id": "j_abc123",
  "status": "completed",
  "title": "Test checkout flow",
  "url": "https://myapp.com",
  "jobType": "payment_flow",
  "creditsUsed": 3,
  "slaMinutes": 60,
  "createdAt": "2026-03-14T20:30:00Z",
  "claimedAt": "2026-03-14T20:31:00Z",
  "completedAt": "2026-03-14T20:42:00Z",
  "reportId": "r_def456"
}

curl https://testmyvibes.com/v1/jobs/j_abc123/report \
  -H "Authorization: Bearer tmv_live_abc123"

const res = await fetch('https://testmyvibes.com/v1/jobs/j_abc123/report', {
  headers: { 'Authorization': 'Bearer tmv_live_abc123' }
});
const data = await res.json();

import requests

res = requests.get(
    "https://testmyvibes.com/v1/jobs/j_abc123/report",
    headers={"Authorization": "Bearer tmv_live_abc123"}
)
data = res.json()

{
  "id": "r_def456",
  "overallStatus": "fail",
  "passCount": 5,
  "failCount": 2,
  "skipCount": 0,
  "checkerSummary": "Checkout flow has two critical issues...",
  "items": [
    {
      "id": "ci_001",
      "description": "Submit form with empty email",
      "status": "fail",
      "checkerNote": "No validation shown — form submits silently",
      "screenshotUrl": "https://storage.example.com/ss_001.png"
    },
    {
      "id": "ci_002",
      "description": "Complete purchase with test card",
      "status": "pass",
      "checkerNote": "Worked perfectly, confirmation page shown"
    }
  ],
  "recordingUrl": "https://storage.example.com/rec_001.webm",
  "checkerRating": 4.8,
  "createdAt": "2026-03-14T20:42:00Z"
}

curl https://testmyvibes.com/v1/jobs/j_abc123/ai-report \
  -H "Authorization: Bearer tmv_live_abc123"

import requests

res = requests.get(
    "https://testmyvibes.com/v1/jobs/j_abc123/ai-report",
    headers={"Authorization": "Bearer tmv_live_abc123"}
)
data = res.json()

{
  "id": "ar_abc123",
  "jobId": "j_abc123",
  "status": "completed",
  "executiveSummary": "The app has 2 critical issues...",
  "healthScore": 62,
  "bugs": [
    {
      "title": "Login form submit fails silently",
      "severity": "critical",
      "description": "Clicking submit with valid credentials shows no feedback",
      "reproductionSteps": ["Navigate to /login", "Enter valid credentials", "Click submit"],
      "suggestedFix": "Add error handling to the fetch call in login handler"
    }
  ],
  "passCount": 4,
  "failCount": 2,
  "skipCount": 0,
  "strengths": ["Clean responsive layout", "Fast page load times"],
  "recommendations": ["Add form validation feedback", "Implement loading states"]
}

Returns 202 if the AI report is still being generated. Returns 404 if the job is not yet completed.

curl -X POST https://testmyvibes.com/v1/jobs/j_abc123/retest \
  -H "Authorization: Bearer tmv_live_abc123"

import requests

res = requests.post(
    "https://testmyvibes.com/v1/jobs/j_abc123/retest",
    headers={"Authorization": "Bearer tmv_live_abc123"}
)
data = res.json()

{
  "jobId": "j_xyz789",
  "parentJobId": "j_abc123",
  "status": "pending",
  "creditsDeducted": 3
}

curl -X POST https://testmyvibes.com/v1/jobs/bulk \
  -H "Authorization: Bearer tmv_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "jobs": [
      { "url": "https://myapp.com/login", "title": "Test login", "description": "Sign in with test creds", "jobType": "auth_flow" },
      { "url": "https://myapp.com/checkout", "title": "Test checkout", "description": "Complete a purchase", "jobType": "payment_flow" }
    ]
  }'

import requests

res = requests.post(
    "https://testmyvibes.com/v1/jobs/bulk",
    headers={"Authorization": "Bearer tmv_live_abc123"},
    json={
        "jobs": [
            {"url": "https://myapp.com/login", "title": "Test login", "description": "Sign in", "jobType": "auth_flow"},
            {"url": "https://myapp.com/checkout", "title": "Test checkout", "description": "Buy something", "jobType": "payment_flow"}
        ]
    }
)
data = res.json()

{
  "batchId": "batch_abc123",
  "jobIds": ["j_001", "j_002"],
  "totalCreditsDeducted": 5,
  "estimatedCompletionMinutes": 20
}

curl https://testmyvibes.com/v1/jobs/bulk/batch_abc123 \
  -H "Authorization: Bearer tmv_live_abc123"

{
  "batchId": "batch_abc123",
  "overallStatus": "in_progress",
  "totalJobs": 2,
  "completedJobs": 1,
  "passCount": 1,
  "failCount": 0,
  "jobs": [
    { "id": "j_001", "status": "completed" },
    { "id": "j_002", "status": "claimed" }
  ]
}

curl https://testmyvibes.com/v1/projects \
  -H "Authorization: Bearer tmv_live_abc123"

import requests

res = requests.get(
    "https://testmyvibes.com/v1/projects",
    headers={"Authorization": "Bearer tmv_live_abc123"}
)
data = res.json()

{
  "projects": [
    {
      "id": "p_abc123",
      "name": "My SaaS App",
      "defaultUrl": "https://myapp.com",
      "jobCount": 42,
      "passRate": 0.85,
      "webhookSecretRotatedAt": "2026-04-12T09:00:00.000Z",
      "webhookSecretRotations": [
        { "at": "2026-04-12T09:00:00.000Z", "userId": "u_123" },
        { "at": "2026-03-01T17:30:00.000Z", "userId": "u_123" }
      ],
      "createdAt": "2026-01-15T10:00:00Z"
    }
  ]
}

webhookSecretRotations lists up to the 5 most recent webhook-secret rotations (most recent first). Each entry has an at ISO timestamp and the userId who triggered the rotation (null for legacy entries). The field is null when no webhook is configured.

Request Body

curl -X POST https://testmyvibes.com/v1/projects \
  -H "Authorization: Bearer tmv_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My SaaS App",
    "defaultUrl": "https://myapp.com",
    "defaultJobType": "General QA"
  }'

import requests

res = requests.post(
    "https://testmyvibes.com/v1/projects",
    headers={"Authorization": "Bearer tmv_live_abc123"},
    json={
        "name": "My SaaS App",
        "defaultUrl": "https://myapp.com",
        "defaultJobType": "General QA"
    }
)
data = res.json()

{
  "projectId": "p_new123",
  "name": "My SaaS App",
  "deployHookUrl": "https://testmyvibes.com/v1/hooks/deploy/dhk_xxxxxxxx"
}

Request Body

curl -X PATCH https://testmyvibes.com/v1/projects/p_abc123 \
  -H "Authorization: Bearer tmv_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "webhookUrl": "https://hooks.example.com/tmv",
    "subscribedWebhookEvents": ["job.completed", "job.ai_report_ready"]
  }'

{
  "projectId": "p_abc123",
  "name": "My SaaS App",
  "description": null,
  "defaultUrl": "https://myapp.com",
  "defaultJobType": "General QA",
  "defaultSlaMinutes": 60,
  "webhookUrl": "https://hooks.example.com/tmv",
  "webhookSecretRotatedAt": "2026-04-19T12:00:00.000Z",
  "webhookSecretRotations": [
    { "at": "2026-04-19T12:00:00.000Z", "userId": "u_123" },
    { "at": "2026-03-01T17:30:00.000Z", "userId": "u_123" }
  ],
  "subscribedWebhookEvents": ["job.completed", "job.ai_report_ready"],
  "updatedAt": "2026-04-19T12:00:00.000Z"
}

Returns 404 NOT_FOUND if the project doesn't exist or belongs to a different API key. The webhookSecret itself is never returned by this endpoint. webhookSecretRotations lists up to the 5 most recent webhook-secret rotations (most recent first); each entry has an at ISO timestamp and the userId who triggered it (null for legacy entries). The field is null when no webhook is configured.

curl https://testmyvibes.com/v1/projects/p_abc123/history \
  -H "Authorization: Bearer tmv_live_abc123"

{
  "projectId": "p_abc123",
  "projectName": "My SaaS App",
  "totalTests": 12,
  "passCount": 9,
  "failCount": 3,
  "passRate": 75,
  "averageHealthScore": 72,
  "latestFailures": [
    { "id": "ci_3", "description": "Login form shows error on submit", "severity": "Critical" }
  ],
  "regressions": ["Cart total calculates wrong with discount"],
  "trend": [
    { "jobId": "j_abc", "overallStatus": "FAIL", "healthScore": 62, "passCount": 5, "failCount": 2, "testedAt": "..." }
  ],
  "preparedRegressions": [
    { "bugIds": ["ci_3"], "descriptions": ["Login form shows error on submit"], "preparedAt": "..." }
  ]
}

trend shows the last 10 tests. regressions lists items that passed in the previous test but failed in the latest. preparedRegressions shows bug fixes queued for verification on the next deploy.

curl https://testmyvibes.com/v1/credits \
  -H "Authorization: Bearer tmv_live_abc123"

import requests

res = requests.get(
    "https://testmyvibes.com/v1/credits",
    headers={"Authorization": "Bearer tmv_live_abc123"}
)
data = res.json()

{
  "available": 47,
  "used": 28,
  "total": 75,
  "expiringCredits": [
    { "amount": 10, "expiresAt": "2026-06-14T00:00:00Z" }
  ]
}