Langflow Control Plane Python SDK

langflow-control-plane-sdk is the generated async Python 3.10+ client for the Langflow Control Plane OpenAPI contract. The import package is langflow_control_plane_sdk, which is intentionally distinct from the langflow-sdk package for Langflow's main REST API.

Install

pip install langflow-control-plane-sdk

Normal installs select stable releases. Use pip install --pre langflow-control-plane-sdk to include development and release-candidate builds, or install an exact version such as langflow-control-plane-sdk==0.1.0rc1.

Configure

Set the Control Plane base URL and its temporary pass-through x-api-key credential on the generated configuration:

import langflow_control_plane_sdk as control_plane

configuration = control_plane.Configuration(
    host="https://control-plane.example",
    api_key={"LangflowAPIKey": "replace-me"},
)

The key is sent as x-api-key; do not log it. This pass-through authentication scheme is temporary. A future authentication change can affect SDK users and is therefore treated as semver-significant.

Async CRUD

from uuid import uuid4

import langflow_control_plane_sdk as control_plane

flow_id = uuid4()
flow = control_plane.Flow(
    flow_id=flow_id,
    name="hello-world",
    payload=control_plane.FlowPayload(
        data=control_plane.FlowPayloadData(nodes=[], edges=[]),
    ),
)

async with control_plane.ApiClient(configuration) as client:
    deployments = control_plane.DeploymentsApi(client)
    created = await deployments.create_deployment(
        control_plane.CreateDeployment(project_id=uuid4(), slug="hello-world", flows=[flow]),
    )
    fetched = await deployments.get_deployment(created.id)
    updated = await deployments.replace_deployment(
        created.id,
        control_plane.ReplaceDeployment(description="updated", flows=[flow]),
    )
    patched = await deployments.patch_deployment(
        created.id,
        control_plane.PatchDeployment(description="patched"),
    )
    await deployments.delete_deployment(created.id)

List responses always contain next_cursor; it is None on the last page. Pass a non-null cursor back unchanged:

async with control_plane.ApiClient(configuration) as client:
    deployments = control_plane.DeploymentsApi(client)
    page = await deployments.list_deployments(limit=50)
    while page.next_cursor is not None:
        page = await deployments.list_deployments(
            cursor=page.next_cursor,
            limit=50,
        )

Unsuccessful responses raise ApiException. For documented responses, exception.data is a typed ErrorEnvelope:

try:
    await deployments.get_deployment(deployment_id)
except control_plane.ApiException as exception:
    if isinstance(exception.data, control_plane.ErrorEnvelope):
        print(exception.data.error.code, exception.data.error.message)
    raise

Regenerate and test

Generation requires Python 3.10+, Java 11+, and the pinned generator. If Java is unavailable, jdk4py can optionally provide a local JVM.

make openapi-install
make sdk-py-install
make openapi-test
make sdk-py-generate
make sdk-py-test
make sdk-py-build

When using jdk4py, install it in the codegen environment with sdk/openapi-generator/.venv/bin/python -m pip install jdk4py.

Generated package files must not be edited by hand. Change api/openapi.yaml, the generator options in the root Makefile, or the templates, then regenerate them.

The checked-in SDK uses the base version 0.0.0. Release builds apply the exact v-prefixed Git tag version to a temporary build copy; the OpenAPI info.version independently identifies the API contract line.

See the repository's release guide for shared service and SDK versioning and tag formats.