Skip to main content
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 endpoint, handles authentication, exposes streaming as an AsyncIterable, and supports multimodal inputs.

Installation

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:
Or pass the key explicitly:
See API Keys for how to create and rotate keys.

Basic example

Send a message to an agent and read the final response:
See the non-streaming response shape.

Method reference

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

Handling the response

Streaming

Use invokeAgentStream to receive Server-Sent Events as they arrive. The method returns an AsyncIterable:
The stream yields the same event types documented in Invoke Agent → Response: summary (when auto-summarization fires), reasoning, response, tool, a final usage event, or an error event if the provider fails mid-stream.

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:

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:

Multimodal inputs

Attach images to the current message with attachments:
URLs must start with https://.

Configuration

Errors

Non-2xx responses throw an Error whose message includes the status code and response body:
See Errors and Rate Limits for status code meanings.

Next steps