Run with Ruby SDK

Use the official fetch_hive gem when you want to start a Hive Agent run from Ruby. The SDK wraps the public POST /v1/hive-agent/invoke endpoint with an idiomatic helper and handles authentication. Hive Agent invocation does not stream and does not wait for the final answer in the HTTP response. The SDK returns identifiers immediately, then Fetch Hive sends a signed callback when the run completes, fails, or is cancelled.

Installation

Add to your Gemfile:

gem "fetch_hive"

Then run:

bundle install

Or install directly:

gem install fetch_hive

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):

export FETCH_HIVE_API_KEY=fhk_...

require "fetch_hive"

client = FetchHive::Client.new

Or pass the key explicitly:

client = FetchHive::Client.new(api_key: "fhk_...")

See API Keys for how to create and rotate keys.

Basic example

Start a Hive Agent run and read the accepted response:

require "fetch_hive"

client = FetchHive::Client.new

result = client.invoke_hive_agent(
  hive_agent: "YOUR_HIVE_AGENT_ID",
  objective: "Research competitors and summarize verified findings",
  callback_url: "https://example.com/hive-agent-callback",
  sources: { website_urls: ["https://example.com"] },
  metadata: { customer_id: "cus_123" }
)

puts result["run_id"]
puts result["request_id"]
puts result["webhook_secret"]

invoke_hive_agent returns the parsed JSON body as a hash as soon as the run is queued. See the accepted response shape.

Method reference

Keyword	Type	Required	Description
`hive_agent`	`String`	Yes	The Hive Agent ID from the dashboard
`objective`	`String`	Yes	Specific objective for the planner to create work nodes from
`callback_url`	`String`	Yes	HTTPS URL that receives the signed terminal callback
`sources`	`Hash`	No	Grounded context from websites, assets, or knowledge bases in the workspace
`metadata`	`Hash`	No	Flat caller-defined metadata for audit and log filtering. See Invoke metadata

The SDK always sends async.enabled: true with your callback_url. Hive Agent invocation is async-only.

Handling the response

Fetch Hive returns 202 Accepted when the run is queued. Store webhook_secret so your callback receiver can verify X-Fetch-Hive-Signature.

result = client.invoke_hive_agent(
  hive_agent: "YOUR_HIVE_AGENT_ID",
  objective: "Research competitors and summarize verified findings",
  callback_url: "https://example.com/hive-agent-callback"
)

puts result["run_id"]          # queued run identifier
puts result["request_id"]      # use this to look up the run in Logs
puts result["status"]          # usually "pending"
puts result["webhook_secret"]  # verify the signed callback

Open Logs to inspect status, trace, costs, node output, callback attempts, and the final response.

Configuration

Option	Default	Description
`api_key`	`ENV["FETCH_HIVE_API_KEY"]`	Bearer token from the dashboard
`base_url`	`https://api.fetchhive.com/v1`	Override the API base URL
`timeout`	`120`	Request timeout in seconds

client = FetchHive::Client.new(
  api_key: "fhk_...",
  base_url: "https://api.fetchhive.com/v1",
  timeout: 60
)

Errors

Missing callback_url raises ArgumentError before a request is sent. Non-2xx responses raise a RuntimeError with the status code and body:

begin
  result = client.invoke_hive_agent(
    hive_agent: "YOUR_HIVE_AGENT_ID",
    objective: "Research competitors and summarize verified findings",
    callback_url: "https://example.com/hive-agent-callback"
  )
rescue => e
  warn "Fetch Hive error: #{e.message}"
end

See Errors and Rate Limits for status code meanings.

Next steps

Invoke from Code - Overview of starting runs from your app
Run with Python SDK
Run with Node.js SDK
Run with PHP SDK
Invoke - Full endpoint reference

Getting Started

Live Chat

Prompts

Workflows

Hive Agents

Agents

Knowledge Bases

Experiments

Your Workspace

Monitoring

User Tracking

Resources

Installation

Authentication

Basic example

Method reference

Handling the response

Configuration

Errors

Links

Next steps

​Installation

​Authentication

​Basic example

​Method reference

​Handling the response

​Configuration

​Errors

​Links

​Next steps

Installation

Authentication

Basic example

Method reference

Handling the response

Configuration

Errors

Links

Next steps