Pause 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 pending or running and closes its browser session. The run ends with status set to paused and no failure_reason, which is how you tell it apart from a run paused for running out of credits. It gets no report. A paused run can't be resumed, so run the test again to start over.

A run that's already analyzing isn't paused, because its browser session is over. The call returns already_terminal set to true and the run goes on to get its report. A run that already ended also 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}/pause

Request

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

Path parameters

app_idstring required

ID of the app.

execution_idstring required

ID of the run to pause.

Response

The run is paused, or nothing changed.

successboolean required

Always true.

already_terminalboolean nullable

true when nothing changed: the run had already ended, or it was analyzing. Left out when the run was paused.

Example response

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

Changes