Create a regression test

Create a regression test from a source report. Upload the report first with POST /v3/upload/signed-url, then pass the returned id as temporaryObjectKey.

post/regression-tests

Request

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

Request body

namestring required

The name of the regression test

additionalContextstring required

Free-form context given to the agent alongside the source report

inputFilenamestring required

The name of the uploaded source report file

inputFormat'MARKDOWN' | 'PDF'

The format of the source report. Inferred from the filename when omitted.

temporaryObjectKeystring uuid required

The id returned by POST /v3/upload/signed-url. The file must have been uploaded to the signed URL before calling this endpoint.

Example request

{
  "name": "Checkout regression test",
  "additionalContext": "Focus on the checkout flow.",
  "inputFilename": "report.pdf",
  "inputFormat": "PDF",
  "temporaryObjectKey": "00000000-0000-0000-0000-000000000000"
}

Response

idstring uuid required

The id of the regression test

namestring required

The name of the regression test

additionalContextstring required

Free-form context given to the agent alongside the source report

inputFilenamestring required

The name of the uploaded source report file

inputFormat'MARKDOWN' | 'PDF' required

The format of the source report

The status of the latest run of the regression test

signedUrlstring required

A signed URL to download the source report. It expires after a short period.

createdAtstring required

When the regression test was created

updatedAtstring required

When the regression test was last updated

hasMoreRunsboolean required

Whether more runs exist beyond the embedded runs. Page through all runs with GET /v3/regression-tests/{regressionTestId}/history.

Changes

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