Apify: Run Actor Sync

Run an Apify scraper actor with your input and wait for its scraped records, for a known site, profile or platform.

Tool ID: apify_run_actor_sync

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_run_actor_sync',
  {
    "actorId": "actor_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute apify_run_actor_sync --input '{
  "actorId": "actor_123"
}' --json

Example response

The static output schema lacks the details for a reliable example. Use deepline describe apify_run_actor_sync --json for the complete live contract.

Input reference

Apify run actor sync input.

Name	Type	Required	Default	Details
`payload.actorId`	`string`	Yes	—	—
`payload.input`	`unknown`	No	—	—
`payload.params`	`object`	No	—	—
`payload.timeoutMs`	`number`	No	—	Must be greater than 0. Maximum: 780000.

Output reference

Apify sync result envelope.

Name	Type	Required	Default	Details
`result.data`	`array \| object`	Yes	—	Apify sync result or pending run identifiers.
`result.data.state`	`"awaiting_apify"`	Yes	—	—
`result.data.actorId`	`string`	Yes	—	—
`result.data.runId`	`string`	Yes	—	—
`result.data.datasetId`	`string \| null`	Yes	—	—
`result.data.next`	`object`	Yes	—	—
`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.data.next.getDatasetItems`	`object \| null`	Yes	—	—
`result.data.next.getDatasetItems.tool`	`"apify_get_dataset_items"`	Yes	—	—
`result.data.next.getDatasetItems.payload`	`object`	Yes	—	—
`result.data.next.getDatasetItems.payload.datasetId`	`string`	Yes	—	—
`result.data.next.getDatasetItems.payload.offset`	`integer`	No	—	—
`result.data.next.getDatasetItems.payload.limit`	`integer`	No	—	—
`result.data.next.getDatasetItems.payload.desc`	`boolean`	No	—	—
`result.data.next.getDatasetItems.payload.clean`	`boolean`	No	—	—
`result.data.next.getDatasetItems.payload.fields`	`string`	No	—	—
`result.data.next.getDatasetItems.payload.omit`	`string`	No	—	—
`result.data.next.getDatasetItems.payload.unwind`	`string`	No	—	—
`result.data.next.getDatasetItems.payload.flatten`	`string`	No	—	—
`result.data.next.getDatasetItems.payload.view`	`string`	No	—	—
`result.data.next.getDatasetItems.payload.skipHidden`	`boolean`	No	—	—
`result.data.next.getDatasetItems.payload.skipEmpty`	`boolean`	No	—	—
`result.data.next.getDatasetItems.payload.skipHeaderRow`	`boolean`	No	—	—
`result.data.next.getDatasetItems.payload.delimiter`	`string`	No	—	—
`result.data.next.getDatasetItems.payload.bom`	`boolean`	No	—	—
`result.data.next.getDatasetItems.payload.format`	`"json" \| "jsonl" \| "csv" \| "xlsx" \| "xml" \| "html" \| "rss"`	No	—	—
`result.data.next.getDatasetItems.payload.attachment`	`boolean`	No	—	—
`result.data.next.getDatasetItems.payload.forceCloud`	`boolean`	No	—	—
`result.meta`	`record`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: provider_usage (provider usage).
Estimated Deepline credits: 0 per pricing unit.

​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