iQ Suite - Docs
SDK Reference

Get Task Status

Check the status of a previously submitted task.

Description

The Get Task Status endpoint allows you to check the current status of a previously submitted task, such as creating an index or adding a document. This helps in tracking the progress and completion of asynchronous operations.

HTTP Request

GET /create-index/task-status/{task_id}

Authentication

All requests must include an Authorization header with a valid API key.

Headers

KeyValue
AuthorizationBearer YOUR_API_KEY
Content-Typeapplication/json

Path Parameters

ParameterTypeDescription
task_idstringThe ID of the task to check

Request Example

try:
# Replace 'your-task-id' with the actual Task ID you received earlier
status = client.get_task_status('your-task-id')
print(f"Task Status: {status.status}")
except APIError as e:
# Handle any API-related errors
print(f"Error: {e}")

Response

Success

Status Code: 200 OK

Body:

{
  "status": "completed",
  "task_id": "fe77e15c-17ce-4cec-aeb5-134645fb9d17",
  "index_id": "54a7e942-366b-42d2-9672-69fc460c2752"
}

On this page