{"id":28965895,"url":"https://github.com/devflowinc/trieve_python_client","last_synced_at":"2025-06-24T07:10:32.499Z","repository":{"id":218586805,"uuid":"746410414","full_name":"devflowinc/trieve_python_client","owner":"devflowinc","description":null,"archived":false,"fork":false,"pushed_at":"2024-01-22T19:19:58.000Z","size":233,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-22T05:17:06.863Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devflowinc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-21T23:22:09.000Z","updated_at":"2024-01-24T18:22:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"9fd609b1-159e-4fec-8130-7c7d29444710","html_url":"https://github.com/devflowinc/trieve_python_client","commit_stats":null,"previous_names":["qnlbnsl/trieve_python_client","devflowinc/trieve_python_client"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/devflowinc/trieve_python_client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve_python_client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve_python_client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve_python_client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve_python_client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devflowinc","download_url":"https://codeload.github.com/devflowinc/trieve_python_client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve_python_client/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261624969,"owners_count":23186121,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-24T07:10:31.881Z","updated_at":"2025-06-24T07:10:32.484Z","avatar_url":"https://github.com/devflowinc.png","language":"Python","readme":"# trieve-python-client\nTrieve REST API OpenAPI Documentation\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- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation \u0026 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 trieve_python_client\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 trieve_python_client\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 trieve_python_client\nfrom trieve_python_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = trieve_python_client.Configuration(\n    host = \"http://localhost\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith trieve_python_client.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = trieve_python_client.AuthApi(api_client)\n\n    try:\n        # openid_callback\n        api_response = api_instance.callback()\n        print(\"The response of AuthApi-\u003ecallback:\\n\")\n        pprint(api_response)\n    except ApiException as e:\n        print(\"Exception when calling AuthApi-\u003ecallback: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AuthApi* | [**callback**](docs/AuthApi.md#callback) | **GET** /api/auth/callback | openid_callback\n*AuthApi* | [**get_me**](docs/AuthApi.md#get_me) | **GET** /api/auth/me | get_me\n*AuthApi* | [**login**](docs/AuthApi.md#login) | **GET** /api/auth | login\n*AuthApi* | [**logout**](docs/AuthApi.md#logout) | **DELETE** /api/auth | logout\n*ChunkApi* | [**create_chunk**](docs/ChunkApi.md#create_chunk) | **POST** /api/chunk | create_chunk\n*ChunkApi* | [**create_suggested_queries_handler**](docs/ChunkApi.md#create_suggested_queries_handler) | **POST** /api/chunk/gen_suggestions | get_suggested_queries\n*ChunkApi* | [**delete_chunk**](docs/ChunkApi.md#delete_chunk) | **DELETE** /api/chunk/{chunk_id} | delete_chunk\n*ChunkApi* | [**delete_chunk_by_tracking_id**](docs/ChunkApi.md#delete_chunk_by_tracking_id) | **DELETE** /api/chunk/tracking_id/{tracking_id} | delete_chunk_by_tracking_id\n*ChunkApi* | [**generate_off_chunks**](docs/ChunkApi.md#generate_off_chunks) | **POST** /api/chunk/generate | generate_off_chunks\n*ChunkApi* | [**get_chunk_by_id**](docs/ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{chunk_id} | get_chunk\n*ChunkApi* | [**get_chunk_by_tracking_id**](docs/ChunkApi.md#get_chunk_by_tracking_id) | **GET** /api/chunk/tracking_id/{tracking_id} | get_chunk_by_tracking_id\n*ChunkApi* | [**get_recommended_chunks**](docs/ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | get_recommended_chunks\n*ChunkApi* | [**search_chunk**](docs/ChunkApi.md#search_chunk) | **POST** /api/chunk/search | search\n*ChunkApi* | [**update_chunk**](docs/ChunkApi.md#update_chunk) | **PUT** /api/chunk/update | update_chunk\n*ChunkApi* | [**update_chunk_by_tracking_id**](docs/ChunkApi.md#update_chunk_by_tracking_id) | **PUT** /api/chunk/tracking_id/update | update_chunk_by_tracking_id\n*ChunkCollectionApi* | [**add_bookmark**](docs/ChunkCollectionApi.md#add_bookmark) | **POST** /api/chunk_collection/{collection_id} | add_bookmark\n*ChunkCollectionApi* | [**create_chunk_collection**](docs/ChunkCollectionApi.md#create_chunk_collection) | **POST** /api/chunk_collection | create_chunk_collection\n*ChunkCollectionApi* | [**delete_bookmark**](docs/ChunkCollectionApi.md#delete_bookmark) | **DELETE** /api/bookmark/{collection_id}/{bookmark_id} | delete_bookmark\n*ChunkCollectionApi* | [**delete_chunk_collection**](docs/ChunkCollectionApi.md#delete_chunk_collection) | **DELETE** /api/chunk_collection/{collection_id} | delete_chunk_collection\n*ChunkCollectionApi* | [**get_all_bookmarks**](docs/ChunkCollectionApi.md#get_all_bookmarks) | **GET** /api/chunk_collection/{collection_id}/{page} | get_all_bookmarks\n*ChunkCollectionApi* | [**get_collections_chunk_is_in**](docs/ChunkCollectionApi.md#get_collections_chunk_is_in) | **POST** /api/chunk_collection/bookmark | \n*ChunkCollectionApi* | [**get_logged_in_user_chunk_collections**](docs/ChunkCollectionApi.md#get_logged_in_user_chunk_collections) | **GET** /api/chunk_collection/{page} | get_current_user_collections\n*ChunkCollectionApi* | [**get_specific_user_chunk_collections**](docs/ChunkCollectionApi.md#get_specific_user_chunk_collections) | **GET** /api/user/collections/{user_id}/{page} | get_user_collections\n*ChunkCollectionApi* | [**search_collections**](docs/ChunkCollectionApi.md#search_collections) | **POST** /api/chunk_collection/search | collection_search\n*ChunkCollectionApi* | [**update_chunk_collection**](docs/ChunkCollectionApi.md#update_chunk_collection) | **PUT** /api/chunk_collection | update_chunk_collection\n*DatasetApi* | [**create_dataset**](docs/DatasetApi.md#create_dataset) | **POST** /api/dataset | create_dataset\n*DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /api/dataset | delete_dataset\n*DatasetApi* | [**get_client_dataset_config**](docs/DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | get_client_dataset_config\n*DatasetApi* | [**get_dataset**](docs/DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | get_dataset\n*DatasetApi* | [**get_datasets_from_organization**](docs/DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | get_organization_datasets\n*DatasetApi* | [**update_dataset**](docs/DatasetApi.md#update_dataset) | **PUT** /api/dataset | update_dataset\n*FileApi* | [**delete_file_handler**](docs/FileApi.md#delete_file_handler) | **DELETE** /api/file/{file_id} | delete_file\n*FileApi* | [**get_file_handler**](docs/FileApi.md#get_file_handler) | **GET** /api/file/{file_id} | get_file\n*FileApi* | [**get_image_file**](docs/FileApi.md#get_image_file) | **GET** /api/image/{file_name} | get_image_file\n*FileApi* | [**upload_file_handler**](docs/FileApi.md#upload_file_handler) | **POST** /api/file | upload_file\n*HealthApi* | [**health_check**](docs/HealthApi.md#health_check) | **GET** /api/health | \n*InvitationApi* | [**post_invitation**](docs/InvitationApi.md#post_invitation) | **POST** /api/invitation | send_invitation\n*MessageApi* | [**create_message_completion_handler**](docs/MessageApi.md#create_message_completion_handler) | **POST** /api/message | create_message\n*MessageApi* | [**edit_message_handler**](docs/MessageApi.md#edit_message_handler) | **PUT** /api/message | edit_message\n*MessageApi* | [**get_all_topic_messages**](docs/MessageApi.md#get_all_topic_messages) | **GET** /api/messages/{messages_topic_id} | get_all_messages\n*MessageApi* | [**regenerate_message_handler**](docs/MessageApi.md#regenerate_message_handler) | **DELETE** /api/message | regenerate_message\n*NotificationsApi* | [**get_notifications**](docs/NotificationsApi.md#get_notifications) | **GET** /api/notifications/{page} | get_notifications\n*NotificationsApi* | [**mark_all_notifications_as_read**](docs/NotificationsApi.md#mark_all_notifications_as_read) | **PUT** /api/notifications_readall | mark_all_read\n*NotificationsApi* | [**mark_notification_as_read**](docs/NotificationsApi.md#mark_notification_as_read) | **PUT** /api/notifications | mark_read\n*OrganizationApi* | [**create_organization**](docs/OrganizationApi.md#create_organization) | **POST** /api/organization | create_organization\n*OrganizationApi* | [**get_organization_by_id**](docs/OrganizationApi.md#get_organization_by_id) | **GET** /api/organization/{organization_id} | get_organization\n*OrganizationApi* | [**get_organization_usage**](docs/OrganizationApi.md#get_organization_usage) | **GET** /api/organization/usage/{organization_id} | get_organization_usage\n*OrganizationApi* | [**get_organization_users**](docs/OrganizationApi.md#get_organization_users) | **GET** /api/organization/users/{organization_id} | get_organization_users\n*OrganizationApi* | [**update_organization**](docs/OrganizationApi.md#update_organization) | **PUT** /api/organization | update_organization\n*StripeApi* | [**cancel_subscription**](docs/StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} | \n*StripeApi* | [**direct_to_payment_link**](docs/StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} | \n*StripeApi* | [**get_all_plans**](docs/StripeApi.md#get_all_plans) | **GET** /api/stripe/plans | \n*StripeApi* | [**update_subscription_plan**](docs/StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} | \n*TopicApi* | [**create_topic**](docs/TopicApi.md#create_topic) | **POST** /api/topic | create_topic\n*TopicApi* | [**delete_topic**](docs/TopicApi.md#delete_topic) | **DELETE** /api/topic | delete_topic\n*TopicApi* | [**get_all_topics**](docs/TopicApi.md#get_all_topics) | **GET** /api/topic | get_all_topics\n*TopicApi* | [**update_topic**](docs/TopicApi.md#update_topic) | **PUT** /api/topic | update_topic\n*UserApi* | [**delete_user_api_key**](docs/UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key | delete_user_api_key\n*UserApi* | [**get_user_files_handler**](docs/UserApi.md#get_user_files_handler) | **GET** /api/user/files/{user_id} | get_user_files\n*UserApi* | [**get_user_with_chunks_by_id**](docs/UserApi.md#get_user_with_chunks_by_id) | **GET** /api/user/{user_id}/{page} | get_user_chunks\n*UserApi* | [**set_user_api_key**](docs/UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key | set_user_api_key\n*UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /api/user | update_user\n\n\n## Documentation For Models\n\n - [AddChunkToCollectionData](docs/AddChunkToCollectionData.md)\n - [ApiKeyDTO](docs/ApiKeyDTO.md)\n - [AuthData](docs/AuthData.md)\n - [BookmarkChunks](docs/BookmarkChunks.md)\n - [BookmarkCollectionResult](docs/BookmarkCollectionResult.md)\n - [BookmarkData](docs/BookmarkData.md)\n - [ChatMessageProxy](docs/ChatMessageProxy.md)\n - [ChunkCollection](docs/ChunkCollection.md)\n - [ChunkCollectionAndFile](docs/ChunkCollectionAndFile.md)\n - [ChunkMetadata](docs/ChunkMetadata.md)\n - [ChunkMetadataWithFileData](docs/ChunkMetadataWithFileData.md)\n - [ClientDatasetConfiguration](docs/ClientDatasetConfiguration.md)\n - [CollectionData](docs/CollectionData.md)\n - [CreateChunkCollectionData](docs/CreateChunkCollectionData.md)\n - [CreateChunkData](docs/CreateChunkData.md)\n - [CreateDatasetRequest](docs/CreateDatasetRequest.md)\n - [CreateMessageData](docs/CreateMessageData.md)\n - [CreateOrganizationData](docs/CreateOrganizationData.md)\n - [CreateTopicData](docs/CreateTopicData.md)\n - [Dataset](docs/Dataset.md)\n - [DatasetAndOrgWithSubAndPlan](docs/DatasetAndOrgWithSubAndPlan.md)\n - [DatasetAndUsage](docs/DatasetAndUsage.md)\n - [DatasetDTO](docs/DatasetDTO.md)\n - [DatasetUsageCount](docs/DatasetUsageCount.md)\n - [DefaultError](docs/DefaultError.md)\n - [DeleteBookmarkPathData](docs/DeleteBookmarkPathData.md)\n - [DeleteCollectionData](docs/DeleteCollectionData.md)\n - [DeleteDatasetRequest](docs/DeleteDatasetRequest.md)\n - [DeleteTopicData](docs/DeleteTopicData.md)\n - [DeleteUserApiKeyRequest](docs/DeleteUserApiKeyRequest.md)\n - [EditMessageData](docs/EditMessageData.md)\n - [File](docs/File.md)\n - [FileDTO](docs/FileDTO.md)\n - [FileUploadCompletedNotificationWithName](docs/FileUploadCompletedNotificationWithName.md)\n - [GenerateChunksRequest](docs/GenerateChunksRequest.md)\n - [GenerateOffCollectionData](docs/GenerateOffCollectionData.md)\n - [GetAllBookmarksData](docs/GetAllBookmarksData.md)\n - [GetCollectionsForChunksData](docs/GetCollectionsForChunksData.md)\n - [GetDirectPaymentLinkData](docs/GetDirectPaymentLinkData.md)\n - [GetUserWithChunksData](docs/GetUserWithChunksData.md)\n - [InvitationData](docs/InvitationData.md)\n - [Message](docs/Message.md)\n - [Notification](docs/Notification.md)\n - [NotificationId](docs/NotificationId.md)\n - [NotificationReturn](docs/NotificationReturn.md)\n - [Organization](docs/Organization.md)\n - [OrganizationUsageCount](docs/OrganizationUsageCount.md)\n - [OrganizationWithSubAndPlan](docs/OrganizationWithSubAndPlan.md)\n - [RecommendChunksRequest](docs/RecommendChunksRequest.md)\n - [RegenerateMessageData](docs/RegenerateMessageData.md)\n - [ReturnCreatedChunk](docs/ReturnCreatedChunk.md)\n - [ScoreChunkDTO](docs/ScoreChunkDTO.md)\n - [SearchChunkData](docs/SearchChunkData.md)\n - [SearchChunkDataTimeRangeInner](docs/SearchChunkDataTimeRangeInner.md)\n - [SearchChunkDataWeightsInner](docs/SearchChunkDataWeightsInner.md)\n - [SearchChunkQueryResponseBody](docs/SearchChunkQueryResponseBody.md)\n - [SearchCollectionsData](docs/SearchCollectionsData.md)\n - [SearchCollectionsResult](docs/SearchCollectionsResult.md)\n - [SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)\n - [SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)\n - [SlimCollection](docs/SlimCollection.md)\n - [SlimUser](docs/SlimUser.md)\n - [StripePlan](docs/StripePlan.md)\n - [StripeSubscription](docs/StripeSubscription.md)\n - [SuggestedQueriesRequest](docs/SuggestedQueriesRequest.md)\n - [SuggestedQueriesResponse](docs/SuggestedQueriesResponse.md)\n - [Topic](docs/Topic.md)\n - [UpdateChunkByTrackingIdData](docs/UpdateChunkByTrackingIdData.md)\n - [UpdateChunkCollectionData](docs/UpdateChunkCollectionData.md)\n - [UpdateChunkData](docs/UpdateChunkData.md)\n - [UpdateDatasetRequest](docs/UpdateDatasetRequest.md)\n - [UpdateOrganizationData](docs/UpdateOrganizationData.md)\n - [UpdateSubscriptionData](docs/UpdateSubscriptionData.md)\n - [UpdateTopicData](docs/UpdateTopicData.md)\n - [UpdateUserData](docs/UpdateUserData.md)\n - [UploadFileData](docs/UploadFileData.md)\n - [UploadFileResult](docs/UploadFileResult.md)\n - [UserCollectionQuery](docs/UserCollectionQuery.md)\n - [UserDTO](docs/UserDTO.md)\n - [UserDTOWithChunks](docs/UserDTOWithChunks.md)\n - [UserOrganization](docs/UserOrganization.md)\n - [UserRole](docs/UserRole.md)\n\n\n\u003ca id=\"documentation-for-authorization\"\u003e\u003c/a\u003e\n## Documentation For Authorization\n\nEndpoints do not require authorization.\n\n\n## Author\n\n\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevflowinc%2Ftrieve_python_client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevflowinc%2Ftrieve_python_client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevflowinc%2Ftrieve_python_client/lists"}