Skip to main content

Create Actor task

POST 
/v2/actor-tasks

Create a new task with settings specified by the object passed as JSON in the POST payload.

The response is the full task object as returned by the Get Actor task endpoint.

The request needs to specify the Content-Type: application/json HTTP header!

When providing your API authentication token, we recommend using the request's Authorization header, rather than the URL.

Request

Bodyrequired

  • actId string required
    Example: asADASadYvn4mBZmm
  • name string
    Example: my-task
  • options object
      anyOf
    • build string | null nullable
      Example: latest
    • timeoutSecs integer | null nullable
      Example: 300
    • memoryMbytes integer | null nullable
      Example: 1024
    • maxItems integer | null nullable
      Example: 1000
    • maxTotalChargeUsd number | null nullable
      Example: 5
    • restartOnError boolean | null nullable
      Example: false
    • isMaxTotalChargeUsdSetByUser boolean | null nullable

      Whether the user explicitly set maxTotalChargeUsd. Returned only in schedule action runOptions, and only if it was provided.


      Example: true
    • forcePermissionLevel object

      Permission level to run the Actor with, overriding the Actor's own setting. Returned only in schedule action runOptions, and only if it was provided.

        anyOf
      • ActorPermissionLevel (string)

        Determines the permission level that the Actor requires to run. For details, see Actor permissions.

        Possible values: [LIMITED_PERMISSIONS, FULL_PERMISSIONS]


        Example: LIMITED_PERMISSIONS
  • input object
      anyOf
    • object

      The input configuration for the Actor task. This is a user-defined JSON object that will be passed to the Actor when the task is run.


      Example: {"startUrls":[{"url":"https://example.com"}],"maxRequestsPerCrawl":100}
  • title string | null nullable
  • description string | null nullable
  • actorStandby object
      anyOf
    • isEnabled boolean | null nullable

      Whether standby mode is enabled for the Actor.

    • desiredRequestsPerActorRun integer | null nullable

      Target number of concurrent HTTP requests a single run is configured to handle.

    • maxRequestsPerActorRun integer | null nullable

      Maximum number of concurrent HTTP requests that can be routed to a single run.

    • idleTimeoutSecs integer | null nullable

      In seconds, how long a run can stay idle without incoming requests before it's terminated.

    • build string | null nullable

      Which build to run in standby mode. Either a build tag or a version number.

    • memoryMbytes integer | null nullable

      In MB, the amount of memory allocated to the run.

    • disableStandbyFieldsOverride boolean | null nullable

      If true, prevents the standby mode configuration from being overridden elsewhere.

    • shouldPassActorInput boolean | null nullable

      Whether to pass the Actor's input to the standby run. If false, the standby runs start with no input.

    • tenancy string | null nullable

      Whether each user gets their own standby runs (SINGLE_TENANT) or runs are shared across users (MULTI_TENANT). Set by Apify.


      Example: SINGLE_TENANT
    • isConsoleAuthEnabled boolean | null nullable

      Whether standby requests can be authenticated with an Apify Console session. Set by Apify.

    • isTokenlessEnabled boolean | null nullable

      Whether standby requests can be made without an API token. Set by Apify.

  • publicConfig object

    Configuration that controls how the published task appears on its public landing page. Editing this object requires write permission to the Actor that the task belongs to.

    • seoTitle string | null nullable

      Name of the Actor task to display by search engines such as Google. Defaults to the task title. At most 60 characters.

      Possible values: <= 60 characters


      Example: Scrape data from a website
    • seoDescription string | null nullable

      Description of the Actor task to display by search engines such as Google. Defaults to the task description. At most 160 characters.

      Possible values: <= 160 characters

    • inputSchemaFields string[] nullable

      Names of the task input fields displayed on the public task page.

    • datasetName string | null nullable

      Name of the dataset from the Actor's dataset schema whose results are displayed. When null, the Actor's default dataset is used. That is, the only dataset the Actor declares, or the one named default when it declares several.

    • datasetView string | null nullable

      Key of the dataset view from the Actor's dataset schema used to display results. Must be one of the views declared on the resolved dataset. You can't publish a task without it.

    • categorization string | null nullable

      ID of the use-case category of the task.

    • highlightedFields string[] nullable

      Names of the dataset fields highlighted on the public task page.

    • faq object[]

      Frequently asked questions displayed on the public task page.

      • question string required
      • answer string required

Status 201

Response Headers
  • Location 
{
  "data": {
    "id": "zdc3Pyhyz3m8vjDeM",
    "userId": "wRsJZtadYvn4mBZmm",
    "actId": "asADASadYvn4mBZmm",
    "name": "my-task",
    "username": "janedoe",
    "createdAt": "2018-10-26T07:23:14.855Z",
    "modifiedAt": "2018-10-26T13:30:49.578Z",
    "removedAt": null,
    "stats": {
      "totalRuns": 15
    },
    "options": {
      "build": "latest",
      "timeoutSecs": 300,
      "memoryMbytes": 128
    },
    "input": {
      "hello": "world"
    }
  }
}