fetch_hive 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb9c7b6224f335829b0c44df8fcbf9eb51a116d1adc8349662d5f19299fe0561
-  data.tar.gz: 00c639eeb3ae5857ba4044d481ece8f4e61d443522eec500e52ce05f1aa35406
+  metadata.gz: 6f27931a3ac0003f9116aa9e5d0fc8a872ace63a0514f5c700cd18df613c56d4
+  data.tar.gz: 0ebadee4a39f04f58af432fee05f8f3398397bf806c520506f9e808e00a4edfc
 SHA512:
-  metadata.gz: e202d13a1a682b2ceaa470e07153b42c2959398d6dfea6c15a4661c298fcbace443f557110b2783186eaac2186cc0ee50913a4948f68328f9981f029af5ca696
-  data.tar.gz: 911804e51870a54f5be80bd57fcb56088adf098fd9fbec00f518505eff89e68afb7ef28df44b9b80fcac2db2621bba4a2997ead022096e9ce792460aede7d663
+  metadata.gz: 4c3c0e5dc156a36db4bf8fe934f8cd8d65dc4b85e56c03deddb77f10fe7e7118bbf70946ee972fe666cefd40aab9d63e5fc1c6cfb0220876939473e53fa95e45
+  data.tar.gz: e2a222c32d2857f10030aaa90e1aefd1bae8a0cab2e9f3c1a3b0a97e526c3ffbd2473c124e81a4098b54755e0a895f3674eb1d06cd71eb2fa7185bee1a5e9e7e

data/README.md

@@ -1,15 +1,15 @@
-# Fetch Hive Ruby SDK
+# fetch_hive
 
-Official Ruby SDK for the [Fetch Hive](https://fetchhive.com) API — invoke prompts, workflows, and agents with a clean, idiomatic interface.
+Official Ruby SDK for [Fetch Hive](https://fetchhive.com) — invoke AI prompts, workflows, and agents from your application.
 
-**Version:** 0.2.2
+[![Gem Version](https://badge.fury.io/rb/fetch_hive.svg)](https://rubygems.org/gems/fetch_hive)
 
 ## Installation
 
 Add to your `Gemfile`:
 
 ```ruby
-gem "fetch_hive", "~> 0.2.2"
+gem "fetch_hive", "~> 0.2.3"
 ```
 
 Then run:
@@ -30,25 +30,98 @@ gem install fetch_hive
 require "fetch_hive"
 
 client = FetchHive::Client.new(api_key: ENV["FETCH_HIVE_API_KEY"])
+```
+
+Get your API key from the [Fetch Hive dashboard](https://app.fetchhive.com).
+
+## Invoke a prompt
 
-# Invoke a prompt
-result = client.invoke_prompt(deployment: "my-prompt", inputs: { name: "Alice" })
+```ruby
+result = client.invoke_prompt(
+  deployment: "my-prompt",
+  inputs: { name: "Alice", topic: "machine learning" }
+)
 puts result["response"]
+```
+
+## Invoke a prompt (streaming)
+
+```ruby
+client.invoke_prompt_stream(deployment: "my-prompt", inputs: { name: "Alice" }) do |chunk|
+  print chunk["content"] if chunk["type"] == "delta"
+end
+```
 
-# Invoke a workflow
-run = client.invoke_workflow(deployment: "my-workflow", inputs: { topic: "AI" })
-puts run["output"]
+## Invoke a workflow
 
-# Send a message to an agent (non-streaming)
-reply = client.invoke_agent(agent: "my-agent", message: "Hello!")
+```ruby
+run = client.invoke_workflow(
+  deployment: "my-workflow",
+  inputs: { customer_id: "42" }
+)
+puts run["status"], run["output"]
+```
+
+## Invoke a workflow (async)
+
+```ruby
+run = client.invoke_workflow(
+  deployment: "my-workflow",
+  inputs: { customer_id: "42" },
+  async_mode: true,
+  callback_url: "https://example.com/webhook"
+)
+puts "Queued: #{run['run_id']}"
+```
+
+## Invoke an agent
+
+```ruby
+reply = client.invoke_agent(
+  agent: "my-agent",
+  message: "What is the weather in London?"
+)
 puts reply["response"]
+```
 
-# Stream an agent response
-client.invoke_agent_stream(agent: "my-agent", message: "Tell me a story") do |chunk|
-  print chunk["content"] if chunk["type"] == "delta"
+## Invoke an agent (streaming)
+
+```ruby
+client.invoke_agent_stream(
+  agent: "my-agent",
+  message: "What is the weather in London?",
+  thread_id: "session-abc123"  # optional — persist conversation history
+) do |chunk|
+  case chunk["type"]
+  when "delta"  then print chunk["content"]
+  when "tool_start" then puts "\nCalling tool: #{chunk['tool_name']}"
+  end
 end
 ```
 
+## Multimodal (image) inputs
+
+```ruby
+result = client.invoke_agent(
+  agent: "vision-agent",
+  message: "Describe this image",
+  image_urls: ["https://example.com/photo.jpg"]
+)
+puts result["response"]
+```
+
+## Authentication
+
+Pass the API key to the constructor or set the environment variable:
+
+```bash
+export FETCH_HIVE_API_KEY=fhk_...
+```
+
+```ruby
+client = FetchHive::Client.new  # picks up FETCH_HIVE_API_KEY automatically
+```
+
 ## Configuration
 
 | Option | Default | Description |
@@ -62,3 +135,11 @@ end
 - [Fetch Hive dashboard](https://app.fetchhive.com)
 - [API documentation](https://docs.fetchhive.com)
 - [GitHub](https://github.com/Fetch-Hive/ruby-sdk)
+
+## Version
+
+0.2.3
+
+## License
+
+MIT — see [LICENSE](LICENSE).

data/lib/fetch_hive/generated/api/agents_api.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/api/prompts_api.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/api/workflows_api.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/api_client.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/api_error.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/api_model_base.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/configuration.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/models/agent_message.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/models/async_config.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/models/error_response.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/models/invoke_agent_request.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/models/invoke_agent_response.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/models/invoke_prompt_request.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/models/invoke_prompt_response.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/models/invoke_workflow_async_response.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/models/invoke_workflow_request.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/models/invoke_workflow_response.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/models/sse_chunk.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/models/token_usage.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/models/tool_invocation.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

data/lib/fetch_hive/generated/version.rb

@@ -3,7 +3,7 @@
 
 #The Fetch Hive public API lets you invoke prompts, workflows, and agents programmatically using an API token.  ## Authentication All requests require a Bearer token in the `Authorization` header: ``` Authorization: Bearer <your-api-token> ```  ## Streaming Pass `\"streaming\": true` in the request body to receive a `text/event-stream` response. Each event is a JSON object sent as `data: <json>\\n\\n`. The stream ends with `data: [DONE]\\n\\n`. 
 
-The version of the OpenAPI document: 0.2.2
+The version of the OpenAPI document: 0.2.3
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.22.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fetch_hive
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Fetch Hive