Get task

GET 
/v2/actor-tasks/:actorTaskId

Get an object that contains all the details about a task.

Request

Path Parameters

actorTaskId string required
Task ID or a tilde-separated owner's username and task's name.

Example: janedoe~my-task

Status 200

Response Headers

{
  "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": "2024-07-29T15:51:28.071Z",
    "stats": {
      "totalRuns": 15
    },
    "options": {
      "build": "latest",
      "timeoutSecs": 300,
      "memoryMbytes": 128,
      "restartOnError": false,
      "maxItems": 0
    },
    "input": {
      "startUrls": [
        {
          "url": "https://example.com"
        }
      ],
      "maxRequestsPerCrawl": 100
    },
    "title": "string",
    "actorStandby": {
      "isEnabled": true,
      "desiredRequestsPerActorRun": 0,
      "maxRequestsPerActorRun": 0,
      "idleTimeoutSecs": 0,
      "build": "string",
      "memoryMbytes": 0,
      "disableStandbyFieldsOverride": true,
      "shouldPassActorInput": true
    },
    "standbyUrl": "string"
  }
}

Schema

• data object required

  • id string required
    Example: zdc3Pyhyz3m8vjDeM
  • userId string required
    Example: wRsJZtadYvn4mBZmm
  • actId string required
    Example: asADASadYvn4mBZmm
  • name string required
    Example: my-task
  • username string | null nullable
    Example: janedoe
  • createdAt string<date-time> required
    Example: 2018-10-26T07:23:14.855Z
  • modifiedAt string<date-time> required
    Example: 2018-10-26T13:30:49.578Z
  • removedAt string,null<date-time> nullable
  • stats object

    anyOf
    • TaskStats
    • null
    totalRuns integer
    Example: 15
  • options object

    anyOf
    • TaskOptions
    • null
    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
    • TaskInput
    • null
    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
    • ActorStandby
    • null
    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
  • standbyUrl string,null<uri> nullable

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)