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

> Invoca un deployment de flujo de trabajo desde PHP con el paquete de Composer fetch-hive/sdk

# Ejecutar con el SDK de PHP

Usa el paquete oficial de Composer `fetch-hive/sdk` cuando quieras invocar un deployment de flujo de trabajo desde PHP. 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}
composer require fetch-hive/sdk
```

El SDK requiere PHP 8.1+ y usa Guzzle como su cliente HTTP.

## Autenticación

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

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

```php theme={null}
<?php
require_once 'vendor/autoload.php';

use FetchHive\Sdk\FetchHive;

$client = new FetchHive();
```

O pasa la clave explícitamente:

```php theme={null}
$client = new 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:

```php theme={null}
<?php
require_once 'vendor/autoload.php';

use FetchHive\Sdk\FetchHive;

$client = new FetchHive();

$run = $client->invokeWorkflow([
    'deployment' => 'YOUR_DEPLOYMENT_NAME',
    'variant'    => 'YOUR_VARIANT_NAME',
    'inputs'     => ['topic' => 'State of enterprise AI in 2026'],
]);

echo $run['run_status'] . PHP_EOL;
echo $run['output'];
```

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

## Referencia del método

| Clave          | Tipo     | Requerido | Descripción                                                                                                                                      |
| -------------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `deployment`   | `string` | Sí        | El nombre del deployment del flujo de trabajo                                                                                                    |
| `variant`      | `string` | No        | El nombre de la variante del deployment                                                                                                          |
| `inputs`       | `array`  | 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` | `string` | No        | Requerido cuando `async_mode: true` - la URL HTTPS de callback a la que llamar cuando la ejecución termine                                       |
| `user`         | `string` | No        | Identificador opaco de quien llama, expuesto en [User Tracking](../user-tracking/overview)                                                       |
| `metadata`     | `array`  | No        | Metadata plana definida por quien llama, para auditoría y filtrado de registros. Consulta [Metadata de invoke](../user-tracking/invoke-metadata) |

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

```php theme={null}
$run = $client->invokeWorkflow([
    'deployment' => 'my-workflow',
    'variant'    => 'default',
]);

echo $run['run_status'];      // "completed" | "failed" | "running" | "queued"
echo $run['output'];          // final workflow output
echo $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:

```php theme={null}
$run = $client->invokeWorkflow([
    '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',
]);

echo 'Queued: ' . $run['run_status'] . PHP_EOL;
echo '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 |

```php theme={null}
$client = new FetchHive([
    'api_key'  => 'fhk_...',
    'base_url' => 'https://api.fetchhive.com/v1',
    'timeout'  => 600.0,
]);
```

## Errores

Las respuestas distintas a 2xx lanzan `FetchHive\Sdk\Exception\ApiException` con el código de estado y el cuerpo de la respuesta:

```php theme={null}
use FetchHive\Sdk\Exception\ApiException;

try {
    $run = $client->invokeWorkflow([
        'deployment' => 'my-workflow',
        'variant'    => 'default',
    ]);
} catch (ApiException $e) {
    error_log('Fetch Hive error: ' . $e->getMessage());
}
```

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 Packagist](https://packagist.org/packages/fetch-hive/sdk)
* [Source on GitHub](https://github.com/Fetch-Hive/php-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 Python](./run-with-python-sdk)
* [Ejecutar con el SDK de Node.js](./run-with-nodejs-sdk)
* [Ejecutar con el SDK de Ruby](./run-with-ruby-sdk)
* [Invoke Workflow](../api-reference/workflows/invoke) - Referencia completa del endpoint