Docs
Open Lodol
DocumentationIntegrationsAPI

Apify

App · AI Agents · 5 actions

Manage the Actors in your Apify account: list them, create new ones, read their details, update their settings, and delete the ones you no longer need.

Actions

ActionWhat it does
Create ActorCreate a new Apify Actor.
Delete ActorPermanently delete an Apify Actor, along with its versions and builds.
Get ActorGet the full details of a single Apify Actor, including its versions, default run options, and run statistics.
List ActorsList the Apify Actors (web scrapers and automations) you created or used, with optional sorting and paging.
Update ActorUpdate an Apify Actor's settings.

Create Actor

Create a new Apify Actor. Every Actor needs source code, so you can supply a script, point it at a Git repository, or leave both empty to start from a placeholder script you can edit in Apify Console.

Inputs

NamenametextRequired
Identifier for the Actor, using lowercase letters, numbers, and hyphens (for example, instagram-scraper). Must be unique in your account.
Titletitletext
[Optional] Human-readable name shown in Apify Store and Console (for example, Instagram Scraper)
Descriptiondescriptiontext
[Optional] Short description of what the Actor does
Publish to Apify Storeis_publictrue/false
[Optional] When true, the Actor is listed publicly in Apify Store (default: false, private to you)
Version numberversion_numbertext
[Optional] Version to create, as MAJOR.MINOR with each part between 0 and 99 (default: 0.0)
Source codesource_codetext
[Optional] JavaScript source saved as the Actor's src/main.js. Cannot be combined with a Git repository URL.
Git repository URLgit_repo_urltext
[Optional] Clone the Actor's source from this Git repository instead of supplying code. Cannot be combined with source code.

Outputs

categorieslist
created_attext
default_run_optionsobject
descriptiontext
idtext
is_deprecatedtrue/false
is_publictrue/false
modified_attext
nametext
statsobject
titletext
urltext
usernametext
versionslist
Example output
{
  "categories": [
    "DEVELOPER_TOOLS"
  ],
  "created_at": "2024-07-08T11:27:57.401Z",
  "default_run_options": {
    "build": "latest",
    "memory_mbytes": 2048,
    "timeout_secs": 3600
  },
  "description": "My favourite Actor!",
  "id": "zdc3Pyhyz3m8vjDeM",
  "is_deprecated": false,
  "is_public": false,
  "modified_at": "2024-07-08T14:01:05.546Z",
  "name": "my-actor",
  "stats": {
    "last_run_started_at": "2024-07-08T14:01:05.546Z",
    "total_builds": 9,
    "total_runs": 16,
    "total_users": 6
  },
  "title": "My Actor",
  "url": "https://console.apify.com/actors/jane35~my-actor",
  "username": "jane35",
  "versions": [
    "0.0"
  ]
}

Delete Actor

Permanently delete an Apify Actor, along with its versions and builds. This cannot be undone.

Inputs

Actor IDactor_idtextRequired
The Actor's ID, or its owner and name joined by a tilde (for example, janedoe~my-actor)

Outputs

actor_idtext
deletedtrue/false
Example output
{
  "actor_id": "zdc3Pyhyz3m8vjDeM",
  "deleted": true
}

Get Actor

Get the full details of a single Apify Actor, including its versions, default run options, and run statistics.

Inputs

Actor IDactor_idtextRequired
The Actor's ID, or its owner and name joined by a tilde (for example, janedoe~my-actor)

Outputs

categorieslist
created_attext
default_run_optionsobject
descriptiontext
idtext
is_deprecatedtrue/false
is_publictrue/false
modified_attext
nametext
statsobject
titletext
urltext
usernametext
versionslist
Example output
{
  "categories": [
    "DEVELOPER_TOOLS"
  ],
  "created_at": "2024-07-08T11:27:57.401Z",
  "default_run_options": {
    "build": "latest",
    "memory_mbytes": 2048,
    "timeout_secs": 3600
  },
  "description": "My favourite Actor!",
  "id": "zdc3Pyhyz3m8vjDeM",
  "is_deprecated": false,
  "is_public": false,
  "modified_at": "2024-07-08T14:01:05.546Z",
  "name": "my-actor",
  "stats": {
    "last_run_started_at": "2024-07-08T14:01:05.546Z",
    "total_builds": 9,
    "total_runs": 16,
    "total_users": 6
  },
  "title": "My Actor",
  "url": "https://console.apify.com/actors/jane35~my-actor",
  "username": "jane35",
  "versions": [
    "0.0"
  ]
}

List Actors

List the Apify Actors (web scrapers and automations) you created or used, with optional sorting and paging.

Inputs

Only my Actorsmytrue/false
[Optional] When true, only return Actors you own instead of every Actor you created or used
Offsetoffsetnumber
[Optional] Number of Actors to skip from the start of the list (default: 0)
Limitlimitnumber
[Optional] Maximum number of Actors to return (default: 20, maximum: 1000)
Newest firstdesctrue/false
[Optional] When true, sort in descending order (newest, or most recently run, first)
Sort bysort_bytext
[Optional] Field to sort by: 'createdAt' (default) or 'stats.lastRunStartedAt'

Outputs

actorslist
countnumber
limitnumber
offsetnumber
totalnumber
Example output
{
  "actors": [
    {
      "created_at": "2024-07-08T11:27:57.401Z",
      "id": "zdc3Pyhyz3m8vjDeM",
      "last_run_started_at": "2024-07-08T14:01:05.546Z",
      "modified_at": "2024-07-08T14:01:05.546Z",
      "name": "my-actor",
      "title": "My Actor",
      "total_runs": 16,
      "url": "https://console.apify.com/actors/jane35~my-actor",
      "username": "jane35"
    }
  ],
  "count": 1,
  "limit": 20,
  "offset": 0,
  "total": 1
}

Update Actor

Update an Apify Actor's settings. Only the fields you provide are changed; supply at least one.

Inputs

Actor IDactor_idtextRequired
The Actor's ID, or its owner and name joined by a tilde (for example, janedoe~my-actor)
Namenametext
[Optional] New identifier for the Actor, using lowercase letters, numbers, and hyphens
Titletitletext
[Optional] New human-readable name shown in Apify Store and Console
Descriptiondescriptiontext
[Optional] New short description of what the Actor does
Publish to Apify Storeis_publictrue/false
[Optional] When true, list the Actor publicly in Apify Store; when false, keep it private
Mark as deprecatedis_deprecatedtrue/false
[Optional] When true, mark the Actor as deprecated so users are steered away from it

Outputs

categorieslist
created_attext
default_run_optionsobject
descriptiontext
idtext
is_deprecatedtrue/false
is_publictrue/false
modified_attext
nametext
statsobject
titletext
urltext
usernametext
versionslist
Example output
{
  "categories": [
    "DEVELOPER_TOOLS"
  ],
  "created_at": "2024-07-08T11:27:57.401Z",
  "default_run_options": {
    "build": "latest",
    "memory_mbytes": 2048,
    "timeout_secs": 3600
  },
  "description": "My favourite Actor!",
  "id": "zdc3Pyhyz3m8vjDeM",
  "is_deprecated": false,
  "is_public": false,
  "modified_at": "2024-07-08T14:01:05.546Z",
  "name": "my-actor",
  "stats": {
    "last_run_started_at": "2024-07-08T14:01:05.546Z",
    "total_builds": 9,
    "total_runs": 16,
    "total_users": 6
  },
  "title": "My Actor",
  "url": "https://console.apify.com/actors/jane35~my-actor",
  "username": "jane35",
  "versions": [
    "0.0"
  ]
}

API-Volleyball

Previous Page

APIs.guru

Next Page

On this page

ActionsCreate ActorDelete ActorGet ActorList ActorsUpdate Actor