Model HQ
DocumentationSDK Reference — Model HQ Client SDK
A quick-reference for the most commonly used SDK methods, grouped by category. For full parameter details see the API Reference.
Prerequisites
This guide assumes the SDK is installed and importable. If you haven't set that up yet, follow the Hello World prerequisites first.
Client setup
from modelhq.client import LLMWareClient, get_url_string
# Auto-detect endpoint
client = LLMWareClient(api_endpoint=get_url_string())
# Or specify directly
client = LLMWareClient(api_endpoint="http://localhost:8088", api_key="")---
Inference
| Method | Description |
|---|---|
client.inference(prompt, model_name) | Complete response |
client.stream(prompt, model_name) | Streaming generator |
client.inference_json(prompt, model_name) | Response formatted as JSON |
Method
client.inference(prompt, model_name)
Description
Complete response
Method
client.stream(prompt, model_name)
Description
Streaming generator
Method
client.inference_json(prompt, model_name)
Description
Response formatted as JSON
---
Vision & media
| Method | Description |
|---|---|
client.vision(image_fp, prompt) | Analyse an image |
client.vision_stream(image_fp, prompt) | Stream image analysis |
client.generate_image(prompt) | Generate an image |
client.generate_speech(prompt) | Generate speech audio |
Method
client.vision(image_fp, prompt)
Description
Analyse an image
Method
client.vision_stream(image_fp, prompt)
Description
Stream image analysis
Method
client.generate_image(prompt)
Description
Generate an image
Method
client.generate_speech(prompt)
Description
Generate speech audio
---
Model management
| Method | Description |
|---|---|
client.list_all_models() | List all available models |
client.model_lookup(model_name) | Get model card info |
client.model_load(model_name) | Load a model into memory |
client.model_unload(model_name) | Unload a model from memory |
Method
client.list_all_models()
Description
List all available models
Method
client.model_lookup(model_name)
Description
Get model card info
Method
client.model_load(model_name)
Description
Load a model into memory
Method
client.model_unload(model_name)
Description
Unload a model from memory
---
RAG — document inference
| Method | Description |
|---|---|
client.document_inference(doc_path, question) | Single-document Q&A |
client.document_batch_analysis(folder, questions) | Multi-document batch Q&A |
Method
client.document_inference(doc_path, question)
Description
Single-document Q&A
Method
client.document_batch_analysis(folder, questions)
Description
Multi-document batch Q&A
---
RAG — source inference
| Method | Description |
|---|---|
client.build_source(files, source_name) | Build a reusable source |
client.build_source_context(question, uploaded_source) | Build context only |
client.source_inference(source_path, question) | Query a source |
client.source_stream_inference(source_path, question) | Stream query a source |
Method
client.build_source(files, source_name)
Description
Build a reusable source
Method
client.build_source_context(question, uploaded_source)
Description
Build context only
Method
client.source_inference(source_path, question)
Description
Query a source
Method
client.source_stream_inference(source_path, question)
Description
Stream query a source
---
RAG — library inference
| Method | Description |
|---|---|
client.create_new_library(library_name) | Create a library |
client.add_files(library_name, folder) | Add files to a library |
client.add_files(library_name, folder, use_async=True) | Add files asynchronously |
client.install_embedding(library_name, model_name=...) | Install embeddings |
client.install_embedding(library_name, ..., use_async=True) | Install embeddings asynchronously |
client.query(library_name, user_query) | Text query |
client.semantic_query(library_name, query) | Semantic search |
client.library_inference(library_name, question) | RAG inference with ranking |
client.library_stream_inference(library_name, question) | Streaming RAG inference |
client.get_library_card(library_name=...) | Library metadata |
client.get_document_list(library_name=...) | List documents |
client.get_document_text(library_name=..., doc_id=...) | Extract document text |
Method
client.create_new_library(library_name)
Description
Create a library
Method
client.add_files(library_name, folder)
Description
Add files to a library
Method
client.add_files(library_name, folder, use_async=True)
Description
Add files asynchronously
Method
client.install_embedding(library_name, model_name=...)
Description
Install embeddings
Method
client.install_embedding(library_name, ..., use_async=True)
Description
Install embeddings asynchronously
Method
client.query(library_name, user_query)
Description
Text query
Method
client.semantic_query(library_name, query)
Description
Semantic search
Method
client.library_inference(library_name, question)
Description
RAG inference with ranking
Method
client.library_stream_inference(library_name, question)
Description
Streaming RAG inference
Method
client.get_library_card(library_name=...)
Description
Library metadata
Method
client.get_document_list(library_name=...)
Description
List documents
Method
client.get_document_text(library_name=..., doc_id=...)
Description
Extract document text
---
Agents
| Method | Description |
|---|---|
client.get_all_agents() | List available agents |
client.get_agent_signature(process_name) | Get agent input/output spec |
client.get_agent_description(process_name) | Get human-readable description |
client.run_agent(agent_name, agent_inputs) | Execute an agent |
client.run_agent_generator(agent_name, agent_inputs) | Stream agent execution |
client.call_agent(agent_name, agent_inputs) | Call a deployed agent endpoint |
client.agent_output(id=...) | Retrieve agent output |
client.get_agent_output_json(id=...) | Retrieve agent JSON output |
client.get_agent_output_files(id=...) | Download agent file outputs |
client.download_agent(process_name) | Download agent zip from server |
client.install_agent_zip(zip_path) | Install agent from zip |
client.get_agent_execution_log_list(agent_name=...) | View execution logs |
client.get_all_scheduled_agents() | List scheduled agents |
client.set_new_agent_schedule(agent_name, frequency) | Schedule an agent |
Method
client.get_all_agents()
Description
List available agents
Method
client.get_agent_signature(process_name)
Description
Get agent input/output spec
Method
client.get_agent_description(process_name)
Description
Get human-readable description
Method
client.run_agent(agent_name, agent_inputs)
Description
Execute an agent
Method
client.run_agent_generator(agent_name, agent_inputs)
Description
Stream agent execution
Method
client.call_agent(agent_name, agent_inputs)
Description
Call a deployed agent endpoint
Method
client.agent_output(id=...)
Description
Retrieve agent output
Method
client.get_agent_output_json(id=...)
Description
Retrieve agent JSON output
Method
client.get_agent_output_files(id=...)
Description
Download agent file outputs
Method
client.download_agent(process_name)
Description
Download agent zip from server
Method
client.install_agent_zip(zip_path)
Description
Install agent from zip
Method
client.get_agent_execution_log_list(agent_name=...)
Description
View execution logs
Method
client.get_all_scheduled_agents()
Description
List scheduled agents
Method
client.set_new_agent_schedule(agent_name, frequency)
Description
Schedule an agent
---
HQ Apps (chat)
| Method | Description |
|---|---|
client.start_app_session(app_name) | Start a session |
client.chat(session_id, prompt) | Send a message (streaming) |
client.run_app_agent(session_id, agent_name) | Run an agent inside a session |
client.get_app_state(session_id) | Check session state |
client.update_app_state(session_id, updates) | Update session config |
client.get_app_transcript(session_id) | Export session transcript |
client.stop_app_session(session_id) | End a session |
client.get_all_apps() | List all apps |
client.lookup_app(app_name) | Get app details |
client.get_active_app_sessions() | List active sessions |
Method
client.start_app_session(app_name)
Description
Start a session
Method
client.chat(session_id, prompt)
Description
Send a message (streaming)
Method
client.run_app_agent(session_id, agent_name)
Description
Run an agent inside a session
Method
client.get_app_state(session_id)
Description
Check session state
Method
client.update_app_state(session_id, updates)
Description
Update session config
Method
client.get_app_transcript(session_id)
Description
Export session transcript
Method
client.stop_app_session(session_id)
Description
End a session
Method
client.get_all_apps()
Description
List all apps
Method
client.lookup_app(app_name)
Description
Get app details
Method
client.get_active_app_sessions()
Description
List active sessions
---
Services & integrations
| Method | Description |
|---|---|
client.install_service(service_name, service_dfn) | Install a service |
client.list_services() | List services |
client.test_service(service_name) | Test a service |
client.list_integrations() | List integrations |
client.get_integration_info(integration_name) | Get integration details |
client.web_search(query, engine) | Web search |
client.add_credential(creds) | Store API credentials |
client.delete_credential(credential_name=...) | Remove a credential |
Method
client.install_service(service_name, service_dfn)
Description
Install a service
Method
client.list_services()
Description
List services
Method
client.test_service(service_name)
Description
Test a service
Method
client.list_integrations()
Description
List integrations
Method
client.get_integration_info(integration_name)
Description
Get integration details
Method
client.web_search(query, engine)
Description
Web search
Method
client.add_credential(creds)
Description
Store API credentials
Method
client.delete_credential(credential_name=...)
Description
Remove a credential
---
Administration
| Method | Description |
|---|---|
client.ping() | Health check |
client.system_info() | Server system info |
client.get_api_catalog() | List all API endpoints |
client.get_db_info() | Database info |
client.app_register() | Register an app |
client.register_new_user(...) | Register a new user |
client.get_transaction_log() | View transaction log |
client.server_stop() | Stop the server |
Method
client.ping()
Description
Health check
Method
client.system_info()
Description
Server system info
Method
client.get_api_catalog()
Description
List all API endpoints
Method
client.get_db_info()
Description
Database info
Method
client.app_register()
Description
Register an app
Method
client.register_new_user(...)
Description
Register a new user
Method
client.get_transaction_log()
Description
View transaction log
Method
client.server_stop()
Description
Stop the server
---
For complete endpoint details, parameters, and example responses, see the API Reference.
For further assistance or to share feedback, please contact us at support@aibloks.com