v3

OpenAPI 3.1.2Apache 2.02026-07-31231237972.0 KB
Actor tasks

Create task

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.

post/v2/actor-tasks

Request body

actIdstring required
namestring
inputTaskInput

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.

titlestring nullable

Example request

{
  "actId": "asADASadYvn4mBZmm",
  "name": "my-task",
  "options": {
    "build": "latest",
    "timeoutSecs": 300,
    "memoryMbytes": 128
  },
  "input": {
    "hello": "world"
  }
}

Response

Example response

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