Visual Compare

Run an AI prompt on a comparison

Ask AI, step two: re-runs the AI pass on the comparison with the given prompt (mode ignore or unignore). Percy processes it asynchronously; poll /ai-job, then re-read the comparison for the updated regions.

post/api/v1/visual-compare/comparisons/{id}/ai-recompute

Request

Base URL
https://toolkit.browserstack.com
Auth
API key in cookie _wdt_rails_session

Path parameters

idstring required

Request body

promptstring required

mode'ignore' | 'unignore'

Example request

{
  "prompt": "Ignore changes in icon colours.",
  "mode": "ignore"
}

Response

Recompute started

Example response

{
  "data": {
    "comparison_id": "13",
    "mode": "ignore"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.