> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchhive.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Run with Python SDK

> Invoke a workflow deployment from Python with the fetch-hive-sdk package

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`](../api-reference/workflows/invoke) endpoint, handles authentication, and supports both direct responses and callback delivery.

## Installation

```bash theme={null}
pip install fetch-hive-sdk
```

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):

```bash theme={null}
export FETCH_HIVE_API_KEY=fhk_...
```

```python theme={null}
from fetch_hive_sdk import FetchHive

client = FetchHive()
```

Or pass the key explicitly:

```python theme={null}
client = FetchHive(api_key="fhk_...")
```

See [API Keys](../workspace/api-keys) for how to create and rotate keys.

## Basic example

Run a workflow deployment directly. The call blocks until the workflow finishes:

```python theme={null}
from fetch_hive_sdk import FetchHive

client = FetchHive()

run = client.invoke_workflow(
    deployment="YOUR_DEPLOYMENT_NAME",
    variant="YOUR_VARIANT_NAME",
    inputs={"topic": "State of enterprise AI in 2026"},
)

print(run["run_status"])
print(run["output"])
```

See the [direct response shape](../api-reference/workflows/invoke#response).

## Method reference

| Argument       | Type                                             | Required | Description                                                                                                       |
| -------------- | ------------------------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------- |
| `deployment`   | `str`                                            | Yes      | The workflow deployment name                                                                                      |
| `variant`      | `str`                                            | No       | The deployment variant name                                                                                       |
| `inputs`       | `dict[str, Any]`                                 | No       | Key-value pairs for the variables defined on the **Start** step                                                   |
| `async_mode`   | `bool`                                           | No       | When `True`, return immediately and deliver the result by signed callback                                         |
| `callback_url` | `str`                                            | No       | Required when `async_mode=True` - the HTTPS callback URL to call when the run finishes                            |
| `user`         | `str`                                            | No       | Opaque caller identifier surfaced in [User Tracking](../user-tracking/overview)                                   |
| `metadata`     | `dict[str, str \| int \| float \| bool \| None]` | No       | Flat caller-defined metadata for audit and log filtering. See [Invoke metadata](../user-tracking/invoke-metadata) |

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

```json theme={null}
{
  "async": { "enabled": true, "callback_url": "https://example.com/webhook" }
}
```

## Handling the response

```python theme={null}
run = client.invoke_workflow(deployment="my-workflow", variant="default")

print(run["run_status"])    # "completed" | "failed" | "running" | "queued"
print(run["output"])        # final workflow output
print(run["request_id"])    # use this to look up the run in Logs
```

## Callback delivery

Pass `async_mode=True` to return immediately and have Fetch Hive call your callback URL when the run finishes:

```python theme={null}
run = client.invoke_workflow(
    deployment="YOUR_DEPLOYMENT_NAME",
    variant="YOUR_VARIANT_NAME",
    inputs={"topic": "State of enterprise AI in 2026"},
    async_mode=True,
    callback_url="https://example.com/callback",
)

print("Queued:", run["run_status"])
print("Webhook secret:", run["webhook_secret"])
```

Store the `webhook_secret` so you can verify the signature on the incoming callback. See [Callback Delivery and Webhook Triggers](./async-and-webhooks) for the verification flow and signed payload shape.

## Configuration

| Option     | Default                        | Description                                                                     |
| ---------- | ------------------------------ | ------------------------------------------------------------------------------- |
| `api_key`  | `FETCH_HIVE_API_KEY` env var   | Bearer token from the dashboard                                                 |
| `base_url` | `https://api.fetchhive.com/v1` | Override the API base URL                                                       |
| `timeout`  | `120`                          | Request timeout in seconds - increase for long-running direct workflow requests |

```python theme={null}
client = FetchHive(
    api_key="fhk_...",
    base_url="https://api.fetchhive.com/v1",
    timeout=600,
)
```

## Errors

Non-2xx responses raise an `httpx.HTTPStatusError` with the status code and response body:

```python theme={null}
import httpx

try:
    run = client.invoke_workflow(deployment="my-workflow", variant="default")
except httpx.HTTPStatusError as exc:
    print("Fetch Hive returned", exc.response.status_code, exc.response.text)
```

See [Error Handling](./error-handling) for workflow-specific failure cases and [Errors and Rate Limits](../api-reference/errors-and-rate-limits) for HTTP status code meanings.

## Links

* [Package on PyPI](https://pypi.org/project/fetch-hive-sdk/)
* [Source on GitHub](https://github.com/Fetch-Hive/python-sdk)

## Next steps

* [Callback Delivery and Webhook Triggers](./async-and-webhooks) - Verify callback signatures
* [Run with API](./run-with-api) - The same flow with cURL
* [Run with Node.js SDK](./run-with-nodejs-sdk)
* [Run with Ruby SDK](./run-with-ruby-sdk)
* [Run with PHP SDK](./run-with-php-sdk)
* [Invoke Workflow](../api-reference/workflows/invoke) - Full endpoint reference