Cancel test run

Changed on

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Stops a test run that's still going and closes its browser session. The run ends with status set to cancelled.

Cancelling a run that already ended changes nothing and returns already_terminal set to true, so retrying is safe.

This is limited to 300 requests per minute per caller for each app. Some workspaces have a different limit.

<Note>This endpoint accepts a personal API key belonging to a user with editor access to the app. Read-only keys and workspace API keys are refused.</Note>

post/api/apps/{app_id}/testing-agent/executions/{execution_id}/cancel

Request

  • Base URL: https://app.base44.com
  • URL: https://app.base44.com/api/apps/{app_id}/testing-agent/executions/{execution_id}/cancel
  • Auth: HTTP bearer

Path parameters

app_idstring required

ID of the app.

execution_idstring required

ID of the run to cancel.

Response

The run is cancelled or had already ended.

successboolean required

Always true.

already_terminalboolean nullable

true when the run had already ended, so nothing changed. Left out when the run was cancelled.

Example response

{
  "success": true,
  "already_terminal": true
}

Changes