Skip to main content
Use the official fetch_hive gem when you want to invoke a prompt deployment from Ruby. The SDK wraps the public POST /v1/prompt/invoke endpoint with idiomatic helpers, handles authentication, and parses streaming responses into yielded hashes.

Installation

Add to your Gemfile:
Then run:
Or install directly:
The gem uses faraday under the hood and supports Ruby 3.0+.

Authentication

Set the FETCH_HIVE_API_KEY environment variable to your workspace API key (the client reads it automatically):
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:
invoke_prompt blocks until the prompt completes and returns the parsed JSON body as a hash. See the non-streaming response shape.

Method reference

The SDK injects streaming: false for invoke_prompt. To stream, use invoke_prompt_stream (below).

Handling the response

Streaming

Use invoke_prompt_stream to receive Server-Sent Events as they arrive. The method yields each parsed event hash to the block:
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. If you omit the block, the method returns an Enumerator you can pass around:

Configuration

Errors

Non-2xx responses raise a RuntimeError with the status code and body. Rescue them if you need to handle failures:
See Errors and Rate Limits for status code meanings.

Next steps