langflow-base-nightly 0.5.0.dev39__py3-none-any.whl → 0.5.1.dev0__py3-none-any.whl

langflow/api/router.py

@@ -13,6 +13,7 @@ from langflow.api.v1 import (
     mcp_projects_router,
     mcp_router,
     monitor_router,
+    openai_responses_router,
     projects_router,
     starter_projects_router,
     store_router,
@@ -50,6 +51,7 @@ router_v1.include_router(knowledge_bases_router)
 router_v1.include_router(mcp_router)
 router_v1.include_router(voice_mode_router)
 router_v1.include_router(mcp_projects_router)
+router_v1.include_router(openai_responses_router)
 
 router_v2.include_router(files_router_v2)
 router_v2.include_router(mcp_router_v2)

langflow/api/v1/__init__.py

@@ -9,6 +9,7 @@ from langflow.api.v1.login import router as login_router
 from langflow.api.v1.mcp import router as mcp_router
 from langflow.api.v1.mcp_projects import router as mcp_projects_router
 from langflow.api.v1.monitor import router as monitor_router
+from langflow.api.v1.openai_responses import router as openai_responses_router
 from langflow.api.v1.projects import router as projects_router
 from langflow.api.v1.starter_projects import router as starter_projects_router
 from langflow.api.v1.store import router as store_router
@@ -29,6 +30,7 @@ __all__ = [
     "mcp_projects_router",
     "mcp_router",
     "monitor_router",
+    "openai_responses_router",
     "projects_router",
     "starter_projects_router",
     "store_router",

langflow/api/v1/endpoints.py

@@ -116,6 +116,7 @@ async def simple_run_flow(
     stream: bool = False,
     api_key_user: User | None = None,
     event_manager: EventManager | None = None,
+    context: dict | None = None,
 ):
     validate_input_and_tweaks(input_request)
     try:
@@ -127,7 +128,9 @@ async def simple_run_flow(
             raise ValueError(msg)
         graph_data = flow.data.copy()
         graph_data = process_tweaks(graph_data, input_request.tweaks or {}, stream=stream)
-        graph = Graph.from_payload(graph_data, flow_id=flow_id_str, user_id=str(user_id), flow_name=flow.name)
+        graph = Graph.from_payload(
+            graph_data, flow_id=flow_id_str, user_id=str(user_id), flow_name=flow.name, context=context
+        )
         inputs = None
         if input_request.input_value is not None:
             inputs = [
@@ -228,6 +231,7 @@ async def run_flow_generator(
     api_key_user: User | None,
     event_manager: EventManager,
     client_consumed_queue: asyncio.Queue,
+    context: dict | None = None,
 ) -> None:
     """Executes a flow asynchronously and manages event streaming to the client.
 
@@ -240,6 +244,7 @@ async def run_flow_generator(
         api_key_user (User | None): Optional authenticated user running the flow
         event_manager (EventManager): Manages the streaming of events to the client
         client_consumed_queue (asyncio.Queue): Tracks client consumption of events
+        context (dict | None): Optional context to pass to the flow
 
     Events Generated:
         - "add_message": Sent when new messages are added during flow execution
@@ -260,6 +265,7 @@ async def run_flow_generator(
             stream=True,
             api_key_user=api_key_user,
             event_manager=event_manager,
+            context=context,
         )
         event_manager.on_end(data={"result": result.model_dump()})
         await client_consumed_queue.get()

langflow/api/v1/openai_responses.py

@@ -0,0 +1,545 @@
+import asyncio
+import json
+import time
+import uuid
+from collections.abc import AsyncGenerator
+from typing import Annotated, Any
+
+from fastapi import APIRouter, BackgroundTasks, Depends, HTTPException, Request
+from fastapi.responses import StreamingResponse
+from loguru import logger
+
+from langflow.api.v1.endpoints import consume_and_yield, run_flow_generator, simple_run_flow
+from langflow.api.v1.schemas import SimplifiedAPIRequest
+from langflow.events.event_manager import create_stream_tokens_event_manager
+from langflow.helpers.flow import get_flow_by_id_or_endpoint_name
+from langflow.schema.content_types import ToolContent
+from langflow.schema.openai_responses_schemas import (
+    OpenAIErrorResponse,
+    OpenAIResponsesRequest,
+    OpenAIResponsesResponse,
+    OpenAIResponsesStreamChunk,
+    create_openai_error,
+)
+from langflow.services.auth.utils import api_key_security
+from langflow.services.database.models.flow.model import FlowRead
+from langflow.services.database.models.user.model import UserRead
+from langflow.services.deps import get_telemetry_service
+from langflow.services.telemetry.schema import RunPayload
+from langflow.services.telemetry.service import TelemetryService
+
+router = APIRouter(tags=["OpenAI Responses API"])
+
+
+def has_chat_input(flow_data: dict | None) -> bool:
+    """Check if the flow has a chat input component."""
+    if not flow_data or "nodes" not in flow_data:
+        return False
+
+    return any(node.get("data", {}).get("type") in ["ChatInput", "Chat Input"] for node in flow_data["nodes"])
+
+
+def has_chat_output(flow_data: dict | None) -> bool:
+    """Check if the flow has a chat input component."""
+    if not flow_data or "nodes" not in flow_data:
+        return False
+
+    return any(node.get("data", {}).get("type") in ["ChatOutput", "Chat Output"] for node in flow_data["nodes"])
+
+
+async def run_flow_for_openai_responses(
+    flow: FlowRead,
+    request: OpenAIResponsesRequest,
+    api_key_user: UserRead,
+    *,
+    stream: bool = False,
+    variables: dict[str, str] | None = None,
+) -> OpenAIResponsesResponse | StreamingResponse:
+    """Run a flow for OpenAI Responses API compatibility."""
+    # Check if flow has chat input
+    if not has_chat_input(flow.data):
+        msg = "Flow must have a ChatInput component to be compatible with OpenAI Responses API"
+        raise ValueError(msg)
+
+    if not has_chat_output(flow.data):
+        msg = "Flow must have a ChatOutput component to be compatible with OpenAI Responses API"
+        raise ValueError(msg)
+
+    # Use previous_response_id as session_id for conversation continuity
+    # If no previous_response_id, create a new session_id
+    session_id = request.previous_response_id or str(uuid.uuid4())
+
+    # Store header variables in context for global variable override
+    context = {}
+    if variables:
+        context["request_variables"] = variables
+        logger.debug(f"Added request variables to context: {variables}")
+
+    # Convert OpenAI request to SimplifiedAPIRequest
+    # Note: We're moving away from tweaks to a context-based approach
+    simplified_request = SimplifiedAPIRequest(
+        input_value=request.input,
+        input_type="chat",  # Use chat input type for better compatibility
+        output_type="chat",  # Use chat output type for better compatibility
+        tweaks={},  # Empty tweaks, using context instead
+        session_id=session_id,
+    )
+
+    # Context will be passed separately to simple_run_flow
+
+    logger.debug(f"SimplifiedAPIRequest created with context: {context}")
+
+    # Use session_id as response_id for OpenAI compatibility
+    response_id = session_id
+    created_timestamp = int(time.time())
+
+    if stream:
+        # Handle streaming response
+        asyncio_queue: asyncio.Queue = asyncio.Queue()
+        asyncio_queue_client_consumed: asyncio.Queue = asyncio.Queue()
+        event_manager = create_stream_tokens_event_manager(queue=asyncio_queue)
+
+        async def openai_stream_generator() -> AsyncGenerator[str, None]:
+            """Convert Langflow events to OpenAI Responses API streaming format."""
+            main_task = asyncio.create_task(
+                run_flow_generator(
+                    flow=flow,
+                    input_request=simplified_request,
+                    api_key_user=api_key_user,
+                    event_manager=event_manager,
+                    client_consumed_queue=asyncio_queue_client_consumed,
+                    context=context,
+                )
+            )
+
+            try:
+                # Send initial chunk to establish connection
+                initial_chunk = OpenAIResponsesStreamChunk(
+                    id=response_id,
+                    created=created_timestamp,
+                    model=request.model,
+                    delta={"content": ""},
+                )
+                yield f"data: {initial_chunk.model_dump_json()}\n\n"
+
+                tool_call_counter = 0
+                processed_tools = set()  # Track processed tool calls to avoid duplicates
+                previous_content = ""  # Track content already sent to calculate deltas
+
+                async for event_data in consume_and_yield(asyncio_queue, asyncio_queue_client_consumed):
+                    if event_data is None:
+                        break
+
+                    content = ""
+
+                    # Parse byte string events as JSON
+                    if isinstance(event_data, bytes):
+                        try:
+                            import json
+
+                            event_str = event_data.decode("utf-8")
+                            parsed_event = json.loads(event_str)
+
+                            if isinstance(parsed_event, dict):
+                                event_type = parsed_event.get("event")
+                                data = parsed_event.get("data", {})
+
+                                # Handle add_message events
+                                if event_type == "add_message":
+                                    sender_name = data.get("sender_name", "")
+                                    text = data.get("text", "")
+                                    sender = data.get("sender", "")
+                                    content_blocks = data.get("content_blocks", [])
+
+                                    # Look for Agent Steps in content_blocks
+                                    for block in content_blocks:
+                                        if block.get("title") == "Agent Steps":
+                                            contents = block.get("contents", [])
+                                            for step in contents:
+                                                # Look for tool_use type items
+                                                if step.get("type") == "tool_use":
+                                                    tool_name = step.get("name", "")
+                                                    tool_input = step.get("tool_input", {})
+                                                    tool_output = step.get("output")
+
+                                                    # Only emit tool calls with explicit tool names and
+                                                    # meaningful arguments
+                                                    if tool_name and tool_input is not None and tool_output is not None:
+                                                        # Create unique identifier for this tool call
+                                                        tool_signature = (
+                                                            f"{tool_name}:{hash(str(sorted(tool_input.items())))}"
+                                                        )
+
+                                                        # Skip if we've already processed this tool call
+                                                        if tool_signature in processed_tools:
+                                                            continue
+
+                                                        processed_tools.add(tool_signature)
+                                                        tool_call_counter += 1
+                                                        call_id = f"call_{tool_call_counter}"
+                                                        tool_id = f"fc_{tool_call_counter}"
+                                                        tool_call_event = {
+                                                            "type": "response.output_item.added",
+                                                            "item": {
+                                                                "id": tool_id,
+                                                                "type": "function_call",  # OpenAI uses "function_call"
+                                                                "status": "in_progress",  # OpenAI includes status
+                                                                "name": tool_name,
+                                                                "arguments": "",  # Start with empty, build via deltas
+                                                                "call_id": call_id,
+                                                            },
+                                                        }
+                                                        yield (
+                                                            f"event: response.output_item.added\n"
+                                                            f"data: {json.dumps(tool_call_event)}\n\n"
+                                                        )
+
+                                                        # Send function call arguments as delta events (like OpenAI)
+                                                        arguments_str = json.dumps(tool_input)
+                                                        arg_delta_event = {
+                                                            "type": "response.function_call_arguments.delta",
+                                                            "delta": arguments_str,
+                                                            "item_id": tool_id,
+                                                            "output_index": 0,
+                                                        }
+                                                        yield (
+                                                            f"event: response.function_call_arguments.delta\n"
+                                                            f"data: {json.dumps(arg_delta_event)}\n\n"
+                                                        )
+
+                                                        # Send function call arguments done event
+                                                        arg_done_event = {
+                                                            "type": "response.function_call_arguments.done",
+                                                            "arguments": arguments_str,
+                                                            "item_id": tool_id,
+                                                            "output_index": 0,
+                                                        }
+                                                        yield (
+                                                            f"event: response.function_call_arguments.done\n"
+                                                            f"data: {json.dumps(arg_done_event)}\n\n"
+                                                        )
+
+                                                        # If there's output, send completion event
+                                                        if tool_output is not None:
+                                                            # Check if include parameter requests tool_call.results
+                                                            include_results = (
+                                                                request.include
+                                                                and "tool_call.results" in request.include
+                                                            )
+
+                                                            if include_results:
+                                                                # Format with detailed results
+                                                                tool_done_event = {
+                                                                    "type": "response.output_item.done",
+                                                                    "item": {
+                                                                        "id": f"{tool_name}_{tool_id}",
+                                                                        "inputs": tool_input,  # Raw inputs as-is
+                                                                        "status": "completed",
+                                                                        "type": "tool_call",
+                                                                        "tool_name": f"{tool_name}",
+                                                                        "results": tool_output,  # Raw output as-is
+                                                                    },
+                                                                    "output_index": 0,
+                                                                    "sequence_number": tool_call_counter + 5,
+                                                                }
+                                                            else:
+                                                                # Regular function call format
+                                                                tool_done_event = {
+                                                                    "type": "response.output_item.done",
+                                                                    "item": {
+                                                                        "id": tool_id,
+                                                                        "type": "function_call",  # Match OpenAI format
+                                                                        "status": "completed",
+                                                                        "arguments": arguments_str,
+                                                                        "call_id": call_id,
+                                                                        "name": tool_name,
+                                                                    },
+                                                                }
+
+                                                            yield (
+                                                                f"event: response.output_item.done\n"
+                                                                f"data: {json.dumps(tool_done_event)}\n\n"
+                                                            )
+
+                                    # Extract text content for streaming (only AI responses)
+                                    if (
+                                        sender in ["Machine", "AI", "Agent"]
+                                        and text != request.input
+                                        and sender_name == "Agent"
+                                    ):
+                                        # Calculate delta: only send newly generated content
+                                        if text.startswith(previous_content):
+                                            content = text[len(previous_content) :]
+                                            previous_content = text
+                                        else:
+                                            # If text doesn't start with previous content, send full text
+                                            # This handles cases where the content might be reset
+                                            content = text
+                                            previous_content = text
+
+                        except (json.JSONDecodeError, UnicodeDecodeError):
+                            continue
+
+                    # Only send chunks with actual content
+                    if content:
+                        chunk = OpenAIResponsesStreamChunk(
+                            id=response_id,
+                            created=created_timestamp,
+                            model=request.model,
+                            delta={"content": content},
+                        )
+                        yield f"data: {chunk.model_dump_json()}\n\n"
+
+                # Send final completion chunk
+                final_chunk = OpenAIResponsesStreamChunk(
+                    id=response_id,
+                    created=created_timestamp,
+                    model=request.model,
+                    delta={},
+                    status="completed",
+                )
+                yield f"data: {final_chunk.model_dump_json()}\n\n"
+                yield "data: [DONE]\n\n"
+
+            except Exception as e:  # noqa: BLE001
+                logger.error(f"Error in stream generator: {e}")
+                error_response = create_openai_error(
+                    message=str(e),
+                    type_="processing_error",
+                )
+                yield f"data: {error_response}\n\n"
+            finally:
+                if not main_task.done():
+                    main_task.cancel()
+
+        return StreamingResponse(
+            openai_stream_generator(),
+            media_type="text/event-stream",
+            headers={
+                "Cache-Control": "no-cache",
+                "Connection": "keep-alive",
+                "Access-Control-Allow-Origin": "*",
+            },
+        )
+
+    # Handle non-streaming response
+    result = await simple_run_flow(
+        flow=flow,
+        input_request=simplified_request,
+        stream=False,
+        api_key_user=api_key_user,
+        context=context,
+    )
+
+    # Extract output text and tool calls from result
+    output_text = ""
+    tool_calls: list[dict[str, Any]] = []
+
+    if result.outputs:
+        for run_output in result.outputs:
+            if run_output and run_output.outputs:
+                for component_output in run_output.outputs:
+                    if component_output:
+                        # Handle messages (final chat outputs)
+                        if hasattr(component_output, "messages") and component_output.messages:
+                            for msg in component_output.messages:
+                                if hasattr(msg, "message"):
+                                    output_text = msg.message
+                                    break
+                        # Handle results
+                        if not output_text and hasattr(component_output, "results") and component_output.results:
+                            for value in component_output.results.values():
+                                if hasattr(value, "get_text"):
+                                    output_text = value.get_text()
+                                    break
+                                if isinstance(value, str):
+                                    output_text = value
+                                    break
+
+                        if hasattr(component_output, "results") and component_output.results:
+                            for blocks in component_output.results.get("message", {}).content_blocks:
+                                tool_calls.extend(
+                                    {
+                                        "name": content.name,
+                                        "input": content.tool_input,
+                                        "output": content.output,
+                                    }
+                                    for content in blocks.contents
+                                    if isinstance(content, ToolContent)
+                                )
+                    if output_text:
+                        break
+            if output_text:
+                break
+
+    # Build output array
+    output_items = []
+
+    # Add tool calls if includes parameter requests them
+    include_results = request.include and "tool_call.results" in request.include
+
+    tool_call_id_counter = 1
+    for tool_call in tool_calls:
+        if include_results:
+            # Format as detailed tool call with results (like file_search_call in sample)
+            tool_call_item = {
+                "id": f"{tool_call['name']}_{tool_call_id_counter}",
+                "queries": list(tool_call["input"].values())
+                if isinstance(tool_call["input"], dict)
+                else [str(tool_call["input"])],
+                "status": "completed",
+                "tool_name": f"{tool_call['name']}",
+                "type": "tool_call",
+                "results": tool_call["output"] if tool_call["output"] is not None else [],
+            }
+        else:
+            # Format as basic function call
+            tool_call_item = {
+                "id": f"fc_{tool_call_id_counter}",
+                "type": "function_call",
+                "status": "completed",
+                "name": tool_call["name"],
+                "arguments": json.dumps(tool_call["input"]) if tool_call["input"] is not None else "{}",
+            }
+
+        output_items.append(tool_call_item)
+        tool_call_id_counter += 1
+
+    # Add the message output
+    output_message = {
+        "type": "message",
+        "id": f"msg_{response_id}",
+        "status": "completed",
+        "role": "assistant",
+        "content": [{"type": "output_text", "text": output_text, "annotations": []}],
+    }
+    output_items.append(output_message)
+
+    return OpenAIResponsesResponse(
+        id=response_id,
+        created_at=created_timestamp,
+        model=request.model,
+        output=output_items,
+        previous_response_id=request.previous_response_id,
+    )
+
+
+@router.post("/responses", response_model=None)
+async def create_response(
+    request: OpenAIResponsesRequest,
+    background_tasks: BackgroundTasks,
+    api_key_user: Annotated[UserRead, Depends(api_key_security)],
+    telemetry_service: Annotated[TelemetryService, Depends(get_telemetry_service)],
+    http_request: Request,
+) -> OpenAIResponsesResponse | StreamingResponse | OpenAIErrorResponse:
+    """Create a response using OpenAI Responses API format.
+
+    This endpoint accepts a flow_id in the model parameter and processes
+    the input through the specified Langflow flow.
+
+    Args:
+        request: OpenAI Responses API request with model (flow_id) and input
+        background_tasks: FastAPI background task manager
+        api_key_user: Authenticated user from API key
+        http_request: The incoming HTTP request
+        telemetry_service: Telemetry service for logging
+
+    Returns:
+        OpenAI-compatible response or streaming response
+
+    Raises:
+        HTTPException: For validation errors or flow execution issues
+    """
+    start_time = time.perf_counter()
+
+    # Extract global variables from X-LANGFLOW-GLOBAL-VAR-* headers
+    variables = {}
+    header_prefix = "x-langflow-global-var-"
+
+    logger.debug(f"All headers received: {list(http_request.headers.keys())}")
+    logger.debug(f"Looking for headers starting with: {header_prefix}")
+
+    for header_name, header_value in http_request.headers.items():
+        header_lower = header_name.lower()
+        logger.debug(f"Checking header: '{header_lower}' (original: '{header_name}')")
+        if header_lower.startswith(header_prefix):
+            # Extract variable name from header (remove prefix) and convert to uppercase
+            var_name_lower = header_lower[len(header_prefix) :]
+            var_name = var_name_lower.upper()  # Default to uppercase
+
+            variables[var_name] = header_value
+            logger.debug(
+                f"Found global variable: {var_name} = {header_value} "
+                f"(converted to uppercase from header: {header_name})"
+            )
+
+    logger.debug(f"Extracted global variables from headers: {list(variables.keys())}")
+    logger.debug(f"Variables dict: {variables}")
+
+    # Validate tools parameter - error out if tools are provided
+    if request.tools is not None:
+        error_response = create_openai_error(
+            message="Tools are not supported yet",
+            type_="invalid_request_error",
+            code="tools_not_supported",
+        )
+        return OpenAIErrorResponse(error=error_response["error"])
+
+    # Get flow using the model field (which contains flow_id)
+    try:
+        flow = await get_flow_by_id_or_endpoint_name(request.model, str(api_key_user.id))
+    except HTTPException:
+        flow = None
+
+    if flow is None:
+        error_response = create_openai_error(
+            message=f"Flow with id '{request.model}' not found",
+            type_="invalid_request_error",
+            code="flow_not_found",
+        )
+        return OpenAIErrorResponse(error=error_response["error"])
+
+    try:
+        # Process the request
+        result = await run_flow_for_openai_responses(
+            flow=flow,
+            request=request,
+            api_key_user=api_key_user,
+            stream=request.stream,
+            variables=variables,
+        )
+
+        # Log telemetry for successful completion
+        if not request.stream:  # Only log for non-streaming responses
+            end_time = time.perf_counter()
+            background_tasks.add_task(
+                telemetry_service.log_package_run,
+                RunPayload(
+                    run_is_webhook=False,
+                    run_seconds=int(end_time - start_time),
+                    run_success=True,
+                    run_error_message="",
+                ),
+            )
+
+    except Exception as exc:  # noqa: BLE001
+        logger.error(f"Error processing OpenAI Responses request: {exc}")
+
+        # Log telemetry for failed completion
+        background_tasks.add_task(
+            telemetry_service.log_package_run,
+            RunPayload(
+                run_is_webhook=False,
+                run_seconds=int(time.perf_counter() - start_time),
+                run_success=False,
+                run_error_message=str(exc),
+            ),
+        )
+
+        # Return OpenAI-compatible error
+        error_response = create_openai_error(
+            message=str(exc),
+            type_="processing_error",
+        )
+        return OpenAIErrorResponse(error=error_response["error"])
+    return result