ESescape
RegressionTests
Beta

Reply to a clarification

Answer the clarification question asked by the agent during a run. The run must be waiting for a clarification (status CLARIFICATION_REQUIRED or CLARIFICATION_GIVEN).

post/regression-tests/{regressionTestId}/runs/{runId}/clarifications

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Path parameters

regressionTestIdstring uuid required

The regression test ID

Example:00000000-0000-0000-0000-000000000000
runIdstring uuid required

The regression test run ID

Example:00000000-0000-0000-0000-000000000001

Request body

contentstring required

The answer to the clarification question

Example request

{
  "content": "The checkout flow now uses the v2 API."
}

Response

OK

idstring uuid required

The id of the regression test run

status'CANCELLED' | 'CLARIFICATION_GIVEN' | 'CLARIFICATION_REQUIRED' | 'ERROR' | 'NOT_STARTED' | 'RUNNING' | 'TEST_FAILED' | 'TEST_PASSED' required

The status of the run

clarificationQuestionstring nullable required

The question the agent asked, when the run needs a clarification

clarificationAnswerstring nullable required

The answer given to the clarification question

validationIdstring nullable required

The id of the validation (scan) that ran the test

createdAtstring required

When the run was created

updatedAtstring required

When the run was last updated

Changes

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