🔍 Code Extractor

Flask API endpoint that retrieves the detailed status of a chat task by delegating to the api_task_status function using the provided task_id.

Purpose

This endpoint serves as an alias for the task-status API, specifically for chat-related tasks. It provides a more semantically meaningful URL path (/api/chat-status/) for clients querying chat task statuses, while internally using the same status retrieval mechanism as the general task status endpoint. This is useful for maintaining API consistency and providing domain-specific endpoints for different task types.

Source Code

def api_chat_status(task_id):
    """Get detailed status for chat task (alias for task-status)"""
    return api_task_status(task_id)

Parameters

Parameter Details

task_id: A unique identifier (likely a UUID string) for the chat task whose status is being queried. This ID is extracted from the URL path and passed to the underlying api_task_status function to retrieve task information such as completion status, progress, results, or error messages.

Return Value

Returns the same response as api_task_status(task_id), which is typically a Flask JSON response containing task status information. The exact structure depends on the api_task_status implementation, but likely includes fields such as status (pending/running/completed/failed), progress percentage, result data, error messages, and timestamps. The HTTP status code and response format are determined by the api_task_status function.

Dependencies

• flask

Required Imports

from flask import Flask
from flask import jsonify

Usage Example

# Assuming Flask app is set up and api_task_status is defined
# Client-side usage (e.g., JavaScript fetch or curl):
# GET /api/chat-status/550e8400-e29b-41d4-a716-446655440000

# Server-side context:
from flask import Flask, jsonify

app = Flask(__name__)

# Mock api_task_status for demonstration
def api_task_status(task_id):
    # This would normally query a task store
    return jsonify({
        'task_id': task_id,
        'status': 'completed',
        'progress': 100,
        'result': 'Chat response generated successfully'
    })

@app.route('/api/chat-status/<task_id>', methods=['GET'])
def api_chat_status(task_id):
    return api_task_status(task_id)

# Client request example:
# curl http://localhost:5000/api/chat-status/550e8400-e29b-41d4-a716-446655440000

Best Practices

• Ensure the task_id parameter is validated in the api_task_status function to prevent injection attacks or invalid queries
• Implement proper error handling in api_task_status to return appropriate HTTP status codes (404 for not found, 500 for server errors)
• Consider adding authentication/authorization checks to prevent unauthorized access to task status information
• Use consistent task_id format (e.g., UUID) across the application for better tracking and validation
• Document the expected response format for clients consuming this endpoint
• Consider implementing rate limiting to prevent abuse of status polling
• Add logging to track status queries for debugging and monitoring purposes

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• function api_task_status 84.9% similar

  Flask API endpoint that retrieves and returns the status of asynchronous tasks (chat or indexing operations) by task ID.

  From: /tf/active/vicechatdev/docchat/app.py

• function get_task_status 73.5% similar

  Flask API endpoint that retrieves the current status of a background task by its task ID from an in-memory active_tasks dictionary.

  From: /tf/active/vicechatdev/docchat/blueprint.py

• function api_task_status_v1 73.1% similar

  Flask API endpoint that retrieves and returns the status of a background task, with user authorization checks.

  From: /tf/active/vicechatdev/vice_ai/app.py

• function api_index_progress 68.0% similar

  Flask API endpoint that retrieves the current progress status of an asynchronous indexing task by its task ID.

  From: /tf/active/vicechatdev/docchat/app.py

• function text_chat_get_progress 64.8% similar

  Flask API endpoint that retrieves the progress status of an asynchronous text chat job, particularly for multi-cycle web search operations.

  From: /tf/active/vicechatdev/vice_ai/new_app.py