# Run with Node.js SDK

Use the official `@fetch-hive/sdk` package when you want to send a message to an agent from Node.js or TypeScript. The SDK wraps the public [`POST /v1/agent/invoke`](/api-reference/invoke-agent.md) endpoint, handles authentication, exposes streaming as an `AsyncIterable`, and supports multimodal inputs.

## Installation

```bash
npm install @fetch-hive/sdk
# or
yarn add @fetch-hive/sdk
# or
pnpm add @fetch-hive/sdk
```

The SDK targets Node.js 18+ (uses the global `fetch`) and ships with TypeScript types.

## Authentication

Set the `FETCH_HIVE_API_KEY` environment variable to your workspace API key:

```bash
export FETCH_HIVE_API_KEY=fhk_...
```

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

const client = new FetchHive();
```

Or pass the key explicitly:

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

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

## Basic example

Send a message to an agent and read the final response:

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

const client = new FetchHive();

const reply = await client.invokeAgent({
  agent: 'AGENT_UUID',
  message: 'Summarize the latest AI infrastructure trends',
});

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

See the [non-streaming response shape](/api-reference/invoke-agent.md#response).

## Method reference

| Field        | Type                                    | Required | Description                                                                           |
| ------------ | --------------------------------------- | -------- | ------------------------------------------------------------------------------------- |
| `agent`      | `string`                                | Yes      | The agent ID                                                                          |
| `message`    | `string`                                | Yes      | The message you want to send                                                          |
| `thread_id`  | `string`                                | No       | An arbitrary string identifying a persistent conversation thread                      |
| `messages`   | `Array<{ role, content, image_urls? }>` | No       | Caller-managed conversation history                                                   |
| `image_urls` | `string[]`                              | No       | HTTPS image URLs attached to the current `message` for multimodal inputs              |
| `user`       | `string`                                | No       | Opaque caller identifier surfaced in [User Tracking](/user-tracking/user-tracking.md) |

The SDK injects `streaming: false` for `invokeAgent`. To stream, use `invokeAgentStream` (below).

## Handling the response

```typescript
const reply = await client.invokeAgent({
  agent: 'AGENT_UUID',
  message: 'Hello',
});

console.log(reply.response);     // final text
console.log(reply.model);        // model identifier
console.log(reply.usage);        // token usage breakdown
console.log(reply.request_id);   // use this to look up the run in Logs
console.log(reply.tool_calls);   // tool invocations made during the run
```

## Streaming

Use `invokeAgentStream` to receive Server-Sent Events as they arrive. The method returns an `AsyncIterable`:

```typescript
for await (const chunk of client.invokeAgentStream({
  agent: 'AGENT_UUID',
  message: 'Summarize the latest AI infrastructure trends',
  thread_id: 'user-456-support-session',
})) {
  if (chunk.type === 'response') {
    process.stdout.write(chunk.response ?? '');
  } else if (chunk.type === 'tool') {
    console.log(`\n[Calling tool: ${chunk.tool}]`);
  } else if (chunk.type === 'usage') {
    console.log('\n\nUsage:', chunk.usage);
  }
}
```

The stream yields the same event types documented in [Invoke Agent → Response](/api-reference/invoke-agent.md#response): `summary` (when auto-summarization fires), `reasoning`, `response`, `tool`, and a final `usage` event.

## Multi-turn conversations

### Persistent threads

Pass any string as `thread_id` and Fetch Hive will create the thread on the first call and resume it on subsequent calls with the same value:

```typescript
await client.invokeAgent({
  agent: 'AGENT_UUID',
  message: 'What are the main AI infrastructure trends right now?',
  thread_id: 'user-456-support-session',
});

await client.invokeAgent({
  agent: 'AGENT_UUID',
  message: 'Which of those trends have the most enterprise adoption?',
  thread_id: 'user-456-support-session',
});
```

### Stateless history

Manage state yourself by passing the previous turns in `messages`. Fetch Hive uses the supplied history for context but does not persist it:

```typescript
await client.invokeAgent({
  agent: 'AGENT_UUID',
  message: 'Which of those trends have the most enterprise adoption?',
  messages: [
    { role: 'user', content: 'What are the main AI infrastructure trends right now?' },
    { role: 'assistant', content: 'Teams are focusing on evals, tool routing, and observability.' },
  ],
});
```

## Multimodal inputs

Attach images to the current message with `image_urls`:

```typescript
const result = await client.invokeAgent({
  agent: 'vision-agent',
  message: 'Describe this image',
  image_urls: ['https://example.com/photo.jpg'],
});
console.log(result.response);
```

URLs must start with `https://`.

## Configuration

| Option    | Default                          | Description                     |
| --------- | -------------------------------- | ------------------------------- |
| `apiKey`  | `process.env.FETCH_HIVE_API_KEY` | Bearer token from the dashboard |
| `baseURL` | `https://api.fetchhive.com/v1`   | Override the API base URL       |

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

## Errors

Non-2xx responses throw an `Error` whose message includes the status code and response body:

```typescript
try {
  const reply = await client.invokeAgent({
    agent: 'AGENT_UUID',
    message: 'Hello',
  });
} catch (err) {
  console.error('Fetch Hive error:', err);
}
```

See [Errors and Rate Limits](/api-reference/errors-and-rate-limits.md) for status code meanings.

## Links

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

## Next steps

* [Run with API](/agents/run-with-api.md) - The same flow with cURL
* [Run with Python SDK](/agents/run-with-python-sdk.md)
* [Run with Ruby SDK](/agents/run-with-ruby-sdk.md)
* [Run with PHP SDK](/agents/run-with-php-sdk.md)
* [Invoke Agent](/api-reference/invoke-agent.md) - Full endpoint reference


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fetchhive.com/agents/run-with-nodejs-sdk.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.