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 yourGemfile:
faraday under the hood and supports Ruby 3.0+.
Authentication
Set theFETCH_HIVE_API_KEY environment variable to your workspace API key (the client reads it automatically):
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
Useinvoke_prompt_stream to receive Server-Sent Events as they arrive. The method yields each parsed event hash to the block:
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 aRuntimeError with the status code and body. Rescue them if you need to handle failures:
Links
Next steps
- Run with API - The same flow with cURL
- Run with Python SDK
- Run with Node.js SDK
- Run with PHP SDK
- Invoke Prompt - Full endpoint reference

