Docmost Octri Preview
POST/file-tasks/info

Get file task status

Retrieves the status and details of a file task. Supply fileTaskId as a UUID to look up the task; use the returned information to check its progress or outcome.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field

Identifier of the file task to retrieve.

fileTaskIdstringrequired
ID of the file task to check status for.

3 status codes
200Returns the file task details and status.
dataobjectoptional
statusintegeroptional
successbooleanoptional
403Returned when the authenticated user does not have permission to access the file task.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the requested file task does not exist.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 403 is returned when the authenticated user does not have permission to access the file task. A 404 is returned when no file task exists for the supplied fileTaskId. fileTaskId must be a UUID.