Apify: Stop Actor Run

Stopping or canceling a running or scheduled Apify Actor run by run ID while preserving completed output.

Tool ID: apify_stop_actor_run

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'apify_stop_actor_run',
  {
    "runId": "run_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute apify_stop_actor_run --input '{
  "runId": "run_123"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "id": "id_123",
    "status": "example"
  }
}

Use deepline describe apify_stop_actor_run --json for the latest machine-readable contract.

Input reference

Apify stop actor run input.

Name	Type	Required	Default	Details
`payload.runId`	`string`	Yes	—	—
`payload.gracefully`	`boolean`	No	`false`	Give the Actor time to persist state before stopping. Defaults to false.

Output reference

Apify stop actor run result envelope.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Current Apify Actor run state after stopping.
`result.data.id`	`string`	Yes	—	—
`result.data.status`	`string`	Yes	—	—
`result.data.actId`	`string`	No	—	—
`result.data.defaultDatasetId`	`string`	No	—	—
`result.data.startedAt`	`string`	No	—	—
`result.data.finishedAt`	`string \| null`	No	—	—
`result.data.next`	`object`	No	—	—
`result.data.next.getActorRun`	`object`	Yes	—	—
`result.data.next.getActorRun.tool`	`"apify_get_actor_run"`	Yes	—	—
`result.data.next.getActorRun.payload`	`object`	Yes	—	—
`result.data.next.getActorRun.payload.runId`	`string`	Yes	—	—
`result.meta`	`record`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation