GEgetstream
product:chat

Get status of a task

Changed on

Gets status of a task

get/tasks/{id}

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/tasks/{id}
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Path parameters

idstring required

Task ID

Response

Get Task Response

created_atstring date-time required
durationstring required
resultobject

Result produced by task after completion. A task that does its work in stages may carry a status of its own here, describing that work rather than the task; the top-level status already accounts for it, so use that to tell whether the operation has finished.

statusstring required

Current status of the whole operation. A task whose result reports an in-progress status of its own is returned as running until that status is terminal, so completed means the operation itself finished rather than that its first step was accepted. A result that never reaches a terminal status stops being reported as running after a fixed period and falls back to the task's own status.

task_idstring required

ID of task

updated_atstring date-time required

Changes

  • 30f95dce0284Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 0f901a2af901Revision changes
    • info

      added the required property / to the response with the status