Get a Task - Cognigy Documentation

GET

v2.0

tasks

{taskId}

Get a Task

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/tasks/{taskId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "name": "<string>",
  "data": {},
  "status": "queued",
  "currentStep": 123,
  "totalStep": 123,
  "failReason": "<string>",
  "lastRunAt": "2023-11-07T05:31:56Z",
  "lastFinishedAt": "2023-11-07T05:31:56Z",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}

Authorizations

X-API-Key

string

header

required

Supply the API Key in the HTTP-Header

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

api_key

string

query

required

Supply the API Key in the Url-Query

Headers

enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:

application/json,

application/hal+json,

application/xml,

text/xml,

text/csv

Path Parameters

taskId

string

required

The Id of the Task

Required string length: 24

Response

Returns Task Object

The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.

name

string

The name of the task

data

object

The parameters of the task

status

enum<string>

The status of the task

Available options:

queued,

active,

done,

cancelling,

cancelled,

error

Example:

"queued"

currentStep

integer

totalStep

integer

failReason

string

lastRunAt

string<date-time>

lastFinishedAt

string<date-time>

_id

string

Required string length: 24

createdAt

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

lastChanged

integer

Unix-timestamp

Required range: 0 <= x <= 2147483647

Example:

1694518620

createdBy

string

Required string length: 24

lastChangedBy

string

Required string length: 24

Cancel a taskCancel a [Task](doc:task) to a project.

⌘I

Get a Task

curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/tasks/{taskId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <api-key>'

{
  "name": "<string>",
  "data": {},
  "status": "queued",
  "currentStep": 123,
  "totalStep": 123,
  "failReason": "<string>",
  "lastRunAt": "2023-11-07T05:31:56Z",
  "lastFinishedAt": "2023-11-07T05:31:56Z",
  "_id": "<string>",
  "createdAt": 1694518620,
  "lastChanged": 1694518620,
  "createdBy": "<string>",
  "lastChangedBy": "<string>"
}