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

> Invoca un deployment de prompt desde Node.js o TypeScript con el paquete @fetch-hive/sdk

# Ejecutar con el SDK de Node.js

Usa el paquete oficial `@fetch-hive/sdk` cuando quieras invocar un deployment de prompt desde Node.js o TypeScript. El SDK envuelve el endpoint público [`POST /v1/prompt/invoke`](../api-reference/prompts/invoke) con un cliente tipado, maneja la autenticación y expone el streaming como un `AsyncIterable`.

## Instalación

```bash theme={null}
npm install @fetch-hive/sdk
# or
yarn add @fetch-hive/sdk
# or
pnpm add @fetch-hive/sdk
```

El SDK está dirigido a Node.js 18+ (usa el `fetch` global) y viene con tipos TypeScript desde el inicio.

## Autenticación

Configura la variable de entorno `FETCH_HIVE_API_KEY` con tu clave de API del workspace:

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

```typescript theme={null}
import { FetchHive } from '@fetch-hive/sdk';

const client = new FetchHive();
```

O pasa la clave explícitamente:

```typescript theme={null}
const client = new FetchHive({ apiKey: 'fhk_...' });
```

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

## Ejemplo básico

Invoca un deployment de prompt y lee la respuesta final:

```typescript theme={null}
import { FetchHive } from '@fetch-hive/sdk';

const client = new FetchHive();

const result = await client.invokePrompt({
  deployment: 'YOUR_DEPLOYMENT_NAME',
  variant: 'YOUR_VARIANT_NAME',
  inputs: { text: 'Fetch Hive helps teams ship AI products faster.' },
});

console.log(result.response);
```

`invokePrompt` devuelve una `Promise` que se resuelve al cuerpo JSON analizado una vez que el prompt se ha completado. Consulta la [forma de respuesta sin streaming](../api-reference/prompts/invoke#response).

## Referencia del método

| Campo        | Tipo                                                  | Requerido | Descripción                                                                                                                                      |
| ------------ | ----------------------------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `deployment` | `string`                                              | Sí        | El nombre del deployment de prompt                                                                                                               |
| `variant`    | `string`                                              | No        | El nombre de la variante del deployment                                                                                                          |
| `inputs`     | `Record<string, unknown>`                             | No        | Pares clave-valor para las variables del prompt                                                                                                  |
| `user`       | `string`                                              | No        | Identificador opaco de quien llama, expuesto en [User Tracking](../user-tracking/overview)                                                       |
| `metadata`   | `Record<string, string \| number \| boolean \| null>` | No        | Metadata plana definida por quien llama, para auditoría y filtrado de registros. Consulta [Metadata de invoke](../user-tracking/invoke-metadata) |

El SDK inyecta `streaming: false` para `invokePrompt`. Para transmitir, usa `invokePromptStream` (a continuación).

## Manejo de la respuesta

```typescript theme={null}
const result = await client.invokePrompt({
  deployment: 'my-prompt',
  variant: 'default',
});

console.log(result.response);     // final text
console.log(result.model);        // model identifier
console.log(result.usage);        // token usage breakdown
console.log(result.request_id);   // use this to look up the run in Logs
```

## Streaming

Usa `invokePromptStream` para recibir Server-Sent Events a medida que llegan. El método devuelve un `AsyncIterable` que puedes consumir con `for await`:

```typescript theme={null}
for await (const chunk of client.invokePromptStream({
  deployment: 'YOUR_DEPLOYMENT_NAME',
  variant: 'YOUR_VARIANT_NAME',
  inputs: { text: 'Fetch Hive helps teams ship AI products faster.' },
})) {
  if (chunk.type === 'response') {
    process.stdout.write(chunk.response ?? '');
  } else if (chunk.type === 'usage') {
    console.log('\n\nUsage:', chunk.usage);
  }
}
```

La transmisión produce los mismos tipos de evento documentados en [Invoke Prompt → Response](../api-reference/prompts/invoke#response): `reasoning`, `response`, un evento `usage` final o un evento `error` si el proveedor falla durante la transmisión.

## Configuración

| Opción    | Predeterminado                   | Descripción                       |
| --------- | -------------------------------- | --------------------------------- |
| `apiKey`  | `process.env.FETCH_HIVE_API_KEY` | Token bearer del dashboard        |
| `baseURL` | `https://api.fetchhive.com/v1`   | Sobrescribe la URL base de la API |

```typescript theme={null}
const client = new FetchHive({
  apiKey: 'fhk_...',
  baseURL: 'https://api.fetchhive.com/v1',
});
```

## Errores

Las respuestas distintas a 2xx lanzan un `Error` cuyo mensaje incluye el código de estado y el cuerpo de la respuesta:

```typescript theme={null}
try {
  const result = await client.invokePrompt({
    deployment: 'my-prompt',
    variant: 'default',
  });
} catch (err) {
  console.error('Fetch Hive error:', err);
}
```

Consulta [Errors and Rate Limits](../api-reference/errors-and-rate-limits) para el significado de los códigos de estado.

## Enlaces

* [Package on npm](https://www.npmjs.com/package/@fetch-hive/sdk)
* [Source on GitHub](https://github.com/Fetch-Hive/nodejs-sdk)

## Siguientes pasos

* [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 Ruby](./run-with-ruby-sdk)
* [Ejecutar con el SDK de PHP](./run-with-php-sdk)
* [Invoke Prompt](../api-reference/prompts/invoke) - Referencia completa del endpoint