Skip to main content
Use the official fetch-hive-sdk package when you want to invoke a workflow deployment from Python. The SDK wraps the public POST /v1/workflow/invoke endpoint, handles authentication, and supports both direct responses and callback delivery.

Installation

The SDK requires Python 3.9+ and uses httpx under the hood.

Authentication

Set the FETCH_HIVE_API_KEY environment variable to your workspace API key (the SDK reads it automatically):
Or pass the key explicitly:
See API Keys for how to create and rotate keys.

Basic example

Run a workflow deployment directly. The call blocks until the workflow finishes:
See the direct response shape.

Method reference

invoke_workflow builds the request body for you. When you pass async_mode=True, the SDK sends:

Handling the response

Callback delivery

Pass async_mode=True to return immediately and have Fetch Hive call your callback URL when the run finishes:
Store the webhook_secret so you can verify the signature on the incoming callback. See Callback Delivery and Webhook Triggers for the verification flow and signed payload shape.

Configuration

Errors

Non-2xx responses raise an httpx.HTTPStatusError with the status code and response body:
See Error Handling for workflow-specific failure cases and Errors and Rate Limits for HTTP status code meanings.

Next steps