# Trieve ## Docs - [Get All User Events](https://docs.trieve.ai/api-reference/analytics/get-all-user-events.md): This route allows you to view all user events. - [Get Analytics](https://docs.trieve.ai/api-reference/analytics/get-analytics.md): This route allows you to view the analytics for a dataset using a structured query. - [Get Cluster Analytics](https://docs.trieve.ai/api-reference/analytics/get-cluster-analytics.md): This route allows you to view the cluster analytics for a dataset. - [Get Component Analytics](https://docs.trieve.ai/api-reference/analytics/get-component-analytics.md): This route allows you to view the component analytics for a dataset. - [Get CTR Analytics](https://docs.trieve.ai/api-reference/analytics/get-ctr-analytics.md): This route allows you to view the CTR analytics for a dataset. - [Get RAG Analytics](https://docs.trieve.ai/api-reference/analytics/get-rag-analytics.md): This route allows you to view the RAG analytics for a dataset. - [Get Recommendation Analytics](https://docs.trieve.ai/api-reference/analytics/get-recommendation-analytics.md): This route allows you to view the recommendation analytics for a dataset. - [Get Search Analytics](https://docs.trieve.ai/api-reference/analytics/get-search-analytics.md): This route allows you to view the search analytics for a dataset. - [Get Top Datasets](https://docs.trieve.ai/api-reference/analytics/get-top-datasets.md): This route allows you to view the top datasets for a given type. - [Get User Event By ID](https://docs.trieve.ai/api-reference/analytics/get-user-event-by-id.md): This route allows you to view an user event by its ID. You can pass in any type of event and get the details for that event. - [Rate RAG](https://docs.trieve.ai/api-reference/analytics/rate-rag.md): This route allows you to Rate a RAG query. - [Rate Search](https://docs.trieve.ai/api-reference/analytics/rate-search.md): This route allows you to Rate a search query. - [Send CTR Data](https://docs.trieve.ai/api-reference/analytics/send-ctr-data.md): This route allows you to send clickstream data to the system. Clickstream data is used to fine-tune the re-ranking of search results and recommendations. - [Send User Event Data](https://docs.trieve.ai/api-reference/analytics/send-user-event-data.md): This route allows you to send user event data to the system. - [Get Me](https://docs.trieve.ai/api-reference/auth/get-me.md): Get the user corresponding to your current auth credentials. - [Login](https://docs.trieve.ai/api-reference/auth/login.md): This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc. - [Logout](https://docs.trieve.ai/api-reference/auth/logout.md): Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key. - [OpenID Connect callback](https://docs.trieve.ai/api-reference/auth/openid-connect-callback.md): This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header. - [Post apiauthcreate api only user](https://docs.trieve.ai/api-reference/auth/post-apiauthcreate_api_only_user.md) - [Add Chunk to Group](https://docs.trieve.ai/api-reference/chunk-group/add-chunk-to-group.md): Route to add a chunk to a group. One of chunk_id or chunk_tracking_id must be provided. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Add Chunk to Group by Tracking ID](https://docs.trieve.ai/api-reference/chunk-group/add-chunk-to-group-by-tracking-id.md): Route to add a chunk to a group by tracking id. One of chunk_id or chunk_tracking_id must be provided. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Autocomplete Search Over Groups](https://docs.trieve.ai/api-reference/chunk-group/autocomplete-search-over-groups.md): This route provides the primary autocomplete functionality for the API. This prioritize prefix matching with semantic or full-text search. - [Create or Upsert Group or Groups](https://docs.trieve.ai/api-reference/chunk-group/create-or-upsert-group-or-groups.md): Create new chunk_group(s). This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail. Only 1000 chunk groups can be created at a time. Auth'ed user or api key must have an admin or owner role for the spec… - [Delete Group](https://docs.trieve.ai/api-reference/chunk-group/delete-group.md): This will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Delete Group by Tracking ID](https://docs.trieve.ai/api-reference/chunk-group/delete-group-by-tracking-id.md): Delete a chunk_group with the given tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Get Chunks in Group](https://docs.trieve.ai/api-reference/chunk-group/get-chunks-in-group.md): Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed. - [Get Chunks in Group by Tracking ID](https://docs.trieve.ai/api-reference/chunk-group/get-chunks-in-group-by-tracking-id.md): Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon. Page is 1-indexed. - [Get Group](https://docs.trieve.ai/api-reference/chunk-group/get-group.md): Fetch the group with the given id. - [Get Group by Tracking ID](https://docs.trieve.ai/api-reference/chunk-group/get-group-by-tracking-id.md): Fetch the group with the given tracking id. get_group_by_tracking_id - [Get Groups for Chunks](https://docs.trieve.ai/api-reference/chunk-group/get-groups-for-chunks.md): Route to get the groups that a chunk is in. - [Get Groups for Dataset](https://docs.trieve.ai/api-reference/chunk-group/get-groups-for-dataset.md): Fetch the groups which belong to a dataset specified by its id. - [Get Recommended Groups](https://docs.trieve.ai/api-reference/chunk-group/get-recommended-groups.md): Route to get recommended groups. This route will return groups which are similar to the groups in the request body. You must provide at least one positive group id or group tracking id. - [Remove Chunk from Group](https://docs.trieve.ai/api-reference/chunk-group/remove-chunk-from-group.md): Route to remove a chunk from a group. Auth'ed user or api key must be an admin or owner of the dataset's organization to remove a chunk from a group. - [Search Over Groups](https://docs.trieve.ai/api-reference/chunk-group/search-over-groups.md): This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the top chunk of each… - [Search Within Group](https://docs.trieve.ai/api-reference/chunk-group/search-within-group.md): This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using scores from a cross encoder model. - [Update Group](https://docs.trieve.ai/api-reference/chunk-group/update-group.md): Update a chunk_group. One of group_id or tracking_id must be provided. If you try to change the tracking_id to one that already exists, this operation will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Autocomplete](https://docs.trieve.ai/api-reference/chunk/autocomplete.md): This route provides the primary autocomplete functionality for the API. This prioritize prefix matching with semantic or full-text search. - [Bulk Delete Chunks](https://docs.trieve.ai/api-reference/chunk/bulk-delete-chunk.md): Delete multiple chunks using a filter. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Count chunks above threshold](https://docs.trieve.ai/api-reference/chunk/count-chunks-above-threshold.md): This route can be used to determine the number of chunk results that match a search query including score threshold and filters. It may be high latency for large limits. There is a dataset configuration imposed restriction on the maximum limit value (default 10,000) which is used to prevent DDOS att… - [Create or Upsert Chunk or Chunks](https://docs.trieve.ai/api-reference/chunk/create-or-upsert-chunk-or-chunks.md): Create new chunk(s). If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks. Auth'ed user or api key mu… - [Delete Chunk](https://docs.trieve.ai/api-reference/chunk/delete-chunk.md): Delete a chunk by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Delete Chunk By Tracking Id](https://docs.trieve.ai/api-reference/chunk/delete-chunk-by-tracking-id.md): Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Generate suggested queries](https://docs.trieve.ai/api-reference/chunk/generate-suggested-queries.md): This endpoint will generate 3 suggested queries based off a hybrid search using RAG with the query provided in the request body and return them as a JSON object. - [Get Chunk By Id](https://docs.trieve.ai/api-reference/chunk/get-chunk-by-id.md): Get a singular chunk by id. - [Get Chunk By Tracking Id](https://docs.trieve.ai/api-reference/chunk/get-chunk-by-tracking-id.md): Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk. - [Get Chunks By Ids](https://docs.trieve.ai/api-reference/chunk/get-chunks-by-ids.md): Get multiple chunks by multiple ids. - [Get Chunks By Tracking Ids](https://docs.trieve.ai/api-reference/chunk/get-chunks-by-tracking-ids.md): Get multiple chunks by ids. - [Get Recommended Chunks](https://docs.trieve.ai/api-reference/chunk/get-recommended-chunks.md): Get recommendations of chunks similar to the positive samples in the request and dissimilar to the negative. - [RAG on Specified Chunks](https://docs.trieve.ai/api-reference/chunk/rag-on-specified-chunks.md): This endpoint exists as an alternative to the topic+message resource pattern where our Trieve handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt and the conversation is ephemeral. - [Scroll Chunks](https://docs.trieve.ai/api-reference/chunk/scroll-chunks.md): Get paginated chunks from your dataset with filters and custom sorting. If sort by is not specified, the results will sort by the id's of the chunks in ascending order. Sort by and offset_chunk_id cannot be used together; if you want to scroll with a sort by then you need to use a must_not filter wi… - [Search](https://docs.trieve.ai/api-reference/chunk/search.md): This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `` or custom specified tags for sub-sentence highlighting. - [Split HTML Content into Chunks](https://docs.trieve.ai/api-reference/chunk/split-html-content-into-chunks.md): This endpoint receives a single html string and splits it into chunks based on the headings and body content. The headings are split based on heading html tags. chunk_html has a maximum size of 256Kb. - [Update Chunk](https://docs.trieve.ai/api-reference/chunk/update-chunk.md): Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Update Chunk By Tracking Id](https://docs.trieve.ai/api-reference/chunk/update-chunk-by-tracking-id.md): Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Create a new crawl request](https://docs.trieve.ai/api-reference/crawl/create-a-new-crawl-request.md): This endpoint is used to create a new crawl request for a dataset. The request payload should contain the crawl options to use for the crawl. - [Delete a crawl request](https://docs.trieve.ai/api-reference/crawl/delete-a-crawl-request.md): This endpoint is used to delete an existing crawl request for a dataset. The request payload should contain the crawl id to delete. - [Get all crawl requests for a dataset](https://docs.trieve.ai/api-reference/crawl/get-all-crawl-requests-for-a-dataset.md): This endpoint is used to get all crawl requests for a dataset. - [Update a crawl request](https://docs.trieve.ai/api-reference/crawl/update-a-crawl-request.md): This endpoint is used to update an existing crawl request for a dataset. The request payload should contain the crawl id and the crawl options to update for the crawl. - [Batch Create Datasets](https://docs.trieve.ai/api-reference/dataset/batch-create-datasets.md): Datasets will be created in the org specified via the TR-Organization header. Auth'ed user must be an owner of the organization to create datasets. If a tracking_id is ignored due to it already existing on the org, the response will not contain a dataset with that tracking_id and it can be assumed t… - [Clear Dataset](https://docs.trieve.ai/api-reference/dataset/clear-dataset.md): Removes all chunks, files, and groups from the dataset while retaining the analytics and dataset itself. The auth'ed user must be an owner of the organization to clear a dataset. - [Clone Dataset](https://docs.trieve.ai/api-reference/dataset/clone-dataset.md): Clones a dataset and creates a new dataset with the same configuration and chunks. The auth'ed user must be an owner of the organization to clone a dataset. - [Create Dataset](https://docs.trieve.ai/api-reference/dataset/create-dataset.md): Dataset will be created in the org specified via the TR-Organization header. Auth'ed user must be an owner of the organization to create a dataset. - [Create ETL Job](https://docs.trieve.ai/api-reference/dataset/create-etl-job.md): This endpoint is used to create a new ETL job for a dataset. - [Create Pagefind Index for Dataset](https://docs.trieve.ai/api-reference/dataset/create-pagefind-index-for-dataset.md): Uses pagefind to index the dataset and store the result into a CDN for retrieval. The auth'ed user must be an admin of the organization to create a pagefind index for a dataset. - [Delete Dataset](https://docs.trieve.ai/api-reference/dataset/delete-dataset.md): Auth'ed user must be an owner of the organization to delete a dataset. - [Delete Dataset by Tracking ID](https://docs.trieve.ai/api-reference/dataset/delete-dataset-by-tracking-id.md): Auth'ed user must be an owner of the organization to delete a dataset. - [Get All Tags](https://docs.trieve.ai/api-reference/dataset/get-all-tags.md): Scroll through all tags in the dataset and get the number of chunks in the dataset with that tag plus the total number of unique tags for the whole datset. - [Get Dataset By ID](https://docs.trieve.ai/api-reference/dataset/get-dataset-by-id.md): Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Get Dataset by Tracking ID](https://docs.trieve.ai/api-reference/dataset/get-dataset-by-tracking-id.md): Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Get dataset crawl options](https://docs.trieve.ai/api-reference/dataset/get-dataset-crawl-options.md) - [Get Datasets from Organization](https://docs.trieve.ai/api-reference/dataset/get-datasets-from-organization.md): Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Get events for the dataset](https://docs.trieve.ai/api-reference/dataset/get-events-for-the-dataset.md): Get events for the dataset specified by the TR-Dataset header. - [Get file and chunk creation queue lengths](https://docs.trieve.ai/api-reference/dataset/get-file-and-chunk-creation-queue-lengths.md): Get the queue lengths for file and chunk creation. - [Get Pagefind Index Url for Dataset](https://docs.trieve.ai/api-reference/dataset/get-pagefind-index-url-for-dataset.md): Returns the root URL for your pagefind index, will error if pagefind is not enabled - [Get Usage By Dataset ID](https://docs.trieve.ai/api-reference/dataset/get-usage-by-dataset-id.md): Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Update Dataset by ID or Tracking ID](https://docs.trieve.ai/api-reference/dataset/update-dataset-by-id-or-tracking-id.md): One of id or tracking_id must be provided. The auth'ed user must be an owner of the organization to update a dataset. - [Ab Test](https://docs.trieve.ai/api-reference/experiment/ab-test.md): Get a user's treatment for an experiment. Auth'ed user must be an owner of the organization to get a user's treatment. - [Create Experiment](https://docs.trieve.ai/api-reference/experiment/create-experiment.md): Experiment will be created in the dataset specified via the TR-Dataset header. Auth'ed user must be an owner of the organization to create an experiment. - [Delete Experiment](https://docs.trieve.ai/api-reference/experiment/delete-experiment.md): Delete an experiment. Auth'ed user must be an owner of the organization to delete an experiment. - [Update Experiment](https://docs.trieve.ai/api-reference/experiment/update-experiment.md): Update an experiment. Auth'ed user must be an owner of the organization to update an experiment. - [Create Presigned CSV/JSONL S3 PUT URL](https://docs.trieve.ai/api-reference/file/create-presigned-url-for-csv-jsonl.md): This route is useful for uploading very large CSV or JSONL files. Once you have completed the upload, chunks will be automatically created from the file for each line in the CSV or JSONL file. The chunks will be indexed and searchable. Auth'ed user must be an admin or owner of the dataset's organiza… - [Delete File](https://docs.trieve.ai/api-reference/file/delete-file.md): Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but only delete them all together if you specify delete_chunks to be true. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Get File with Signed URL](https://docs.trieve.ai/api-reference/file/get-file.md): Get all of the information for a file along with a signed s3 url corresponding to the file_id requested such that you can download the file. - [Get File with Signed URL](https://docs.trieve.ai/api-reference/file/get-file-with-signed-url.md): Get all of the information for a file along with a signed s3 url corresponding to the file_id requested such that you can download the file. - [Get Files and Group IDs for Dataset](https://docs.trieve.ai/api-reference/file/get-files-and-group-ids-for-dataset.md): Get all files and their group ids which belong to a given dataset specified by the dataset_id parameter. 10 files and group ids are returned per page. This route may return the same file multiple times if the file is associated with multiple groups. - [Get Files and Group IDs for Dataset](https://docs.trieve.ai/api-reference/file/get-files-for-dataset.md): Get all files and their group ids which belong to a given dataset specified by the dataset_id parameter. 10 files and group ids are returned per page. This route may return the same file multiple times if the file is associated with multiple groups. - [Scroll Files with Groups](https://docs.trieve.ai/api-reference/file/scroll-files.md): Scroll through the files along with their groups in a dataset. This is useful for paginating through files. The cursor is used to fetch the next page of files. The page size is used to specify how many files to fetch per page. The default page size is 10. - [Scroll Files with Groups](https://docs.trieve.ai/api-reference/file/scroll-files-with-groups.md): Scroll through the files along with their groups in a dataset. This is useful for paginating through files. The cursor is used to fetch the next page of files. The page size is used to specify how many files to fetch per page. The default page size is 10. - [Upload File](https://docs.trieve.ai/api-reference/file/upload-file.md): Upload a file to S3 bucket attached to your dataset. You can select between a naive chunking strategy where the text is extracted with Apache Tika and split into segments with a target number of segments per chunk OR you can use a vision LLM to convert the file to markdown and create chunks per page… - [Upload HTML Page](https://docs.trieve.ai/api-reference/file/upload-html-page.md): Chunk HTML by headings and queue for indexing into the specified dataset. - [Health Check](https://docs.trieve.ai/api-reference/health/health-check.md): Confirmation that the service is healthy and can make embedding vectors - [Delete Invitation](https://docs.trieve.ai/api-reference/invitation/delete-invitation.md): Delete an invitation by id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Get Invitations](https://docs.trieve.ai/api-reference/invitation/get-invitations.md): Get all invitations for the organization. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Send Invitation](https://docs.trieve.ai/api-reference/invitation/send-invitation.md): Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their. Auth'ed user or api key must have an admin or owner role for the specified dataset's organiza… - [Create message](https://docs.trieve.ai/api-reference/message/create-message.md): Create message. Messages are attached to topics in order to coordinate memory of gen-AI chat sessions.Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Edit Image](https://docs.trieve.ai/api-reference/message/edit-image.md): Uses `gpt-image-1` to edit an images based on a given prompt. Note that the images must be base64 encoded and all must have the same mime type. - [Edit message](https://docs.trieve.ai/api-reference/message/edit-message.md): This will delete the specified message and replace it with a new message. All messages after the message being edited in the sort order will be deleted. The new message will be generated by the AI based on the new content provided in the request body. The response will include Chunks first on the st… - [Generate Message Completions](https://docs.trieve.ai/api-reference/message/generate-message-completions.md): Uses `openai` to generate a message completion for a given prompt. - [Get a message by its ID](https://docs.trieve.ai/api-reference/message/get-a-message-by-its-id.md): Quickly get the full object for a given message. From the message, you can get the topic and all messages which exist on that topic. - [Get all messages for a given topic](https://docs.trieve.ai/api-reference/message/get-all-messages-for-a-given-topic.md): If the topic is a RAG topic then the response will include Chunks first on each message. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more information. - [Get tool function parameters](https://docs.trieve.ai/api-reference/message/get-tool-function-parameters.md): This endpoint will generate the parameters for a tool function based on the user's message and image URL provided in the request body. The response will include the parameters for the tool function as a JSON object. - [Regenerate message](https://docs.trieve.ai/api-reference/message/regenerate-message-1.md): Regenerate the assistant response to the last user message of a topic. This will delete the last message and replace it with a new message. The response will include Chunks first on the stream if the topic is using RAG. The structure will look like `[chunks]||mesage`. See docs.trieve.ai for more inf… - [Transcribe Audio](https://docs.trieve.ai/api-reference/message/transcribe-audio.md): Uses `whisper-1` to transcribe an audio file passed in as a base64 encoded string. - [Get Prometheus Metrics](https://docs.trieve.ai/api-reference/metrics/get-prometheus-metrics.md): This route allows you to view the number of items in each queue in the Prometheus format. - [Create Organization](https://docs.trieve.ai/api-reference/organization/create-organization.md): Create a new organization. The auth'ed user who creates the organization will be the default owner of the organization. - [Create Organization Api Key](https://docs.trieve.ai/api-reference/organization/create-organization-api-key.md): Create a new api key for the organization. Successful response will contain the newly created api key. - [Delete Organization](https://docs.trieve.ai/api-reference/organization/delete-organization.md): Delete an organization by its id. The auth'ed user must be an owner of the organization to delete it. - [Delete Organization Api Key](https://docs.trieve.ai/api-reference/organization/delete-organization-api-key.md): Delete an api key for the auth'ed organization. - [Get Organization](https://docs.trieve.ai/api-reference/organization/get-organization.md): Fetch the details of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Get Organization Api Keys](https://docs.trieve.ai/api-reference/organization/get-organization-api-keys.md): Get the api keys which belong to the organization. The actual api key values are not returned, only the ids, names, and creation dates. - [Get organization usage](https://docs.trieve.ai/api-reference/organization/get-organization-usage.md) - [Get Organization Users](https://docs.trieve.ai/api-reference/organization/get-organization-users.md): Fetch the users of an organization by its id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Update All Dataset Configurations](https://docs.trieve.ai/api-reference/organization/update-all-dataset-configurations.md): Update the configurations for all datasets in an organization. Only the specified keys in the configuration object will be changed per dataset such that you can preserve dataset unique values. Auth'ed user or api key must have an owner role for the specified organization. - [Update Organization](https://docs.trieve.ai/api-reference/organization/update-organization.md): Update an organization. Only the owner of the organization can update it. - [Get apipublic page](https://docs.trieve.ai/api-reference/public/get-apipublic_page.md) - [Send a Shopify user event](https://docs.trieve.ai/api-reference/public/send-a-shopify-user-event.md): This endpoint is used to send a Shopify user event to all users in the organization. - [Cancel Subscription](https://docs.trieve.ai/api-reference/stripe/cancel-subscription.md): Cancel a subscription by its id - [Checkout](https://docs.trieve.ai/api-reference/stripe/checkout.md): Get a 303 SeeOther redirect link to the stripe checkout page for the plan and organization - [Update Payment Method](https://docs.trieve.ai/api-reference/stripe/create-checkout-session-setup.md): Update a your payment method to a new one - [Estimate Bill From Range](https://docs.trieve.ai/api-reference/stripe/estimate-bill-from-range.md): Return the amount you will be billed from a date range if you were on usage based pricing - [Get All Invoices](https://docs.trieve.ai/api-reference/stripe/get-all-invoices.md): Get a list of all invoices - [Get All Plans](https://docs.trieve.ai/api-reference/stripe/get-all-plans.md): Get a list of all plans - [Get All Usage Plans](https://docs.trieve.ai/api-reference/stripe/get-all-usage-plans.md): Get a list of all usage_based plans - [Update Payment Method](https://docs.trieve.ai/api-reference/stripe/update-payment-method.md): Update a your payment method to a new one - [Update Subscription Plan](https://docs.trieve.ai/api-reference/stripe/update-subscription-plan.md): Update a subscription to a new plan - [Clone Topic](https://docs.trieve.ai/api-reference/topic/clone-topic.md): Create a new chat topic from a `topic_id`. The new topic will be attched to the owner_id and act as a coordinator for conversation message history of gen-AI chat sessions. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Create Topic](https://docs.trieve.ai/api-reference/topic/create-topic.md): Create a new chat topic. Topics are attached to a owner_id's and act as a coordinator for conversation message history of gen-AI chat sessions. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Delete Topic](https://docs.trieve.ai/api-reference/topic/delete-topic.md): Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Get All Topics for Owner ID](https://docs.trieve.ai/api-reference/topic/get-all-topics-for-owner-id.md): Get all topics belonging to an arbitary owner_id. This is useful for managing message history and chat sessions. It is common to use a browser fingerprint or your user's id as the owner_id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Update Topic](https://docs.trieve.ai/api-reference/topic/update-topic.md): Update an existing chat topic. Currently, only the name of the topic can be updated. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. - [Delete User Api Key](https://docs.trieve.ai/api-reference/user/delete-user-api-key.md): Delete an api key for the auth'ed user. - [Get User Api Keys](https://docs.trieve.ai/api-reference/user/get-user-api-keys.md): Get the api keys which belong to the auth'ed user. The actual api key values are not returned, only the ids, names, and creation dates. - [Update User Org Role](https://docs.trieve.ai/api-reference/user/update-user-org-role.md): Update a user's information for the org specified via header. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the role of the auth'ed user or api key must be an admin (1) or owner (2) of the organization. - [Build Search for Ecommerce](https://docs.trieve.ai/examples/ecommerce.md): Learn how to build a job board with Trieve - [Build Search for a Job Board](https://docs.trieve.ai/examples/job-board.md): Learn how to build a job board with Trieve - [Introduction](https://docs.trieve.ai/getting-started/introduction.md): Trieve is an API for building search, and RAG experiences. - [Quickstart](https://docs.trieve.ai/getting-started/quickstart.md): Quickly start building search, recommendations, and RAG for your application with Trieve - [Screenshots](https://docs.trieve.ai/getting-started/screenshots.md): Screenshots of Trieve in action across various use cases. - [Trieve Primitives](https://docs.trieve.ai/getting-started/trieve-primitives.md): Basic terms and concepts used commonly within the Trieve ecosystem. - [RAG with Trieve](https://docs.trieve.ai/guides/RAG-with-trieve.md): Learn how to chat with your data with Trieve - [Analytics with Trieve](https://docs.trieve.ai/guides/analytics-quickstart.md): Learn how to get started with Trieve Analytics - [Uploading Chunks to Trieve](https://docs.trieve.ai/guides/create-chunk.md): Learn how to upload your chunks to Trieve - [Crawling Websites with Trieve](https://docs.trieve.ai/guides/dataset-crawls.md): Learn how to how use the crawl functionality within Trieve - [Using Groups with Trieve](https://docs.trieve.ai/guides/group-with-trieve.md): Learn how to create and use groups with Trieve - [Setup Image Search](https://docs.trieve.ai/guides/image-search-setup.md): Learn how to setup image search with Trieve - [Multi-tenant applications with Trieve](https://docs.trieve.ai/guides/multi-tenency.md): Learn how to structure your data for multi-tenant applications with Trieve - [Recommending with Trieve](https://docs.trieve.ai/guides/recommending-with-trieve.md): Learn how to recommend content with Trieve - [Searching with Trieve](https://docs.trieve.ai/guides/searching-with-trieve.md): Learn how to search over your data with Trieve - [Uploading CSV and JSONL Files to Trieve](https://docs.trieve.ai/guides/uploading-csv-and-jsonl-files.md): Learn how to upload bulk structured data to Trieve - [Uploading Files to Trieve](https://docs.trieve.ai/guides/uploading-files.md): Learn how to upload your files to Trieve - [Using Exposed API keys with Trieve](https://docs.trieve.ai/guides/using-exposed-api-keys.md): Learn how to create and use safe, access controlled api keys with Trieve - [Setup Voice Search](https://docs.trieve.ai/guides/voice-search-setup.md): Learn how to setup voice search with Trieve - [AWS Self Hosting](https://docs.trieve.ai/self-hosting/aws.md): Learn how to self-host Trieve on AWS - [Azure Self Hosting](https://docs.trieve.ai/self-hosting/azure.md): Learn how to self-host Trieve on Azure - [Docker Compose Setup](https://docs.trieve.ai/self-hosting/docker-compose.md): Learn how to self-host Trieve with Docker Compose - [GCP Self Hosting](https://docs.trieve.ai/self-hosting/gcp.md): Learn how to self-host Trieve on Google Cloud Platform - [SiteSearch Content Sites Guide](https://docs.trieve.ai/site-search/content-sites.md): Step by step guide on setting up a scrape of any help center, blog, or content site, configuring the web component, and adding the script tag to your site. - [SiteSearch Ecommerce Guide](https://docs.trieve.ai/site-search/ecommerce.md): Step by step guide on setting up a scrape of any shopify store, configuring the web component, and adding the script tag to your site. - [Introduction](https://docs.trieve.ai/site-search/introduction.md) - [SiteSearch Youtube Channels Guide](https://docs.trieve.ai/site-search/youtube-channels.md): Step by step guide on setting up a scrape of any Youtube channel, configuring the web component, and adding the script tag to your site. - [Architecture Diagram](https://docs.trieve.ai/vector-inference/architecture.md): Breakdown of all the services installed within Trieve Vector Inference - [AWS Installation](https://docs.trieve.ai/vector-inference/aws-installation.md): Install Trieve Vector Inference in your own AWS account - [Using Custom Models](https://docs.trieve.ai/vector-inference/dense.md): How to use gated or private models hosted on Hugging Face - [Create Embedding](https://docs.trieve.ai/vector-inference/embed.md): Get embeddings. Returns a 424 status code if the model is not an embedding model - [Create Embedding](https://docs.trieve.ai/vector-inference/embed_all.md): Get embeddings. Returns a 424 status code if the model is not an embedding model - [Create Sparse Embedding](https://docs.trieve.ai/vector-inference/embed_sparse.md): Get sparse embeddings. Returns a 424 status code if the model is not a SPLADE embedding model - [Health Check](https://docs.trieve.ai/vector-inference/health_check.md): Check if the service is alive. - [Introduction](https://docs.trieve.ai/vector-inference/introduction.md): Trieve Vector Inference is an on-prem solution for fast vector inference - [Using OpenAI SDK](https://docs.trieve.ai/vector-inference/openai.md): How to integrate TVI with existing OpenAI compatible endpoints - [OpenAI compatible embeddings route](https://docs.trieve.ai/vector-inference/openai_compat.md): OpenAI compatible route. Returns a 424 status code if the model is not an embedding model. - [Pricing](https://docs.trieve.ai/vector-inference/pricing.md): The pricing design Trieve Vector Inference - [Working with Reranker](https://docs.trieve.ai/vector-inference/rerank.md) - [Get Ranks](https://docs.trieve.ai/vector-inference/reranker.md): Runs Reranker. Returns a 424 status code if the model is not a Reranker model. - [Working with SPLADE v2](https://docs.trieve.ai/vector-inference/splade.md): Learn how to use SPLADE with TVI. - [Troubleshooting](https://docs.trieve.ai/vector-inference/troubleshooting.md): Common issues with self hosting - [Upgrading your Instance](https://docs.trieve.ai/vector-inference/upgrading.md): For any updates to Trieve Vector Inference, this is how you should upgrade: ## OpenAPI Specs - [openapi](https://beta-api.trieve.ai/api-docs/openapi.json) ## Optional - [TypeScript SDK](https://ts-sdk.trieve.ai) - [Github](https://github.com/devflowinc/trieve) - [Community](https://discord.com/invite/E9sPRZqpDT) - [Blog](https://trieve.ai/blog) - [System Status](https://status.trieve.ai)