Tasks

List Tasks

GET
/v1-alpha/tasks
x-api-key<token>

Authenticate using API Key in request header

In: header

Query Parameters

limit?integer

This specifies a limit on the number of objects to return, ranging between 1 and 100.

Default50
Range1 <= value <= 100
taskIDs?array<string>

Array with the task IDs, formatted as a CSV array.

sortOrder?string

Specifies sorting behavior. The two options are asc and desc to sort ascending and descending respectively, with default sort being ascending. Paging works in both directions.

Default"asc"
Value in"asc" | "desc"
startingAfter?string

A cursor to use in pagination. startingAfter is a task ID that defines your place in the list. For example, if you make a list request and receive 50 objects, ending with tsk_2c9AXIj48cUYJtCuv1gsQtHGDzK, your subsequent call can include startingAfter=tsk_2c9AXIj48cUYJtCuv1gsQtHGDzK to fetch the next page of the list.

endingBefore?string

A cursor to use in pagination. endingBefore is a task ID that defines your place in the list. For example, if you make a list request and receive 50 objects, starting with tsk_2c9AXIj48cUYJtCuv1gsQtHGDzK, your subsequent call can include endingBefore=tsk_2c9AXIj48cUYJtCuv1gsQtHGDzK to fetch the previous page of the list.

status?string

Array with the task statuses, formatted as a CSV array.

Value in"running" | "completed" | "failed"

Response Body

curl -X GET "https://api.bem.ai/v1-alpha/tasks?limit=50&taskIDs=string&sortOrder=asc&startingAfter=string&endingBefore=string&status=running"
{
  "totalCount": 0,
  "tasks": [
    {
      "taskID": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "type": "transformation",
      "status": "running"
    }
  ]
}