BIbirdeatsbug
Visual Compare

Draft an AI prompt that ignores differences like the picked one

Ask AI, step one: given the ids of the AI regions the user picked on a finished comparison, returns the prompt Percy AI drafted to ignore similar differences. Waits for the draft (a few seconds).

post/api/v1/visual-compare/comparisons/{id}/ignore-prompt

Request

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

Path parameters

idstring required

Request body

region_idsstring[] required

Percy AI region ids of the differences to ignore (alphanumeric)

Example request

{
  "region_ids": [
    "I0R7PC"
  ]
}

Response

Prompt drafted

Example response

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

Changes

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