workhub-client 1.0.0

Python API to use WorkHub API for conversational AI.

Workhub API Client

The Workhub API Client is a versatile Python package designed for interacting with the Workhub API. It simplifies tasks such as user authentication, company information retrieval, conversation management, and message handling within the Workhub platform.

Quick Start

To get started with the Workhub API Client, you'll need to initialize it with your API credentials:

from client import WorkhubClient

client = WorkhubClient()

By default, the client is configured with the standard API endpoints. If your endpoints differ, you can specify them when initializing the client:

client = WorkhubClient(auth_base_url='https://api-admin.workhub.ai', api_base_url='https://api-teamgpt.workhub.ai')

Authenticating

Authenticate using your Workhub credentials to begin making API calls:

client.login(email='[e-mail]', password='your_password')

Fetching Company Information

Retrieve your company's information and automatically set your active company UUID:

company_info = client.get_company_info()
print(company_info)

Managing Conversations

Fetch existing conversations, create new ones, or send messages:

• Fetch Conversations

  conversations = client.fetch_conversations()
  print(conversations)
  

• Create a New Conversation

  new_conversation = client.create_conversation(conversation_users=["user_uuid"], name="Team Meeting")
  print(new_conversation)
  

• Send a Message

  message_response = client.send_user_message(conversation_uuid="conversation_uuid", content="Hello, team!")
  print(message_response)
  

Polling for Bot Messages

You can poll for messages from a bot in a conversation, specifying a timeout as needed:

bot_message = client.poll_for_bot_message(conversation_uuid="conversation_uuid", bot_message_uuid="bot_message_uuid", user_message_uuid="user_message_uuid", timeout=30)
print(bot_message)

Error Handling

The client uses built-in exceptions for error handling. Make sure to handle these appropriately in your code to manage API call failures and other errors gracefully.

Contributing

Contributions to the Workhub API Client are welcome. Please feel free to submit pull requests or issues to improve the project.

License

This is released under MIT license.