Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Tasks

Get a Task

Gets a task from a Project.

get/v2.0/tasks/{taskId}

Path parameters

taskIdstring required

The unique identifier for the task.

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Response

Task object retrieved.

namestring

The name of the task

dataobject

The parameters of the task

status'queued' | 'active' | 'done' | 'cancelling' | 'cancelled' | 'error'

The status of the task

currentStepinteger
totalStepinteger
failReasonstring
lastRunAtstring date-time
lastFinishedAtstring date-time
_idstring
createdAtinteger

Unix-timestamp

lastChangedinteger

Unix-timestamp

createdBystring
lastChangedBystring

Example response

{
  "status": "queued",
  "createdAt": 1694518620,
  "lastChanged": 1694518620
}