{"id":28965907,"url":"https://github.com/devflowinc/trieve-py-client","last_synced_at":"2025-06-24T07:10:34.509Z","repository":{"id":230257369,"uuid":"777075778","full_name":"devflowinc/trieve-py-client","owner":"devflowinc","description":"Python client for Trieve ","archived":false,"fork":false,"pushed_at":"2024-05-17T02:39:22.000Z","size":971,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"first-generated-python-client","last_synced_at":"2025-06-22T05:17:06.796Z","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-03-25T06:33:40.000Z","updated_at":"2024-05-17T02:39:26.000Z","dependencies_parsed_at":"2024-04-20T04:26:49.548Z","dependency_job_id":"56301830-aa39-40b8-86ec-4edcd8ac8753","html_url":"https://github.com/devflowinc/trieve-py-client","commit_stats":null,"previous_names":["devflowinc/trieve-python-client"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/devflowinc/trieve-py-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve-py-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve-py-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve-py-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve-py-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devflowinc","download_url":"https://codeload.github.com/devflowinc/trieve-py-client/tar.gz/refs/heads/first-generated-python-client","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve-py-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:33.836Z","updated_at":"2025-06-24T07:10:34.481Z","avatar_url":"https://github.com/devflowinc.png","language":"Python","readme":"# trieve_py_client\nTrieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.8.5\n- Package version: 0.8.5\n- Generator version: 7.4.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\nFor more information, please visit [https://trieve.ai](https://trieve.ai)\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_py_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_py_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_py_client\nfrom trieve_py_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://api.trieve.ai\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = trieve_py_client.Configuration(\n    host = \"https://api.trieve.ai\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith trieve_py_client.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = trieve_py_client.AuthApi(api_client)\n\n    try:\n        # OpenID Connect 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 *https://api.trieve.ai*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AuthApi* | [**callback**](docs/AuthApi.md#callback) | **GET** /api/auth/callback | OpenID Connect 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* | [**autocomplete**](docs/ChunkApi.md#autocomplete) | **POST** /api/chunk/autocomplete | Autocomplete\n*ChunkApi* | [**create_chunk**](docs/ChunkApi.md#create_chunk) | **POST** /api/chunk | Create or Upsert Chunk or Chunks\n*ChunkApi* | [**create_suggested_queries_handler**](docs/ChunkApi.md#create_suggested_queries_handler) | **POST** /api/chunk/gen_suggestions | Generate 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 | RAG on Specified Chunks\n*ChunkApi* | [**get_chunk_by_id**](docs/ChunkApi.md#get_chunk_by_id) | **GET** /api/chunk/{chunk_id} | Get Chunk By Id\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_chunks_by_ids**](docs/ChunkApi.md#get_chunks_by_ids) | **POST** /api/chunks | Get Chunks By Ids\n*ChunkApi* | [**get_chunks_by_tracking_ids**](docs/ChunkApi.md#get_chunks_by_tracking_ids) | **POST** /api/chunks/tracking | Get Chunks By TrackingIds\n*ChunkApi* | [**get_recommended_chunks**](docs/ChunkApi.md#get_recommended_chunks) | **POST** /api/chunk/recommend | Get Recommended Chunks\n*ChunkApi* | [**search_chunks**](docs/ChunkApi.md#search_chunks) | **POST** /api/chunk/search | Search\n*ChunkApi* | [**update_chunk**](docs/ChunkApi.md#update_chunk) | **PUT** /api/chunk | 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*ChunkGroupApi* | [**add_chunk_to_group**](docs/ChunkGroupApi.md#add_chunk_to_group) | **POST** /api/chunk_group/chunk/{group_id} | Add Chunk to Group\n*ChunkGroupApi* | [**add_chunk_to_group_by_tracking_id**](docs/ChunkGroupApi.md#add_chunk_to_group_by_tracking_id) | **POST** /api/chunk_group/tracking_id/{tracking_id} | Add Chunk to Group by Tracking ID\n*ChunkGroupApi* | [**create_chunk_group**](docs/ChunkGroupApi.md#create_chunk_group) | **POST** /api/chunk_group | Create Chunk Group\n*ChunkGroupApi* | [**delete_chunk_group**](docs/ChunkGroupApi.md#delete_chunk_group) | **DELETE** /api/chunk_group/{group_id} | Delete Group\n*ChunkGroupApi* | [**delete_group_by_tracking_id**](docs/ChunkGroupApi.md#delete_group_by_tracking_id) | **DELETE** /api/chunk_group/tracking_id/{tracking_id} | Delete Group by Tracking ID\n*ChunkGroupApi* | [**get_chunk_group**](docs/ChunkGroupApi.md#get_chunk_group) | **GET** /api/chunk_group/{group_id} | Get Group\n*ChunkGroupApi* | [**get_chunks_in_group**](docs/ChunkGroupApi.md#get_chunks_in_group) | **GET** /api/chunk_group/{group_id}/{page} | Get Chunks in Group\n*ChunkGroupApi* | [**get_chunks_in_group_by_tracking_id**](docs/ChunkGroupApi.md#get_chunks_in_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{group_tracking_id}/{page} | Get Chunks in Group by Tracking ID\n*ChunkGroupApi* | [**get_group_by_tracking_id**](docs/ChunkGroupApi.md#get_group_by_tracking_id) | **GET** /api/chunk_group/tracking_id/{tracking_id} | Get Group by Tracking ID\n*ChunkGroupApi* | [**get_groups_chunk_is_in**](docs/ChunkGroupApi.md#get_groups_chunk_is_in) | **POST** /api/chunk_group/chunks | Get Groups for Chunks\n*ChunkGroupApi* | [**get_recommended_groups**](docs/ChunkGroupApi.md#get_recommended_groups) | **POST** /api/chunk_group/recommend | Get Recommended Groups\n*ChunkGroupApi* | [**get_specific_dataset_chunk_groups**](docs/ChunkGroupApi.md#get_specific_dataset_chunk_groups) | **GET** /api/dataset/groups/{dataset_id}/{page} | Get Groups for Dataset\n*ChunkGroupApi* | [**remove_chunk_from_group**](docs/ChunkGroupApi.md#remove_chunk_from_group) | **DELETE** /api/chunk_group/chunk/{group_id} | Remove Chunk from Group\n*ChunkGroupApi* | [**search_over_groups**](docs/ChunkGroupApi.md#search_over_groups) | **POST** /api/chunk_group/group_oriented_search | Search Over Groups\n*ChunkGroupApi* | [**search_within_group**](docs/ChunkGroupApi.md#search_within_group) | **POST** /api/chunk_group/search | Search Within Group\n*ChunkGroupApi* | [**update_chunk_group**](docs/ChunkGroupApi.md#update_chunk_group) | **PUT** /api/chunk_group | Update Group\n*ChunkGroupApi* | [**update_group_by_tracking_id**](docs/ChunkGroupApi.md#update_group_by_tracking_id) | **PUT** /api/chunk_group/tracking_id/{tracking_id} | Update Group by Tracking ID\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/{dataset_id} | Delete Dataset\n*DatasetApi* | [**get_client_dataset_config**](docs/DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | Get Client Configuration\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 Datasets from Organization\n*DatasetApi* | [**update_dataset**](docs/DatasetApi.md#update_dataset) | **PUT** /api/dataset | Update Dataset\n*EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **POST** /api/events | Get events for the dataset\n*FileApi* | [**delete_file_handler**](docs/FileApi.md#delete_file_handler) | **DELETE** /api/file/{file_id} | Delete File\n*FileApi* | [**get_dataset_files_handler**](docs/FileApi.md#get_dataset_files_handler) | **GET** /api/dataset/files/{dataset_id}/{page} | Get Files for Dataset\n*FileApi* | [**get_file_handler**](docs/FileApi.md#get_file_handler) | **GET** /api/file/{file_id} | Get 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 | Health Check\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 a message\n*MessageApi* | [**edit_message_handler**](docs/MessageApi.md#edit_message_handler) | **PUT** /api/message | Edit a message\n*MessageApi* | [**get_all_topic_messages**](docs/MessageApi.md#get_all_topic_messages) | **GET** /api/messages/{messages_topic_id} | Get all messages for a given topic\n*MessageApi* | [**regenerate_message_handler**](docs/MessageApi.md#regenerate_message_handler) | **DELETE** /api/message | Regenerate message\n*OrganizationApi* | [**create_organization**](docs/OrganizationApi.md#create_organization) | **POST** /api/organization | Create Organization\n*OrganizationApi* | [**delete_organization_by_id**](docs/OrganizationApi.md#delete_organization_by_id) | **DELETE** /api/organization/{organization_id} | Delete 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} | Cancel Subscription\n*StripeApi* | [**direct_to_payment_link**](docs/StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} | Checkout\n*StripeApi* | [**get_all_plans**](docs/StripeApi.md#get_all_plans) | **GET** /api/stripe/plans | Get All Plans\n*StripeApi* | [**update_subscription_plan**](docs/StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} | Update Subscription Plan\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/{topic_id} | Delete Topic\n*TopicApi* | [**get_all_topics_for_owner_id**](docs/TopicApi.md#get_all_topics_for_owner_id) | **GET** /api/topic/owner/{owner_id} | Get All Topics for Owner ID\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/api_key/{api_key_id} | Delete User Api Key\n*UserApi* | [**set_user_api_key**](docs/UserApi.md#set_user_api_key) | **POST** /api/user/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 - [AddChunkToGroupData](docs/AddChunkToGroupData.md)\n - [ApiKeyDTO](docs/ApiKeyDTO.md)\n - [AuthQuery](docs/AuthQuery.md)\n - [AutocompleteData](docs/AutocompleteData.md)\n - [BatchQueuedChunkResponse](docs/BatchQueuedChunkResponse.md)\n - [BookmarkData](docs/BookmarkData.md)\n - [BookmarkGroupResult](docs/BookmarkGroupResult.md)\n - [ChatMessageProxy](docs/ChatMessageProxy.md)\n - [ChunkData](docs/ChunkData.md)\n - [ChunkFilter](docs/ChunkFilter.md)\n - [ChunkGroup](docs/ChunkGroup.md)\n - [ChunkGroupAndFile](docs/ChunkGroupAndFile.md)\n - [ChunkMetadata](docs/ChunkMetadata.md)\n - [ChunkMetadataTypes](docs/ChunkMetadataTypes.md)\n - [ChunkMetadataWithScore](docs/ChunkMetadataWithScore.md)\n - [ClientDatasetConfiguration](docs/ClientDatasetConfiguration.md)\n - [ContentChunkMetadata](docs/ContentChunkMetadata.md)\n - [CreateChunkData](docs/CreateChunkData.md)\n - [CreateChunkGroupData](docs/CreateChunkGroupData.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 - [DatasetAndUsage](docs/DatasetAndUsage.md)\n - [DatasetDTO](docs/DatasetDTO.md)\n - [DatasetUsageCount](docs/DatasetUsageCount.md)\n - [DateRange](docs/DateRange.md)\n - [DeleteTopicData](docs/DeleteTopicData.md)\n - [DeleteUserApiKeyRequest](docs/DeleteUserApiKeyRequest.md)\n - [EditMessageData](docs/EditMessageData.md)\n - [ErrorResponseBody](docs/ErrorResponseBody.md)\n - [Event](docs/Event.md)\n - [EventReturn](docs/EventReturn.md)\n - [FieldCondition](docs/FieldCondition.md)\n - [File](docs/File.md)\n - [FileDTO](docs/FileDTO.md)\n - [GenerateChunksRequest](docs/GenerateChunksRequest.md)\n - [GeoInfo](docs/GeoInfo.md)\n - [GeoTypes](docs/GeoTypes.md)\n - [GetChunksData](docs/GetChunksData.md)\n - [GetEventsData](docs/GetEventsData.md)\n - [GetGroupsForChunksData](docs/GetGroupsForChunksData.md)\n - [GetTrackingChunksData](docs/GetTrackingChunksData.md)\n - [GroupData](docs/GroupData.md)\n - [GroupScoreChunk](docs/GroupScoreChunk.md)\n - [InvitationData](docs/InvitationData.md)\n - [LocationBoundingBox](docs/LocationBoundingBox.md)\n - [LocationPolygon](docs/LocationPolygon.md)\n - [LocationRadius](docs/LocationRadius.md)\n - [MatchCondition](docs/MatchCondition.md)\n - [Message](docs/Message.md)\n - [Organization](docs/Organization.md)\n - [OrganizationUsageCount](docs/OrganizationUsageCount.md)\n - [Range](docs/Range.md)\n - [RangeCondition](docs/RangeCondition.md)\n - [RecommendChunksRequest](docs/RecommendChunksRequest.md)\n - [RecommendGroupChunksRequest](docs/RecommendGroupChunksRequest.md)\n - [RegenerateMessageData](docs/RegenerateMessageData.md)\n - [ReturnQueuedChunk](docs/ReturnQueuedChunk.md)\n - [ScoreChunkDTO](docs/ScoreChunkDTO.md)\n - [SearchChunkData](docs/SearchChunkData.md)\n - [SearchChunkQueryResponseBody](docs/SearchChunkQueryResponseBody.md)\n - [SearchOverGroupsData](docs/SearchOverGroupsData.md)\n - [SearchOverGroupsResults](docs/SearchOverGroupsResults.md)\n - [SearchWithinGroupData](docs/SearchWithinGroupData.md)\n - [SearchWithinGroupResults](docs/SearchWithinGroupResults.md)\n - [SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)\n - [SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)\n - [SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.md)\n - [SlimChunkMetadata](docs/SlimChunkMetadata.md)\n - [SlimChunkMetadataWithScore](docs/SlimChunkMetadataWithScore.md)\n - [SlimGroup](docs/SlimGroup.md)\n - [SlimUser](docs/SlimUser.md)\n - [StripePlan](docs/StripePlan.md)\n - [SuggestedQueriesRequest](docs/SuggestedQueriesRequest.md)\n - [SuggestedQueriesResponse](docs/SuggestedQueriesResponse.md)\n - [Topic](docs/Topic.md)\n - [UpdateChunkByTrackingIdData](docs/UpdateChunkByTrackingIdData.md)\n - [UpdateChunkData](docs/UpdateChunkData.md)\n - [UpdateChunkGroupData](docs/UpdateChunkGroupData.md)\n - [UpdateDatasetRequest](docs/UpdateDatasetRequest.md)\n - [UpdateGroupByTrackingIDData](docs/UpdateGroupByTrackingIDData.md)\n - [UpdateOrganizationData](docs/UpdateOrganizationData.md)\n - [UpdateTopicData](docs/UpdateTopicData.md)\n - [UpdateUserOrgRoleData](docs/UpdateUserOrgRoleData.md)\n - [UploadFileData](docs/UploadFileData.md)\n - [UploadFileResult](docs/UploadFileResult.md)\n - [UserOrganization](docs/UserOrganization.md)\n\n\n\u003ca id=\"documentation-for-authorization\"\u003e\u003c/a\u003e\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n\u003ca id=\"ApiKey\"\u003e\u003c/a\u003e\n### ApiKey\n\n- **Type**: API key\n- **API key parameter name**: Authorization\n- **Location**: HTTP header\n\n\n## Author\n\ndevelopers@trieve.ai\n\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevflowinc%2Ftrieve-py-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevflowinc%2Ftrieve-py-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevflowinc%2Ftrieve-py-client/lists"}