Captchas

Solve captcha(s)

Solves captcha(s) for the session. If pageId, url, or taskId is provided, solves that specific captcha. If no parameters are provided, solves all detected captchas. Use this when autoCaptchaSolving is disabled in stealthConfig.

post/v1/sessions/{sessionId}/captchas/solve

Path parameters

sessionIdstring uuid required

Session ID

Request body

pageIdstring

The page ID where the captcha is located

taskIdstring

The task ID of the specific captcha to solve

urlstring

The URL where the captcha is located

Response

Default Response

messagestring

Response message

successboolean required

Whether the action was successful

Changes

Changed in 4 of the 54 revisions of this API.34

    • request body became optional

      request-body-became-optional

    • request body became required

      request-body-became-required

    • added the pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ to the path request parameter sessionId

      request-parameter-pattern-added

    • for the path request parameter sessionId, the format changed from no format to uuid

      request-parameter-type-changed

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • endpoint added

      endpoint-added