BREAGEN Logo
Document Understanding

Task Status Management

Get Task Status GET /v1/api/task_status

Resource URL/v1/api/task_status/
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Description

Retrieve the status of a specific task by its ID.

Parameters

ParameterDescriptionRequiredTypeDefault Value
task_idUnique identifier of the taskYesStringN/A

Example Request

curl -X 'GET' \
'https://braegen.ai/v1/api/task_status/?task_id=task_123' \
-H 'accept: application/json'

Example Response

{
    "is_error": false,
    "message": "Task status retrieved successfully",
    "results": {
        "task_id": "task_123",
        "status": "completed",
        "updated_at": "2025-04-07T12:00:00Z"
    }
}

HTTP Response

HTTP CodeMessage
200Successful Response
422Validation Error

Task Status Management

Get Task Status POST /v1/api/task_status/list

Resource URL/v1/api/task_status/list
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Description

Retrieve the status of multiple tasks by providing a list of task IDs.

Request Body

ParameterDescriptionRequiredTypeDefault Value
task_id_listArray of task identifiersYesArray[String]N/A

Example Request

curl -X 'POST' \
'https://braegen.ai/v1/api/task_status/list' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
    "task_id_list": ["task_123", "task_456", "task_789"]
}'

Example Response

{
    "is_error": false,
    "message": "Task statuses retrieved successfully",
    "results": [
        {
            "task_id": "task_123",
            "status": "completed",
            "updated_at": "2025-04-07T12:00:00Z"
        },
        {
            "task_id": "task_456",
            "status": "in_progress",
            "updated_at": "2025-04-07T11:30:00Z"
        },
        {
            "task_id": "task_789",
            "status": "pending",
            "updated_at": "2025-04-07T10:00:00Z"
        }
    ]
}

HTTP Response

HTTP CodeMessage
200Successful Response
422Validation Error

On this page