{"id":28965910,"url":"https://github.com/devflowinc/trieve-java-client","last_synced_at":"2025-08-22T11:05:31.408Z","repository":{"id":231256128,"uuid":"779368951","full_name":"devflowinc/trieve-java-client","owner":"devflowinc","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-03T05:11:43.000Z","size":357,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-18T00:34:02.278Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","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}},"created_at":"2024-03-29T17:15:36.000Z","updated_at":"2024-03-29T17:31:32.000Z","dependencies_parsed_at":"2024-04-03T06:26:00.788Z","dependency_job_id":"32b76f70-7aeb-4012-9e27-245b7c813482","html_url":"https://github.com/devflowinc/trieve-java-client","commit_stats":null,"previous_names":["devflowinc/trieve-java-client"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/devflowinc/trieve-java-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve-java-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve-java-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve-java-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve-java-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devflowinc","download_url":"https://codeload.github.com/devflowinc/trieve-java-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devflowinc%2Ftrieve-java-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271628166,"owners_count":24792821,"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","status":"online","status_checked_at":"2025-08-22T02:00:08.480Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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:34.136Z","updated_at":"2025-08-22T11:05:31.362Z","avatar_url":"https://github.com/devflowinc.png","language":"Java","readme":"# trieve-java-client\n\nTrieve API\n- API version: 0.5.0\n  - Build date: 2024-03-29T12:34:27.506198300-05:00[America/Chicago]\n  - Generator version: 7.4.0\n\nTrieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.\n\n  For more information, please visit [https://trieve.ai](https://trieve.ai)\n\n*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*\n\n\n## Requirements\n\nBuilding the API client library requires:\n1. Java 1.8+\n2. Maven (3.8.3+)/Gradle (7.2+)\n\n## Installation\n\nTo install the API client library to your local Maven repository, simply execute:\n\n```shell\nmvn clean install\n```\n\nTo deploy it to a remote Maven repository instead, configure the settings of the repository and execute:\n\n```shell\nmvn clean deploy\n```\n\nRefer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.\n\n### Maven users\n\nAdd this dependency to your project's POM:\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.trieve\u003c/groupId\u003e\n  \u003cartifactId\u003etrieve-java-client\u003c/artifactId\u003e\n  \u003cversion\u003e0.5.0\u003c/version\u003e\n  \u003cscope\u003ecompile\u003c/scope\u003e\n\u003c/dependency\u003e\n```\n\n### Gradle users\n\nAdd this dependency to your project's build file:\n\n```groovy\n  repositories {\n    mavenCentral()     // Needed if the 'trieve-java-client' jar has been published to maven central.\n    mavenLocal()       // Needed if the 'trieve-java-client' jar has been published to the local maven repo.\n  }\n\n  dependencies {\n     implementation \"com.trieve:trieve-java-client:0.5.0\"\n  }\n```\n\n### Others\n\nAt first generate the JAR by executing:\n\n```shell\nmvn clean package\n```\n\nThen manually install the following JARs:\n\n* `target/trieve-java-client-0.5.0.jar`\n* `target/lib/*.jar`\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following Java code:\n\n```java\n\n// Import classes:\nimport org.openapitools.client.ApiClient;\nimport org.openapitools.client.ApiException;\nimport org.openapitools.client.Configuration;\nimport org.openapitools.client.models.*;\nimport org.openapitools.client.api.AuthApi;\n\npublic class Example {\n  public static void main(String[] args) {\n    ApiClient defaultClient = Configuration.getDefaultApiClient();\n    defaultClient.setBasePath(\"http://localhost:8090\");\n\n    AuthApi apiInstance = new AuthApi(defaultClient);\n    try {\n      SlimUser result = apiInstance.callback();\n      System.out.println(result);\n    } catch (ApiException e) {\n      System.err.println(\"Exception when calling AuthApi#callback\");\n      System.err.println(\"Status code: \" + e.getCode());\n      System.err.println(\"Reason: \" + e.getResponseBody());\n      System.err.println(\"Response headers: \" + e.getResponseHeaders());\n      e.printStackTrace();\n    }\n  }\n}\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost:8090*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AuthApi* | [**callback**](docs/AuthApi.md#callback) | **GET** /api/auth/callback | OpenID Connect callback\n*AuthApi* | [**getMe**](docs/AuthApi.md#getMe) | **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* | [**createChunk**](docs/ChunkApi.md#createChunk) | **POST** /api/chunk | Create or Upsert Chunk or Chunks\n*ChunkApi* | [**createSuggestedQueriesHandler**](docs/ChunkApi.md#createSuggestedQueriesHandler) | **POST** /api/chunk/gen_suggestions | Generate suggested queries\n*ChunkApi* | [**deleteChunk**](docs/ChunkApi.md#deleteChunk) | **DELETE** /api/chunk/{chunk_id} | Delete Chunk\n*ChunkApi* | [**deleteChunkByTrackingId**](docs/ChunkApi.md#deleteChunkByTrackingId) | **DELETE** /api/chunk/tracking_id/{tracking_id} | Delete Chunk By Tracking Id\n*ChunkApi* | [**generateOffChunks**](docs/ChunkApi.md#generateOffChunks) | **POST** /api/chunk/generate | RAG on Specified Chunks\n*ChunkApi* | [**getChunkById**](docs/ChunkApi.md#getChunkById) | **GET** /api/chunk/{chunk_id} | Get Chunk By Id\n*ChunkApi* | [**getChunkByTrackingId**](docs/ChunkApi.md#getChunkByTrackingId) | **GET** /api/chunk/tracking_id/{tracking_id} | Get Chunk By Tracking Id\n*ChunkApi* | [**getRecommendedChunks**](docs/ChunkApi.md#getRecommendedChunks) | **POST** /api/chunk/recommend | Get Recommended Chunks\n*ChunkApi* | [**searchChunk**](docs/ChunkApi.md#searchChunk) | **POST** /api/chunk/search | Search\n*ChunkApi* | [**updateChunk**](docs/ChunkApi.md#updateChunk) | **PUT** /api/chunk | Update Chunk\n*ChunkApi* | [**updateChunkByTrackingId**](docs/ChunkApi.md#updateChunkByTrackingId) | **PUT** /api/chunk/tracking_id/update | Update Chunk By Tracking Id\n*ChunkGroupApi* | [**addChunkToGroup**](docs/ChunkGroupApi.md#addChunkToGroup) | **POST** /api/chunk_group/chunk/{group_id} | Add Chunk to Group\n*ChunkGroupApi* | [**addChunkToGroupByTrackingId**](docs/ChunkGroupApi.md#addChunkToGroupByTrackingId) | **POST** /api/chunk_group/tracking_id/{tracking_id} | Add Chunk to Group by Tracking ID\n*ChunkGroupApi* | [**createChunkGroup**](docs/ChunkGroupApi.md#createChunkGroup) | **POST** /api/chunk_group | Create Chunk Group\n*ChunkGroupApi* | [**deleteChunkGroup**](docs/ChunkGroupApi.md#deleteChunkGroup) | **DELETE** /api/chunk_group/{group_id} | Delete Group\n*ChunkGroupApi* | [**deleteGroupByTrackingId**](docs/ChunkGroupApi.md#deleteGroupByTrackingId) | **DELETE** /api/chunk_group/tracking_id/{tracking_id} | Delete Group by Tracking ID\n*ChunkGroupApi* | [**getChunkGroup**](docs/ChunkGroupApi.md#getChunkGroup) | **GET** /api/chunk_group/{group_id} | Get Group\n*ChunkGroupApi* | [**getChunksInGroup**](docs/ChunkGroupApi.md#getChunksInGroup) | **GET** /api/chunk_group/{group_id}/{page} | Get Chunks in Group\n*ChunkGroupApi* | [**getChunksInGroupByTrackingId**](docs/ChunkGroupApi.md#getChunksInGroupByTrackingId) | **GET** /api/chunk_group/tracking_id/{group_tracking_id}/{page} | Get Chunks in Group by Tracking ID\n*ChunkGroupApi* | [**getGroupByTrackingId**](docs/ChunkGroupApi.md#getGroupByTrackingId) | **GET** /api/chunk_group/tracking_id/{tracking_id} | Get Group by Tracking ID\n*ChunkGroupApi* | [**getGroupsChunkIsIn**](docs/ChunkGroupApi.md#getGroupsChunkIsIn) | **POST** /api/chunk_group/chunks | Get Groups for Chunks\n*ChunkGroupApi* | [**getRecommendedGroups**](docs/ChunkGroupApi.md#getRecommendedGroups) | **POST** /api/chunk_group/recommend | Get Recommended Groups\n*ChunkGroupApi* | [**getSpecificDatasetChunkGroups**](docs/ChunkGroupApi.md#getSpecificDatasetChunkGroups) | **GET** /api/dataset/groups/{dataset_id}/{page} | Get Groups for Dataset\n*ChunkGroupApi* | [**removeChunkFromGroup**](docs/ChunkGroupApi.md#removeChunkFromGroup) | **DELETE** /api/chunk_group/chunk/{group_id} | Remove Chunk from Group\n*ChunkGroupApi* | [**searchOverGroups**](docs/ChunkGroupApi.md#searchOverGroups) | **POST** /api/chunk_group/group_oriented_search | Search Over Groups\n*ChunkGroupApi* | [**searchWithinGroup**](docs/ChunkGroupApi.md#searchWithinGroup) | **POST** /api/chunk_group/search | Search Within Group\n*ChunkGroupApi* | [**updateChunkGroup**](docs/ChunkGroupApi.md#updateChunkGroup) | **PUT** /api/chunk_group | Update Group\n*ChunkGroupApi* | [**updateGroupByTrackingId**](docs/ChunkGroupApi.md#updateGroupByTrackingId) | **PUT** /api/chunk_group/tracking_id/{tracking_id} | Update Group by Tracking ID\n*DatasetApi* | [**createDataset**](docs/DatasetApi.md#createDataset) | **POST** /api/dataset | Create dataset\n*DatasetApi* | [**deleteDataset**](docs/DatasetApi.md#deleteDataset) | **DELETE** /api/dataset | Delete Dataset\n*DatasetApi* | [**getClientDatasetConfig**](docs/DatasetApi.md#getClientDatasetConfig) | **GET** /api/dataset/envs | Get Client Configuration\n*DatasetApi* | [**getDataset**](docs/DatasetApi.md#getDataset) | **GET** /api/dataset/{dataset_id} | Get Dataset\n*DatasetApi* | [**getDatasetsFromOrganization**](docs/DatasetApi.md#getDatasetsFromOrganization) | **GET** /api/dataset/organization/{organization_id} | Get Datasets from Organization\n*DatasetApi* | [**updateDataset**](docs/DatasetApi.md#updateDataset) | **PUT** /api/dataset | Update Dataset\n*EventsApi* | [**getEvents**](docs/EventsApi.md#getEvents) | **POST** /api/events | Get events for the dataset\n*FileApi* | [**deleteFileHandler**](docs/FileApi.md#deleteFileHandler) | **DELETE** /api/file/{file_id} | Delete File\n*FileApi* | [**getDatasetFilesHandler**](docs/FileApi.md#getDatasetFilesHandler) | **GET** /api/dataset/files/{dataset_id}/{page} | Get Files for Dataset\n*FileApi* | [**getFileHandler**](docs/FileApi.md#getFileHandler) | **GET** /api/file/{file_id} | Get File\n*FileApi* | [**uploadFileHandler**](docs/FileApi.md#uploadFileHandler) | **POST** /api/file | Upload File\n*HealthApi* | [**healthCheck**](docs/HealthApi.md#healthCheck) | **GET** /api/health | Health Check\n*InvitationApi* | [**postInvitation**](docs/InvitationApi.md#postInvitation) | **POST** /api/invitation | Send Invitation\n*MessageApi* | [**createMessageCompletionHandler**](docs/MessageApi.md#createMessageCompletionHandler) | **POST** /api/message | Create a message\n*MessageApi* | [**editMessageHandler**](docs/MessageApi.md#editMessageHandler) | **PUT** /api/message | Edit a message\n*MessageApi* | [**getAllTopicMessages**](docs/MessageApi.md#getAllTopicMessages) | **GET** /api/messages/{messages_topic_id} | Get all messages for a given topic\n*MessageApi* | [**regenerateMessageHandler**](docs/MessageApi.md#regenerateMessageHandler) | **DELETE** /api/message | Regenerate message\n*OrganizationApi* | [**createOrganization**](docs/OrganizationApi.md#createOrganization) | **POST** /api/organization | Create Organization\n*OrganizationApi* | [**deleteOrganizationById**](docs/OrganizationApi.md#deleteOrganizationById) | **DELETE** /api/organization/{organization_id} | Delete Organization\n*OrganizationApi* | [**getOrganizationById**](docs/OrganizationApi.md#getOrganizationById) | **GET** /api/organization/{organization_id} | Get Organization\n*OrganizationApi* | [**getOrganizationUsage**](docs/OrganizationApi.md#getOrganizationUsage) | **GET** /api/organization/usage/{organization_id} | Get Organization Usage\n*OrganizationApi* | [**getOrganizationUsers**](docs/OrganizationApi.md#getOrganizationUsers) | **GET** /api/organization/users/{organization_id} | Get Organization Users\n*OrganizationApi* | [**updateOrganization**](docs/OrganizationApi.md#updateOrganization) | **PUT** /api/organization | Update Organization\n*StripeApi* | [**cancelSubscription**](docs/StripeApi.md#cancelSubscription) | **DELETE** /api/stripe/subscription/{subscription_id} | Cancel Subscription\n*StripeApi* | [**directToPaymentLink**](docs/StripeApi.md#directToPaymentLink) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} | Checkout\n*StripeApi* | [**getAllPlans**](docs/StripeApi.md#getAllPlans) | **GET** /api/stripe/plans | Get All Plans\n*StripeApi* | [**updateSubscriptionPlan**](docs/StripeApi.md#updateSubscriptionPlan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} | Update Subscription Plan\n*TopicApi* | [**createTopic**](docs/TopicApi.md#createTopic) | **POST** /api/topic | Create Topic\n*TopicApi* | [**deleteTopic**](docs/TopicApi.md#deleteTopic) | **DELETE** /api/topic | Delete Topic\n*TopicApi* | [**getAllTopicsForUser**](docs/TopicApi.md#getAllTopicsForUser) | **GET** /api/topic/user/{user_id} | Get All Topics for User\n*TopicApi* | [**updateTopic**](docs/TopicApi.md#updateTopic) | **PUT** /api/topic | Update Topic\n*UserApi* | [**deleteUserApiKey**](docs/UserApi.md#deleteUserApiKey) | **DELETE** /api/user/delete_api_key | Delete User Api Key\n*UserApi* | [**setUserApiKey**](docs/UserApi.md#setUserApiKey) | **POST** /api/user/set_api_key | Set User Api Key\n*UserApi* | [**updateUser**](docs/UserApi.md#updateUser) | **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 - [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 - [ChunkMetadataWithFileData](docs/ChunkMetadataWithFileData.md)\n - [ClientDatasetConfiguration](docs/ClientDatasetConfiguration.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 - [DeleteDatasetRequest](docs/DeleteDatasetRequest.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 - [FileDTO](docs/FileDTO.md)\n - [GenerateChunksRequest](docs/GenerateChunksRequest.md)\n - [GetEventsData](docs/GetEventsData.md)\n - [GetGroupsForChunksData](docs/GetGroupsForChunksData.md)\n - [GroupData](docs/GroupData.md)\n - [GroupScoreChunkDTO](docs/GroupScoreChunkDTO.md)\n - [InvitationData](docs/InvitationData.md)\n - [MatchCondition](docs/MatchCondition.md)\n - [Message](docs/Message.md)\n - [ModelFile](docs/ModelFile.md)\n - [Organization](docs/Organization.md)\n - [OrganizationUsageCount](docs/OrganizationUsageCount.md)\n - [Range](docs/Range.md)\n - [ReccomendGroupChunksRequest](docs/ReccomendGroupChunksRequest.md)\n - [RecommendChunksRequest](docs/RecommendChunksRequest.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 - [SearchGroupsResult](docs/SearchGroupsResult.md)\n - [SearchOverGroupsData](docs/SearchOverGroupsData.md)\n - [SearchOverGroupsResponseBody](docs/SearchOverGroupsResponseBody.md)\n - [SearchWithinGroupData](docs/SearchWithinGroupData.md)\n - [SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)\n - [SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)\n - [SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.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 - [UpdateUserData](docs/UpdateUserData.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## Recommendation\n\nIt's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.\n\n## Author\n\ndevelopers@trieve.ai\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevflowinc%2Ftrieve-java-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevflowinc%2Ftrieve-java-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevflowinc%2Ftrieve-java-client/lists"}