Skip to main content

Create 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 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. (More info).

Request

Bodyrequired

  • actId string required
    Example: asADASadYvn4mBZmm
  • name string required
    Example: my-task
  • options object
      anyOf
    • build string | null nullable
      Example: latest
    • timeoutSecs integer | null nullable
      Example: 300
    • memoryMbytes integer | null nullable
      Example: 128
    • restartOnError boolean | null nullable
      Example: false
    • maxItems integer | null nullable
  • 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
  • actorStandby object
      anyOf
    • isEnabled boolean | null nullable
    • desiredRequestsPerActorRun integer | null nullable
    • maxRequestsPerActorRun integer | null nullable
    • idleTimeoutSecs integer | null nullable
    • build string | null nullable
    • memoryMbytes integer | null nullable
    • disableStandbyFieldsOverride boolean | null nullable
    • shouldPassActorInput boolean | null nullable

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"
    }
  }
}