Skip to main content

lfx-openai-compatible

Generic OpenAI-compatible endpoints as a first-class Langflow model provider, packaged as a standalone Extension Bundle.

Registers an OpenAI Compatible model provider that appears in Langflow's unified model picker alongside the built-in providers. Any service that speaks the OpenAI HTTP API shape can be configured through it — for example:

Provider Base URL
OpenRouter https://openrouter.ai/api/v1
Together AI https://api.together.xyz/v1
Groq https://api.groq.com/openai/v1
Fireworks AI https://api.fireworks.ai/inference/v1
Self-hosted vLLM / TGI / LM Studio http://localhost:8000/v1

The provider reuses the ChatOpenAI / OpenAIEmbeddings classes and discovers the served models live from the endpoint's /v1/models route — the same model is therefore offered in both the Language Model and Embedding Model contexts.

Unlike a component bundle, this ships no component: it contributes a provider through the providers[] block in extension.json, which Langflow's provider registry merges into the unified model system. It edits no Langflow core files.

Configure

Set the endpoint (and, if it requires one, an API key) under Settings → Model Providers → OpenAI Compatible, or via environment variables:

  • OPENAI_COMPATIBLE_BASE_URL — base URL of the endpoint, e.g. https://openrouter.ai/api or http://localhost:8000 (required). The bundle's provider manifest declares base_url_suffix: /v1, so Langflow appends /v1 when it is missing and preserves endpoints that already include it.
  • OPENAI_COMPATIBLE_API_KEY — bearer token, if the endpoint enforces one (optional; local servers without auth do not need it).

The provider holds one endpoint at a time. For a second concurrent custom endpoint, combine it with the built-in OpenAI provider's Base URL override or the vLLM provider (lfx-vllm).

Install

pip install lfx-openai-compatible

The bundle is registered automatically via the langflow.extensions entry-point. Restart your Langflow server and select OpenAI Compatible in any Language Model or Embedding Model field.

Develop

cd src/bundles/openai-compatible
pip install -e .
lfx extension validate src/lfx_openai_compatible

Credit

Resolves the feature request in #12839. Follows the provider-bundle pattern established by lfx-vllm (#13919).

Metadata

Release files for lfx-openai-compatible 0.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for lfx-openai-compatible 0.1.3
File Interpreter ABI Platform
lfx_openai_compatible-0.1.3-py3-none-any.whl Python 3 none any Details

Release files / lfx_openai_compatible-0.1.3-py3-none-any.whl

Download URL lfx_openai_compatible-0.1.3-py3-none-any.whl
Size 6.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a7bbe0be1d28d39ce8e9582611d65897c66e058d39dfa8ddea3fbccabc3060cd
BLAKE2b-256 checksum
How to use checksums
9bb2f7c5de7b9c31be94ff20b327ae9c7dd219965169e3acd190d6cd542bf62a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

0.1.5

1 release file

0.1.4

1 release file

This release

0.1.3 This release

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page