Official Python SDK for the Fetch Hive API
Project description
fetch-hive-sdk
Official Python SDK for Fetch Hive — invoke AI prompts, workflows, and agents from your application.
Installation
pip install fetch-hive-sdk
Quick start
from fetch_hive_sdk import FetchHive
client = FetchHive(api_key="fhk_...")
# or: client = FetchHive() # reads FETCH_HIVE_API_KEY env var
Get your API key from the Fetch Hive dashboard.
Invoke a prompt
result = client.invoke_prompt(
deployment="my-prompt",
inputs={"name": "Alice", "topic": "machine learning"},
metadata={},
)
print(result["response"])
Invoke a prompt (streaming)
for chunk in client.invoke_prompt_stream(
deployment="my-prompt",
inputs={"name": "Alice"},
):
if chunk.get("type") == "response":
print(chunk.get("response", ""), end="", flush=True)
elif chunk.get("type") == "usage":
print("\nUsage:", chunk["usage"])
Invoke a workflow
run = client.invoke_workflow(
deployment="my-workflow",
inputs={"customer_id": "42"},
metadata={},
)
print(run["status"], run.get("output"))
Invoke a workflow (async)
run = client.invoke_workflow(
deployment="my-workflow",
inputs={"customer_id": "42"},
async_mode=True,
callback_url="https://example.com/webhook",
)
print("Queued:", run["run_id"])
Invoke an agent
reply = client.invoke_agent(
agent="my-agent",
message="What is the weather in London?",
metadata={},
)
print(reply["response"])
Metadata
Pass optional metadata on prompt, workflow, or agent invokes to attach flat audit fields for log display and filtering. Metadata values must be strings, numbers, booleans, or None.
Invoke an agent (streaming)
for chunk in client.invoke_agent_stream(
agent="my-agent",
message="What is the weather in London?",
thread_id="session-abc123", # optional — persist conversation history
):
if chunk.get("type") == "response":
print(chunk.get("response", ""), end="", flush=True)
elif chunk.get("type") == "tool":
print(f"\n[Calling tool: {chunk.get('tool')}]")
elif chunk.get("type") == "usage":
print("\nUsage:", chunk["usage"])
Multimodal (image) inputs
result = client.invoke_agent(
agent="vision-agent",
message="Describe this image",
image_urls=["https://example.com/photo.jpg"],
)
print(result["response"])
Async streaming
import asyncio
async def main():
async for chunk in client.ainvoke_agent_stream(
agent="my-agent",
message="Hello",
thread_id="session-abc123",
):
if chunk.get("type") == "response":
print(chunk.get("response", ""), end="", flush=True)
elif chunk.get("type") == "tool":
print(f"\n[Calling tool: {chunk.get('tool')}]")
elif chunk.get("type") == "usage":
print("\nUsage:", chunk["usage"])
asyncio.run(main())
Authentication
Pass the API key to the constructor or set the environment variable:
export FETCH_HIVE_API_KEY=fhk_...
client = FetchHive() # picks up FETCH_HIVE_API_KEY automatically
Configuration
| Option | Default | Description |
|---|---|---|
api_key |
FETCH_HIVE_API_KEY env var |
Bearer token from the Fetch Hive dashboard |
base_url |
https://api.fetchhive.com/v1 |
Override the API base URL |
timeout |
120 |
Request timeout in seconds |
Links
Version
0.2.6
License
MIT — see LICENSE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fetch_hive_sdk-0.2.6.tar.gz.
File metadata
- Download URL: fetch_hive_sdk-0.2.6.tar.gz
- Upload date:
- Size: 43.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9d0d5c170e6256d84f19e59d45f21fcf075022fcf9fa34d04c4b16bdeb106d05
|
|
| MD5 |
911b7d20b7cdb66a623ea20f6548bca0
|
|
| BLAKE2b-256 |
b47f261f5b9b7746439bfc7846e0c7b80593ffd21248365e6d1f73a7a40957f2
|
File details
Details for the file fetch_hive_sdk-0.2.6-py3-none-any.whl.
File metadata
- Download URL: fetch_hive_sdk-0.2.6-py3-none-any.whl
- Upload date:
- Size: 5.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2a34c6cb7350d07ad0878b1cec0dcb3367d925ac5bdfd18f9cafc80607fbf914
|
|
| MD5 |
e014afd2e068bd7851bd45249134c59d
|
|
| BLAKE2b-256 |
34f589a377abebb645273a9380ab5c1f237629f5fef8fdd34f22ee5d4b7214d3
|