# briefcasebrain-sdk
Official API for BriefcaseBrain Legal AI Platform
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.14.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://briefcasebrain.io](https://briefcasebrain.io)
## Requirements.
Python 3.9+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import briefcasebrain_sdk
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import briefcasebrain_sdk
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import briefcasebrain_sdk
from briefcasebrain_sdk.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.briefcasebrain.io
# See configuration.py for a list of all supported configuration parameters.
configuration = briefcasebrain_sdk.Configuration(
host = "https://api.briefcasebrain.io"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): bearerAuth
configuration = briefcasebrain_sdk.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Configure API key authorization: sessionAuth
configuration.api_key['sessionAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['sessionAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with briefcasebrain_sdk.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = briefcasebrain_sdk.ContractsApi(api_client)
limit = 10 # int | Maximum number of items to return (optional) (default to 10)
offset = 0 # int | Number of items to skip (optional) (default to 0)
try:
# List contract templates
api_response = api_instance.api_contracts_templates_get(limit=limit, offset=offset)
print("The response of ContractsApi->api_contracts_templates_get:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ContractsApi->api_contracts_templates_get: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.briefcasebrain.io*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ContractsApi* | [**api_contracts_templates_get**](docs/ContractsApi.md#api_contracts_templates_get) | **GET** /api/contracts/templates | List contract templates
*ContractsApi* | [**api_contracts_templates_post**](docs/ContractsApi.md#api_contracts_templates_post) | **POST** /api/contracts/templates | Create contract template
*LegalResearchApi* | [**api_legal_research_post**](docs/LegalResearchApi.md#api_legal_research_post) | **POST** /api/legal-research | Perform legal research
*QueriesApi* | [**api_queries_get**](docs/QueriesApi.md#api_queries_get) | **GET** /api/queries | Get saved queries
*QueriesApi* | [**api_queries_post**](docs/QueriesApi.md#api_queries_post) | **POST** /api/queries | Save a query
*QueryEnhancementApi* | [**api_enhance_query_post**](docs/QueryEnhancementApi.md#api_enhance_query_post) | **POST** /api/enhance-query | Enhance a legal query
*UserApi* | [**api_user_credits_get**](docs/UserApi.md#api_user_credits_get) | **GET** /api/user/credits | Get user credits
*UserApi* | [**api_user_profile_get**](docs/UserApi.md#api_user_profile_get) | **GET** /api/user/profile | Get user profile
*WorkflowsApi* | [**api_workflows_get**](docs/WorkflowsApi.md#api_workflows_get) | **GET** /api/workflows | List workflows
*WorkflowsApi* | [**api_workflows_post**](docs/WorkflowsApi.md#api_workflows_post) | **POST** /api/workflows | Create workflow
## Documentation For Models
- [ApiContractsTemplatesPost201Response](docs/ApiContractsTemplatesPost201Response.md)
- [ApiContractsTemplatesPostRequest](docs/ApiContractsTemplatesPostRequest.md)
- [ApiQueriesGet200Response](docs/ApiQueriesGet200Response.md)
- [ApiQueriesGet200ResponsePagination](docs/ApiQueriesGet200ResponsePagination.md)
- [ApiQueriesGet200ResponseQueriesInner](docs/ApiQueriesGet200ResponseQueriesInner.md)
- [ApiQueriesPost201Response](docs/ApiQueriesPost201Response.md)
- [ApiQueriesPostRequest](docs/ApiQueriesPostRequest.md)
- [ApiUserCreditsGet200Response](docs/ApiUserCreditsGet200Response.md)
- [ApiWorkflowsGet200Response](docs/ApiWorkflowsGet200Response.md)
- [ApiWorkflowsPost201Response](docs/ApiWorkflowsPost201Response.md)
- [ApiWorkflowsPostRequest](docs/ApiWorkflowsPostRequest.md)
- [ApiWorkflowsPostRequestStepsInner](docs/ApiWorkflowsPostRequestStepsInner.md)
- [ContractTemplate](docs/ContractTemplate.md)
- [EnhanceQueryRequest](docs/EnhanceQueryRequest.md)
- [EnhanceQueryResponse](docs/EnhanceQueryResponse.md)
- [EnhanceQueryResponseEnhancedQueriesInner](docs/EnhanceQueryResponseEnhancedQueriesInner.md)
- [Error](docs/Error.md)
- [LegalResearchRequest](docs/LegalResearchRequest.md)
- [LegalResearchRequestConversationHistoryInner](docs/LegalResearchRequestConversationHistoryInner.md)
- [LegalResearchResponse](docs/LegalResearchResponse.md)
- [LegalResearchResponseRelevantCasesInner](docs/LegalResearchResponseRelevantCasesInner.md)
- [LegalResearchResponseRelevantStatutesInner](docs/LegalResearchResponseRelevantStatutesInner.md)
- [Success](docs/Success.md)
- [User](docs/User.md)
- [Workflow](docs/Workflow.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth
- **Type**: Bearer authentication (JWT)
<a id="sessionAuth"></a>
### sessionAuth
- **Type**: API key
- **API key parameter name**: authjs.session-token
- **Location**:
## Author
support@briefcasebrain.io
Raw data
{
"_id": null,
"home_page": "https://github.com/briefcasebrain/sdk",
"name": "briefcasebrain-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "legal, ai, legal-research, contracts, briefcasebrain, sdk, api",
"author": "BriefcaseBrain Support",
"author_email": "BriefcaseBrain Support <support@briefcasebrain.io>",
"download_url": "https://files.pythonhosted.org/packages/26/38/d3318a74e502ddf149b197ae1f5a0f6f8ca47d06f9b288c76b8b5d912e27/briefcasebrain_sdk-1.0.0.tar.gz",
"platform": null,
"description": "# briefcasebrain-sdk\nOfficial API for BriefcaseBrain Legal AI Platform\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 1.0.0\n- Generator version: 7.14.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\nFor more information, please visit [https://briefcasebrain.io](https://briefcasebrain.io)\n\n## Requirements.\n\nPython 3.9+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport briefcasebrain_sdk\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport briefcasebrain_sdk\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport briefcasebrain_sdk\nfrom briefcasebrain_sdk.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://api.briefcasebrain.io\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = briefcasebrain_sdk.Configuration(\n host = \"https://api.briefcasebrain.io\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure Bearer authorization (JWT): bearerAuth\nconfiguration = briefcasebrain_sdk.Configuration(\n access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n# Configure API key authorization: sessionAuth\nconfiguration.api_key['sessionAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['sessionAuth'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nwith briefcasebrain_sdk.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = briefcasebrain_sdk.ContractsApi(api_client)\n limit = 10 # int | Maximum number of items to return (optional) (default to 10)\n offset = 0 # int | Number of items to skip (optional) (default to 0)\n\n try:\n # List contract templates\n api_response = api_instance.api_contracts_templates_get(limit=limit, offset=offset)\n print(\"The response of ContractsApi->api_contracts_templates_get:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling ContractsApi->api_contracts_templates_get: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.briefcasebrain.io*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ContractsApi* | [**api_contracts_templates_get**](docs/ContractsApi.md#api_contracts_templates_get) | **GET** /api/contracts/templates | List contract templates\n*ContractsApi* | [**api_contracts_templates_post**](docs/ContractsApi.md#api_contracts_templates_post) | **POST** /api/contracts/templates | Create contract template\n*LegalResearchApi* | [**api_legal_research_post**](docs/LegalResearchApi.md#api_legal_research_post) | **POST** /api/legal-research | Perform legal research\n*QueriesApi* | [**api_queries_get**](docs/QueriesApi.md#api_queries_get) | **GET** /api/queries | Get saved queries\n*QueriesApi* | [**api_queries_post**](docs/QueriesApi.md#api_queries_post) | **POST** /api/queries | Save a query\n*QueryEnhancementApi* | [**api_enhance_query_post**](docs/QueryEnhancementApi.md#api_enhance_query_post) | **POST** /api/enhance-query | Enhance a legal query\n*UserApi* | [**api_user_credits_get**](docs/UserApi.md#api_user_credits_get) | **GET** /api/user/credits | Get user credits\n*UserApi* | [**api_user_profile_get**](docs/UserApi.md#api_user_profile_get) | **GET** /api/user/profile | Get user profile\n*WorkflowsApi* | [**api_workflows_get**](docs/WorkflowsApi.md#api_workflows_get) | **GET** /api/workflows | List workflows\n*WorkflowsApi* | [**api_workflows_post**](docs/WorkflowsApi.md#api_workflows_post) | **POST** /api/workflows | Create workflow\n\n\n## Documentation For Models\n\n - [ApiContractsTemplatesPost201Response](docs/ApiContractsTemplatesPost201Response.md)\n - [ApiContractsTemplatesPostRequest](docs/ApiContractsTemplatesPostRequest.md)\n - [ApiQueriesGet200Response](docs/ApiQueriesGet200Response.md)\n - [ApiQueriesGet200ResponsePagination](docs/ApiQueriesGet200ResponsePagination.md)\n - [ApiQueriesGet200ResponseQueriesInner](docs/ApiQueriesGet200ResponseQueriesInner.md)\n - [ApiQueriesPost201Response](docs/ApiQueriesPost201Response.md)\n - [ApiQueriesPostRequest](docs/ApiQueriesPostRequest.md)\n - [ApiUserCreditsGet200Response](docs/ApiUserCreditsGet200Response.md)\n - [ApiWorkflowsGet200Response](docs/ApiWorkflowsGet200Response.md)\n - [ApiWorkflowsPost201Response](docs/ApiWorkflowsPost201Response.md)\n - [ApiWorkflowsPostRequest](docs/ApiWorkflowsPostRequest.md)\n - [ApiWorkflowsPostRequestStepsInner](docs/ApiWorkflowsPostRequestStepsInner.md)\n - [ContractTemplate](docs/ContractTemplate.md)\n - [EnhanceQueryRequest](docs/EnhanceQueryRequest.md)\n - [EnhanceQueryResponse](docs/EnhanceQueryResponse.md)\n - [EnhanceQueryResponseEnhancedQueriesInner](docs/EnhanceQueryResponseEnhancedQueriesInner.md)\n - [Error](docs/Error.md)\n - [LegalResearchRequest](docs/LegalResearchRequest.md)\n - [LegalResearchRequestConversationHistoryInner](docs/LegalResearchRequestConversationHistoryInner.md)\n - [LegalResearchResponse](docs/LegalResearchResponse.md)\n - [LegalResearchResponseRelevantCasesInner](docs/LegalResearchResponseRelevantCasesInner.md)\n - [LegalResearchResponseRelevantStatutesInner](docs/LegalResearchResponseRelevantStatutesInner.md)\n - [Success](docs/Success.md)\n - [User](docs/User.md)\n - [Workflow](docs/Workflow.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"bearerAuth\"></a>\n### bearerAuth\n\n- **Type**: Bearer authentication (JWT)\n\n<a id=\"sessionAuth\"></a>\n### sessionAuth\n\n- **Type**: API key\n- **API key parameter name**: authjs.session-token\n- **Location**: \n\n\n## Author\n\nsupport@briefcasebrain.io\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Official Python SDK for BriefcaseBrain Legal AI Platform",
"version": "1.0.0",
"project_urls": {
"Bug Reports": "https://github.com/briefcasebrain/sdk/issues",
"Changelog": "https://github.com/briefcasebrain/sdk/blob/main/packages/python-sdk/CHANGELOG.md",
"Documentation": "https://docs.briefcasebrain.io",
"Homepage": "https://briefcasebrain.io",
"Repository": "https://github.com/briefcasebrain/sdk"
},
"split_keywords": [
"legal",
" ai",
" legal-research",
" contracts",
" briefcasebrain",
" sdk",
" api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "514694e8c1848e38f6ce7d65ab0ed7d1a97609bc60f69b234b77fe806fdde2dc",
"md5": "b45c14d69adc7bdc203c44c1a2b17d15",
"sha256": "c4264e47d335043b78cadb1976c48777ce36e9927af69c8c0be9cb5380bbf023"
},
"downloads": -1,
"filename": "briefcasebrain_sdk-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b45c14d69adc7bdc203c44c1a2b17d15",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 71061,
"upload_time": "2025-08-23T22:21:25",
"upload_time_iso_8601": "2025-08-23T22:21:25.421807Z",
"url": "https://files.pythonhosted.org/packages/51/46/94e8c1848e38f6ce7d65ab0ed7d1a97609bc60f69b234b77fe806fdde2dc/briefcasebrain_sdk-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "2638d3318a74e502ddf149b197ae1f5a0f6f8ca47d06f9b288c76b8b5d912e27",
"md5": "4ed541839fe8e3bcef1d141b9661d1b8",
"sha256": "8a39b16b419945de70ac2cffc2bb00619d852abe08477aaafdafbad84eed1b26"
},
"downloads": -1,
"filename": "briefcasebrain_sdk-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4ed541839fe8e3bcef1d141b9661d1b8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 37738,
"upload_time": "2025-08-23T22:21:26",
"upload_time_iso_8601": "2025-08-23T22:21:26.812064Z",
"url": "https://files.pythonhosted.org/packages/26/38/d3318a74e502ddf149b197ae1f5a0f6f8ca47d06f9b288c76b8b5d912e27/briefcasebrain_sdk-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-23 22:21:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "briefcasebrain",
"github_project": "sdk",
"github_not_found": true,
"lcname": "briefcasebrain-sdk"
}
JSON
