{"id":27869,"library":"ibm-watsonx-orchestrate-clients","title":"IBM watsonx Orchestrate API Client","description":"IBM watsonx Orchestrate ADK API Client Library for Python. Version 2.9.0 requires Python 3.11-3.13. Provides client classes to interact with watsonx Orchestrate APIs. Releases follow IBM's cadence.","status":"active","version":"2.9.0","language":"python","source_language":"en","source_url":"https://github.com/IBM/watsonx-orchestrate-clients","tags":["ibm","watsonx","orchestrate","api-client","sdk"],"install":[{"cmd":"pip install ibm-watsonx-orchestrate-clients","lang":"bash","label":"PyPI"}],"dependencies":[],"imports":[{"note":"The package name uses underscores, not hyphens. The module is `ibm_watsonx_orchestrate`.","wrong":"from ibm_watsonx_orchestrate_clients import OrchestrateClient","symbol":"OrchestrateClient","correct":"from ibm_watsonx_orchestrate import OrchestrateClient"},{"note":"Token management is done via IBM Cloud SDK Core authenticators, not directly from this package.","wrong":"from ibm_watsonx_orchestrate import TokenManager","symbol":"TokenManager","correct":"from ibm_cloud_sdk_core.authenticators import IAMAuthenticator"}],"quickstart":{"code":"from ibm_watsonx_orchestrate import OrchestrateClient\nfrom ibm_cloud_sdk_core.authenticators import IAMAuthenticator\n\nauthenticator = IAMAuthenticator('your-api-key')\nclient = OrchestrateClient(authenticator=authenticator)\nclient.set_service_url('https://api.watsonx.orchestrate.cloud.ibm.com')\n# List solutions\nsolutions = client.list_solutions().get_result()\nprint(solutions)","lang":"python","description":"Initializes the client with an IAM API key and lists solutions."},"warnings":[{"fix":"Use `from ibm_watsonx_orchestrate import OrchestrateClient`.","message":"Import uses underscores: `from ibm_watsonx_orchestrate` not `ibm_watsonx_orchestrate_clients`.","severity":"gotcha","affected_versions":"all"},{"fix":"Always pass an `authenticator` from `ibm_cloud_sdk_core` instead of raw API keys.","message":"The `OrchestrateClient` constructor may accept parameters that are deprecated; use authenticator objects.","severity":"deprecated","affected_versions":">=2.0.0"},{"fix":"Call `client.set_service_url('https://api.watsonx.orchestrate.cloud.ibm.com')` after construction.","message":"Service URL must be set explicitly; defaults may point to wrong region or staging.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-09T00:00:00.000Z","next_check":"2026-08-07T00:00:00.000Z","problems":[{"fix":"Install `pip install ibm-watsonx-orchestrate-clients` and use `from ibm_watsonx_orchestrate import OrchestrateClient`.","cause":"Package not installed or wrong import name.","error":"ModuleNotFoundError: No module named 'ibm_watsonx_orchestrate'"},{"fix":"Correct import: `from ibm_watsonx_orchestrate import OrchestrateClient`.","cause":"Using the package name with hyphens as module name.","error":"ImportError: cannot import name 'OrchestrateClient' from 'ibm_watsonx_orchestrate_clients'"},{"fix":"Use `from ibm_cloud_sdk_core.authenticators import IAMAuthenticator` and pass `authenticator=IAMAuthenticator('your-key')`.","cause":"Passing api_key directly to OrchestrateClient constructor is not supported; use authenticator.","error":"TypeError: __init__() got an unexpected keyword argument 'api_key'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}