> ## 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.

# Ejecutar con el SDK de Python

> Invoca un deployment de flujo de trabajo desde Python con el paquete fetch-hive-sdk

# Ejecutar con el SDK de Python

Usa el paquete oficial `fetch-hive-sdk` cuando quieras invocar un deployment de flujo de trabajo desde Python. El SDK envuelve el endpoint público [`POST /v1/workflow/invoke`](../api-reference/workflows/invoke), maneja la autenticación y admite tanto respuestas directas como entrega por callback.

## Instalación

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

El SDK requiere Python 3.9+ y usa `httpx` por debajo.

## Autenticación

Configura la variable de entorno `FETCH_HIVE_API_KEY` con tu clave de API del workspace (el SDK la lee automáticamente):

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

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

client = FetchHive()
```

O pasa la clave explícitamente:

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

Consulta [API Keys](../workspace/api-keys) para saber cómo crear y rotar claves.

## Ejemplo básico

Ejecuta un deployment de flujo de trabajo directamente. La llamada se bloquea hasta que el flujo de trabajo termina:

```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"])
```

Consulta la [forma de respuesta directa](../api-reference/workflows/invoke#response).

## Referencia del método

| Argumento      | Tipo                                             | Requerido | Descripción                                                                                                                                      |
| -------------- | ------------------------------------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `deployment`   | `str`                                            | Sí        | El nombre del deployment del flujo de trabajo                                                                                                    |
| `variant`      | `str`                                            | No        | El nombre de la variante del deployment                                                                                                          |
| `inputs`       | `dict[str, Any]`                                 | No        | Pares clave-valor para las variables definidas en el paso **Start**                                                                              |
| `async_mode`   | `bool`                                           | No        | Cuando es `True`, devuelve respuesta inmediatamente y entrega el resultado mediante callback firmado                                             |
| `callback_url` | `str`                                            | No        | Requerido cuando `async_mode=True` - la URL HTTPS de callback a la que llamar cuando la ejecución termine                                        |
| `user`         | `str`                                            | No        | Identificador opaco de quien llama, expuesto en [User Tracking](../user-tracking/overview)                                                       |
| `metadata`     | `dict[str, str \| int \| float \| bool \| None]` | No        | Metadata plana definida por quien llama, para auditoría y filtrado de registros. Consulta [Metadata de invoke](../user-tracking/invoke-metadata) |

`invoke_workflow` construye el cuerpo de la solicitud por ti. Cuando pasas `async_mode=True`, el SDK envía:

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

## Manejo de la respuesta

```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
```

## Entrega por callback

Pasa `async_mode=True` para devolver respuesta inmediatamente y hacer que Fetch Hive llame a tu URL de callback cuando la ejecución termine:

```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"])
```

Almacena el `webhook_secret` para que puedas verificar la firma en el callback entrante. Consulta [Entrega por callback y disparadores de webhook](./async-and-webhooks) para el flujo de verificación y la forma del payload firmado.

## Configuración

| Opción     | Predeterminado                           | Descripción                                                                                                    |
| ---------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `api_key`  | variable de entorno `FETCH_HIVE_API_KEY` | Token bearer del dashboard                                                                                     |
| `base_url` | `https://api.fetchhive.com/v1`           | Sobrescribe la URL base de la API                                                                              |
| `timeout`  | `120`                                    | Timeout de la solicitud en segundos - aumenta para solicitudes directas de flujos de trabajo de larga duración |

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

## Errores

Las respuestas distintas a 2xx lanzan un `httpx.HTTPStatusError` con el código de estado y el cuerpo de la respuesta:

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

Consulta [Manejo de errores](./error-handling) para los casos de fallo específicos del flujo de trabajo y [Errors and Rate Limits](../api-reference/errors-and-rate-limits) para el significado de los códigos de estado HTTP.

## Enlaces

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

## Siguientes pasos

* [Entrega por callback y disparadores de webhook](./async-and-webhooks) - Verifica las firmas de callback
* [Ejecutar con API](./run-with-api) - El mismo flujo con cURL
* [Ejecutar con el SDK de Node.js](./run-with-nodejs-sdk)
* [Ejecutar con el SDK de Ruby](./run-with-ruby-sdk)
* [Ejecutar con el SDK de PHP](./run-with-php-sdk)
* [Invoke Workflow](../api-reference/workflows/invoke) - Referencia completa del endpoint