Skip to main content

Documentation

REST API

Create a key in Profile → API, then launch a study and poll its status. The base URL is https://litmusrun.com.

POST /api/v1/studies

Launches a panel. Requires Authorization: Bearer lr_… and an Idempotency-Key. Retries with the same key return the same study.

curl -X POST https://litmusrun.com/api/v1/studies \
  -H "Authorization: Bearer lr_<your_api_key>" \
  -H "Idempotency-Key: deploy-$UNIQUE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "projectId": "<project_id>",
    "artifactUrl": "https://staging.yourapp.com",
    "missionGoal": "Complete signup without reading the docs",
    "studyType": "standard",
    "agentCount": 12
  }'
  • studyType: smoke (10 credits), standard (20), or deep (40, Business+).
  • agentCount is capped by your plan.

GET /api/v1/studies/{id}

Returns the study you own: status, verdict (ship, fix_first, or dont_ship), readiness score, a one-line summary, and shareUrl when a public link is active. Verdict fields stay empty until the panel finishes.

curl https://litmusrun.com/api/v1/studies/<study_id> \
  -H "Authorization: Bearer lr_<your_api_key>"

MCP is not part of this API. Back to docs