Tasks

Get Task Status

Fetches the execution status of a specific background task for the authenticated user.

GET
https://api.textreveal.com/v3/tasks/{task_id}/status

Request

Parameters

  • task_id*uuid

    Unique identifier of the task

    Example: "f47ac10b-58cc-4372-a567-0e02b2c3d479"

Response

Response - 200

Returns the task's current status.

  • status*string (enum)

    Current status of the task

    Values: "starting", "running", "failed", "completed"
Response
{
  "status": "starting"
}

Error

Error - 400

Bad request

  • message*string

    Error message.

    Example: "Check the errors field for more details"
  • code*number (enum)

    Error code.

    Values: 400
  • reason*string (enum)

    Error reason.

    Values: "invalid"
  • errorsobject[]

    Possible error causes.

Response
{
  "message": "Check the errors field for more details",
  "code": 400,
  "reason": "invalid",
  "errors": [
    {
      "message": "string",
      "field": "task_id",
      "reason": "invalid_type"
    }
  ]
}

Error - 404

Not found

  • message*string

    Error message.

    Example: "The requested task does not exist or is not visible to you."
  • code*number (enum)

    Error code.

    Values: 404
  • reason*string (enum)

    Error reason.

    Values: "not_found"
Response
{
  "message": "The requested task does not exist or is not visible to you.",
  "code": 404,
  "reason": "not_found"
}

Generic errors are not shown, see Errors for more details.