# iblai
API for [ibl.ai](https://ibl.ai/) — a generative AI backend as a service for educators.
## Requirements
Python 3.7+
## Installation & Usage
### pip install
To install the API client library, simply execute:
```sh
pip install iblai
```
Then import the package:
```python
import iblai
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
### Adding LLM credentials
```python
from iblai.helpers import add_llm_credential
base_url = "https://base.manager.iblai.app/"
api_token = "<MY_ACCESS_TOKEN>"
credential_name = "openai"
credential_value = "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
tenant = "new-platform"
add_llm_credential(credential_name, credential_value, tenant, api_token, base_url)
```
### Chatting with a mentor
```python
from iblai.helpers import (
create_mentor,
upload_document_to_mentor,
wait_for_document_training_to_complete,
create_chat_session,
chat_with_mentor_async
)
tenant = "new-platform"
username = "my-user"
base_url = "https://base.manager.iblai.app/"
asgi_base_url = "wss://asgi.data.iblai.app"
api_token = "<MY_ACCESS_TOKEN>"
mentor_name = "My New Mentor"
mentor_settings = {
"new_mentor_name": mentor_name,
"display_name": mentor_name,
}
mentor_data = await create_mentor(tenant, username, mentor_settings, api_token, base_url)
await upload_document_to_mentor(
mentor_name=mentor_name,
file_path="doc.pdf",
tenant, username, api_token, base_url
)
await wait_for_document_training_to_complete(mentor_name, tenant, username, api_token, base_url)
session_id = await create_chat_session(mentor_name, tenant, username, base_url)
await chat_with_mentor_async(
prompt, session_id, mentor_name, tenant, username, api_token, asgi_base_url
)
```
### Inviting a user
```python
from iblai.helpers import invite_user_to_platform
base_url = "https://base.manager.iblai.app/"
api_token = "<MY_ACCESS_TOKEN>"
tenant = "new-platform"
email = "new-student@example.com"
invite_user_to_platform(tenant, email, api_token, base_url)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/iblai/iblai-python-sdk",
"name": "iblai",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "OpenAPI Generator community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/20/19/79c16e8d76d0f4f8798e8dacd1133ea600a39967e4007516490d4b9426f8/iblai-3.66.0.tar.gz",
"platform": null,
"description": "# iblai\n\nAPI for [ibl.ai](https://ibl.ai/) \u2014 a generative AI backend as a service for educators.\n\n\n## Requirements\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nTo install the API client library, simply execute:\n\n```sh\npip install iblai\n```\n\nThen import the package:\n```python\nimport iblai\n```\n\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n### Adding LLM credentials\n\n```python\nfrom iblai.helpers import add_llm_credential\n\nbase_url = \"https://base.manager.iblai.app/\"\napi_token = \"<MY_ACCESS_TOKEN>\"\n\ncredential_name = \"openai\"\ncredential_value = \"sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\ntenant = \"new-platform\"\n\nadd_llm_credential(credential_name, credential_value, tenant, api_token, base_url)\n```\n\n### Chatting with a mentor\n\n```python\nfrom iblai.helpers import (\n create_mentor,\n upload_document_to_mentor,\n wait_for_document_training_to_complete,\n create_chat_session,\n chat_with_mentor_async\n)\n\ntenant = \"new-platform\"\nusername = \"my-user\"\nbase_url = \"https://base.manager.iblai.app/\"\nasgi_base_url = \"wss://asgi.data.iblai.app\"\napi_token = \"<MY_ACCESS_TOKEN>\"\n\nmentor_name = \"My New Mentor\"\nmentor_settings = {\n \"new_mentor_name\": mentor_name,\n \"display_name\": mentor_name,\n}\n\nmentor_data = await create_mentor(tenant, username, mentor_settings, api_token, base_url)\nawait upload_document_to_mentor(\n mentor_name=mentor_name,\n file_path=\"doc.pdf\",\n tenant, username, api_token, base_url\n)\n\nawait wait_for_document_training_to_complete(mentor_name, tenant, username, api_token, base_url)\n\nsession_id = await create_chat_session(mentor_name, tenant, username, base_url)\nawait chat_with_mentor_async(\n prompt, session_id, mentor_name, tenant, username, api_token, asgi_base_url\n)\n```\n\n\n### Inviting a user\n\n\n```python\nfrom iblai.helpers import invite_user_to_platform\n\nbase_url = \"https://base.manager.iblai.app/\"\napi_token = \"<MY_ACCESS_TOKEN>\"\n\ntenant = \"new-platform\"\nemail = \"new-student@example.com\"\n\ninvite_user_to_platform(tenant, email, api_token, base_url)\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "API for ibl.ai \u2014 generative AI backend as a service for educators.",
"version": "3.66.0",
"project_urls": {
"Homepage": "https://github.com/iblai/iblai-python-sdk"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "47b7773f76b3b6d3195b9eae58b50b9d9f352f966814d72cc70d0bcd6f3f2ed8",
"md5": "f4c838c572bff4337ea97dac8fd8617e",
"sha256": "1576eaee4a31426c719c3a426f5a253a5721763ee92cc65aafa25867aec47502"
},
"downloads": -1,
"filename": "iblai-3.66.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f4c838c572bff4337ea97dac8fd8617e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 1433868,
"upload_time": "2025-07-11T09:37:17",
"upload_time_iso_8601": "2025-07-11T09:37:17.280508Z",
"url": "https://files.pythonhosted.org/packages/47/b7/773f76b3b6d3195b9eae58b50b9d9f352f966814d72cc70d0bcd6f3f2ed8/iblai-3.66.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "201979c16e8d76d0f4f8798e8dacd1133ea600a39967e4007516490d4b9426f8",
"md5": "a22089cee61e5e93a4b92d0817d85d8e",
"sha256": "fbb6d24edc15b5d625e0f889e4a7ca48291cd130bd4b48de7dcdd2c419124d2e"
},
"downloads": -1,
"filename": "iblai-3.66.0.tar.gz",
"has_sig": false,
"md5_digest": "a22089cee61e5e93a4b92d0817d85d8e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 644976,
"upload_time": "2025-07-11T09:37:18",
"upload_time_iso_8601": "2025-07-11T09:37:18.642134Z",
"url": "https://files.pythonhosted.org/packages/20/19/79c16e8d76d0f4f8798e8dacd1133ea600a39967e4007516490d4b9426f8/iblai-3.66.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-11 09:37:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "iblai",
"github_project": "iblai-python-sdk",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "python_dateutil",
"specs": [
[
">=",
"2.5.3"
]
]
},
{
"name": "setuptools",
"specs": [
[
">=",
"21.0.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
">=",
"1.25.3"
],
[
"<",
"2.1.0"
]
]
},
{
"name": "pydantic",
"specs": [
[
">=",
"2"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
">=",
"4.7.1"
]
]
}
],
"tox": true,
"lcname": "iblai"
}