OpenAI Responses API

Create Response

Changed on

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

post/api/v1/responses

Request

  • The document declares no server URL.
  • Auth
    • API key in query parameter x-api-key
    • or API key in header x-api-key

Request body

backgroundboolean

Whether to process in background

includestring[] nullable

Additional response data to include, e.g., ['tool_call.results']

inputstring required

The input text to process

modelstring required

The flow ID to execute (used instead of OpenAI model)

previous_response_idstring nullable

ID of previous response to continue conversation

streamboolean

Whether to stream the response

Response

Successful Response

unknown required

Changes

  • 830c31118215Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 9bd3e81318d7Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status