Skip to main content
Use the official @fetch-hive/sdk package when you want to invoke a prompt deployment from Node.js or TypeScript. The SDK wraps the public POST /v1/prompt/invoke endpoint with a typed client, handles authentication, and exposes streaming as an AsyncIterable.

Installation

The SDK targets Node.js 18+ (it uses the global fetch) and ships with TypeScript types out of the box.

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

Invoke a prompt deployment and read the final response:
invokePrompt returns a Promise that resolves to the parsed JSON body once the prompt has completed. See the non-streaming response shape.

Method reference

The SDK injects streaming: false for invokePrompt. To stream, use invokePromptStream (below).

Handling the response

Streaming

Use invokePromptStream to receive Server-Sent Events as they arrive. The method returns an AsyncIterable that you can consume with for await:
The stream yields the same event types documented in Invoke Prompt → Response: reasoning, response, a final usage event, or an error event if the provider fails mid-stream.

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