Actor tasks - Introduction
The API endpoints described in this section enable you to create, manage, delete, and run Apify Actor tasks. For more information, see the Actor tasts documentation.
note
For all the API endpoints that accept the actorTaskId
parameter to
specify a task, you can pass either the task ID (e.g. HG7ML7M8z78YcAPEB
) or a tilde-separated
username of the task's owner and the task's name (e.g. janedoe~my-task
).
Some of the API endpoints return run objects. If any such run object contains usage in dollars, your effective unit pricing at the time of query has been used for computation of this dollar equivalent, and hence it should be used only for informative purposes.
You can learn more about platform usage in the documentation.
Get list of tasks
/actor-tasks
Create task
/actor-tasks
Get task
/actor-tasks/{actorTaskId}
Update task
/actor-tasks/{actorTaskId}
Delete task
/actor-tasks/{actorTaskId}
Get task input
/actor-tasks/{actorTaskId}/input
Update task input
/actor-tasks/{actorTaskId}/input
Get list of webhooks
/actor-tasks/{actorTaskId}/webhooks
Get list of task runs
/actor-tasks/{actorTaskId}/runs
Run task
/actor-tasks/{actorTaskId}/runs
Run task synchronously
/actor-tasks/{actorTaskId}/run-sync
Run task synchronously
/actor-tasks/{actorTaskId}/run-sync
Run task synchronously and get dataset items
/actor-tasks/{actorTaskId}/run-sync-get-dataset-items
Run task synchronously and get dataset items
/actor-tasks/{actorTaskId}/run-sync-get-dataset-items