Task
Explore Trieve API Documentation and Quickstart
As a prospective developer, I understand how to integrate the Trieve API and upload files, so that I can utilize Trieve's capabilities to enhance my application with advanced search and recommendation features.
Success definition: Given I am on the Trieve API Documentation When I click on the 'Quickstart' link and then proceed to the 'Uploading Files to Trieve' section Then I should see a detailed guide that provides step-by-step instructions on getting started with the Trieve API, including how to upload files effectively.
Trajectory
Step 1:
Url (before/after):
https://trieve.ai/
https://docs.trieve.ai/getting-started/introduction
Content (before/after):
RootWebArea AI-First infrastructure API for search, recommendations, and RAG that combines language models with tools for fine tuning ranking and relevance, focused, url='https://trieve.ai/'
StaticText Source Available
[46] link See the code on Github! », center=(204,20), url='https://github.com/devflowinc/trieve'
banner
[50] link Trieve logo Trieve, center=(397,88), inner_text= Trieve, url='https://trieve.ai/'
Show more
image Trieve logo, url='https://cdn.trieve.ai/trieve-logo.png'
navigation Main navigation
list
listitem
[56] link API Documentation, center=(590,88), url='https://docs.trieve.ai/'
listitem
[58] link Pricing, center=(700,88), url='https://trieve.ai/pricing'
listitem
[60] link Sitesearch, center=(777,88), url='https://trieve.ai/sitesearch'
listitem
[62] link Blog, center=(846,88), url='https://trieve.ai/blog'
[67] button, center=(1299,88), type=button
image
[71] link Login, center=(1356,88), url='https://dashboard.trieve.ai/'
[72] link Get a demo, center=(1449,88), url='https://trieve.ai/request-demo'
[73] link Sign up, center=(1549,88), url='https://dashboard.trieve.ai/'
main
heading AI search for the modern world
paragraph
StaticText We help companies build unfair competitive advantages through their discovery experiences
[102] link Get Started Free, center=(853,367), url='https://dashboard.trieve.ai/'
image
[105] link Request a demo, center=(1069,367), url='https://trieve.ai/request-demo'
image
[109] button Search, center=(677,470)
[112] button AI Chat, center=(800,470)
[115] button Recommendations, center=(966,469)
[118] button Analytics, center=(1138,470)
[121] button API, center=(1256,470)
[131] link Recommendations, center=(960,853), url='https://trieve.ai/request-demo'
image Recommendations, url='https://cdn.trieve.ai/landing-tabs/recommendations.webp'
heading Powering 30,000+ discovery experiences across categories
image, url='https://cdn.trieve.ai/customer-logos/mintlify-logo.svg'
image, url='https://cdn.trieve.ai/customer-logos/vapi-logo.png'
image, url='https://cdn.trieve.ai/customer-logos/guardant-health-logo.svg'
image, url='https://cdn.trieve.ai/customer-logos/bestway-logo.png'
image, url='https://cdn.trieve.ai/customer-logos/signoz-logo.svg'
image, url='https://cdn.trieve.ai/customer-logos/parcelhero.webp'
image, url='https://cdn.trieve.ai/customer-logos/billtrack50logo.svg'
image, url='https://cdn.trieve.ai/customer-logos/hostai-logo.webp'
image, url='https://cdn.trieve.ai/customer-logos/openmart-logo.svg'
image, url='https://cdn.trieve.ai/customer-logos/agentic-labs-logo.png'
paragraph
StaticText END-TO-END
heading Trieve Coordinates, You Scale
paragraph
StaticText Billion-scale search, discovery, and RAG experiences within the same API
image
heading Semantic Vector Search
paragraph
StaticText For when you need more than just full-text search. Trieve supports semantic vector search out of the box.
image
heading BM25 & SPLADE Full-Text Search
paragraph
StaticText Choose between the leading state-of-the-art retrieval models for full-text search.
image
heading Stock and Custom Embedding models
paragraph
StaticText Our modular infrastructure offers several models and bring your own embedding model.
image
heading Hybrid Search
paragraph
StaticText Get the best of both worlds. Trieve supports hybrid search, combining full-text search and semantic vector search with cross-encoder re-ranker models.
image
heading Merchandising & Relevance tuning
paragraph
StaticText Tune and boost search results to hit your KPIs via the API or no-code dashboard.
image
heading Sub-sentence Highlighting
paragraph
StaticText Search results can get long. Sub-sentence highlights show users exactly what they are looking for, quick.
paragraph
StaticText BUILD FAST AND DON'T BREAK THINGS
heading Manage ingestion, embeddings and analytics with ease
heading Built on the best foundations
StaticText We help companies build unfair competitive advantages through their search, discovery, and RAG experiences
image
heading Private Open-Source Models
paragraph
StaticText We use open source embedding models and LLMs running in our own servers. Data is never leaked.
image
heading Batteries Included
paragraph
StaticText Our API surface covers chunking, ingestion, search, recommendations, RAG, and even a little front-end.
image
heading Self-Hostable
paragraph
StaticText Sensitive data? Need maximum performance? Host Trieve yourself with terraform templates and no external dependencies.
heading Set up industry-leading search in 30 minutes
image
paragraph
StaticText Step 1:
StaticText Add Existing Data
paragraph
StaticText Upload individual chunks or entire documents that get chunked by our algorithms via our API or no-code dashboard.
image
paragraph
StaticText Step 2:
StaticText Integrate our API
paragraph
StaticText Add calls to our API on your create and update routes to keep your data current.
image
paragraph
StaticText Step 3:
StaticText Search, Recommend, or Generate
paragraph
StaticText Test and tune search, recommendations, and chat quality with our search playground, then integrate the API calls into your product.
image
paragraph
StaticText Ready!
image Steps to use, url='https://cdn.trieve.ai/db-4-square.png'
heading Take control of your search.
paragraph
StaticText AI-native, end-to-end, self-hostable API for the trends of today and tomorrow
link Get Started Free, url='https://dashboard.trieve.ai/'
image
link Request a demo, url='https://trieve.ai/request-demo'
image
contentinfo
link Trieve, url='https://trieve.ai/'
StaticText Support
list
listitem
link Docs, url='https://docs.trieve.ai/'
listitem
link Matrix, url='https://matrix.to/#/#trieve-general:trieve.ai'
listitem
link Discord, url='https://discord.gg/E9sPRZqpDT'
listitem
link +1 628-222-4090, url='tel:+16282224090'
listitem
link humans@trieve.ai, url='mailto:humans@trieve.ai'
StaticText Company
list
listitem
link About, url='https://trieve.ai/about'
listitem
link Admin Dashboard, url='https://dashboard.trieve.ai/'
listitem
link Privacy Policy, url='https://trieve.ai/legal/privacy-policy'
listitem
link GitHub, url='https://github.com/devflowinc/trieve'
StaticText Product
list
listitem
link Pricing, url='https://trieve.ai/pricing'
listitem
link Developer Documentation, url='https://docs.trieve.ai/'
listitem
link Typescript SDK, url='https://ts-sdk.trieve.ai/'
listitem
link HN Search Engine, url='https://hn.trieve.ai/'
StaticText Comparisons
list
listitem
link vs Algolia, url='https://trieve.ai/trieve-vs-algolia'
list
button Toggle between Dark and Light mode
image
listitem
link X, url='https://x.com/trieveai'
image
listitem
link GitHub, url='https://github.com/devflowinc/trieve'
image
listitem
link Matrix, url='https://matrix.to/#/#trieve-general:trieve.ai'
image
listitem
link Discord, url='https://discord.gg/E9sPRZqpDT'
image
listitem
link RSS Feed, url='https://trieve.ai/rss.xml'
image
RootWebArea Introduction - Trieve, focused, url='https://docs.trieve.ai/getting-started/introduction'
main
[66] link Trieve home page light logo, center=(345,32), inner_text=Trieve home page, url='https://trieve.ai/'
image light logo, url='https://mintlify.s3.us-west-1.amazonaws.com/trieve/icons/trieve-logo.png'
[72] button Search or ask... Ctrl K, center=(960,32), inner_text=Search or ask...
Show more
Ctrl K, type=button
image
navigation
list
listitem
[94] link Support, center=(1292,31), url='mailto:humans@trieve.ai'
listitem
[96] link Dashboard, center=(1382,31), url='https://dashboard.trieve.ai/'
listitem
[98] link devflowinc/trieve 1789 155, center=(1522,32), inner_text=devflowinc/trieve
1789
155, url='https://github.com/devflowinc/trieve'
image
StaticText devflowinc
StaticText /
StaticText trieve
image
StaticText 1789
image
StaticText 155
[111] button Toggle dark mode, center=(1632,32)
image
[131] link Documentation, center=(326,88), url='https://docs.trieve.ai/getting-started/introduction'
[133] link API Reference, center=(454,88), url='https://docs.trieve.ai/api-reference/chunk/create-or-upsert-chunk-or-chunks'
[135] link Vector Inference, center=(586,88), url='https://docs.trieve.ai/vector-inference/introduction'
[137] link Site Search, center=(708,88), url='https://docs.trieve.ai/site-search/introduction'
[146] link TypeScript SDK, center=(384,158), url='https://ts-sdk.trieve.ai/'
image
[150] link Python SDK, center=(384,198), url='https://pypi.org/project/trieve-py-client/'
image
[154] link Github, center=(384,238), url='https://github.com/devflowinc/trieve'
image
[158] link Community, center=(384,278), url='https://discord.com/invite/E9sPRZqpDT'
image
[162] link Blog, center=(384,318), url='https://trieve.ai/blog'
image
heading Get Started
list
listitem
[169] link Introduction, center=(384,414), url='https://docs.trieve.ai/getting-started/introduction'
listitem
[173] link Quickstart, center=(384,450), url='https://docs.trieve.ai/getting-started/quickstart'
listitem
[177] link Trieve Primitives, center=(384,486), url='https://docs.trieve.ai/getting-started/trieve-primitives'
listitem
[181] link Screenshots, center=(384,522), url='https://docs.trieve.ai/getting-started/screenshots'
heading Self Hosting
list
listitem
[188] link Docker Compose Setup, center=(384,624), url='https://docs.trieve.ai/self-hosting/docker-compose'
image
listitem
[193] link Local Kubernetes Setup, center=(384,660), url='https://docs.trieve.ai/self-hosting/local-kube'
image
listitem
[198] link AWS Self Hosting, center=(384,696), url='https://docs.trieve.ai/self-hosting/aws'
image
listitem
[203] link GCP Self Hosting, center=(384,732), url='https://docs.trieve.ai/self-hosting/gcp'
image
listitem
[208] link Azure, center=(384,768), url='https://docs.trieve.ai/self-hosting/azure'
heading Guides
list
listitem
[215] link Uploading Chunks to Trieve, center=(384,870), url='https://docs.trieve.ai/guides/create-chunk'
image
listitem
[220] link Uploading Files to Trieve, center=(384,906), url='https://docs.trieve.ai/guides/uploading-files'
image
listitem
[225] link Uploading CSV and JSONL Files to Trieve, center=(384,954), url='https://docs.trieve.ai/guides/uploading-csv-and-jsonl-files'
image
listitem
[230] link Searching with Trieve, center=(384,1002), url='https://docs.trieve.ai/guides/searching-with-trieve'
image
listitem
[235] link Recommending with Trieve, center=(384,1038), url='https://docs.trieve.ai/guides/recommending-with-trieve'
image
listitem
[240] link RAG with Trieve, center=(384,1074), url='https://docs.trieve.ai/guides/RAG-with-trieve'
image
listitem
link Analytics with Trieve, url='https://docs.trieve.ai/guides/analytics-quickstart'
image
listitem
link Creating Organizations and Datasets with Trieve, url='https://docs.trieve.ai/guides/create-organizations-and-dataset'
image
listitem
link Using Groups with Trieve, url='https://docs.trieve.ai/guides/group-with-trieve'
image
listitem
link Using Exposed API keys with Trieve, url='https://docs.trieve.ai/guides/using-exposed-api-keys'
image
heading Examples
list
listitem
link Build Search for a Job Board, url='https://docs.trieve.ai/examples/job-board'
image
listitem
link Build Search for Ecommerce, url='https://docs.trieve.ai/examples/ecommerce'
image
StaticText Get Started
heading Introduction
paragraph
StaticText Trieve is an API for building search, recommendations, and RAG experiences.
heading Navigate to header Quick Start
[292] link Navigate to header, center=(567,304), inner_text=, url='https://docs.trieve.ai/getting-started/introduction#quick-start'
StaticText
image
[297] link API Reference Check out the API Reference to see all of the available endpoints and options for integrating Trieve into your application., center=(763,435), inner_text=API Reference
Check out the API Reference to see all of the available endpoints and options for integrating Trieve into your application., url='https://docs.trieve.ai/api-reference'
image
heading API Reference
paragraph
StaticText Check out the API Reference to see all of the available endpoints and options for integrating Trieve into your application.
[295] span, center=(649,304), inner_text=Quick Start
[305] link Getting Started Get started with Trieve quickly., center=(1132,435), inner_text=Getting Started
Get started with Trieve quickly., url='https://docs.trieve.ai/getting-started/quickstart'
image
heading Getting Started
paragraph
StaticText Get started with Trieve quickly.
[313] link Build Search for a Job Board Learn how to build a search experience for a job board using Trieve., center=(763,621), inner_text=Build Search for a Job Board
Learn how to build a search experience for a job board using Trieve., url='https://docs.trieve.ai/examples/job-board'
image
heading Build Search for a Job Board
paragraph
StaticText Learn how to build a search experience for a job board using Trieve.
[321] link Build Search for Ecommerce Learn how to build a search experience for an ecommerce platform using Trieve., center=(1132,621), inner_text=Build Search for Ecommerce
Learn how to build a search experience for an ecommerce platform using Trieve., url='https://docs.trieve.ai/examples/ecommerce'
image
heading Build Search for Ecommerce
paragraph
StaticText Learn how to build a search experience for an ecommerce platform using Trieve.
paragraph
StaticText Search and RAG are powerful primitives, but can take months to implement and deploy in production. Trieve abstracts away the complexity of these tasks, allowing you to focus on building your product.
paragraph
StaticText With Trieve, you can build and deploy a ChatGPT like experience or a search engine on your data in a matter of hours.
heading Navigate to header Demos of Trieve in Action
[333] link Navigate to header, center=(567,950), inner_text=, url='https://docs.trieve.ai/getting-started/introduction#demos-of-trieve-in-action'
StaticText
image
heading Hackernews
[336] span, center=(705,950), inner_text=Demos of Trieve in Action
paragraph
image, url='https://trieve.b-cdn.net/docs/hackernews-search.png'
button Expand image
heading YCombinator Companies
paragraph
image, url='https://trieve.b-cdn.net/docs/yc-search.png'
button Expand image
list
listitem
link Trieve HN Discovery, url='https://hn.trieve.ai/'
list
listitem
link 📝 Launching Trieve HN Discovery - A Discovery Focused Search Engine for Hacker News, url='https://trieve.ai/launching-trieve-hn-discovery/'
listitem
link YCombinator Companies Search, url='https://yc.trieve.ai/'
list
listitem
link 📝 Building Search For the YC Company Directory With Trieve, Bun, and SolidJS, url='https://trieve.ai/building-search-for-yc-company-directory/'
listitem
link SteamDB Search, url='https://steamdb.trieve.ai/'
list
listitem
link 📝 Introducing Yet Another Steam Recommendation Engine!, url='https://trieve.ai/steam-recommendations'
listitem
strong
StaticText This documentation site itself!
StaticText (and all Mintlify documentation sites)
list
listitem
link 📝 Success Story: Mintlify, url='https://trieve.ai/success-story-mintlify/'
paragraph
StaticText If you are interested in a managed instance and/or SLA, reach out to us by emailing
link humans@trieve.ai, url='mailto:humans@trieve.ai'
StaticText .
paragraph
StaticText To engage with the Trieve community, join our our
link Discord, url='https://discord.com/invite/E9sPRZqpDT'
StaticText .
heading Navigate to header Client Libraries
link Navigate to header, url='https://docs.trieve.ai/getting-started/introduction#client-libraries'
StaticText
image
list
listitem
link Trieve TypeScript/JavaScript Client, url='https://ts-sdk.trieve.ai/'
listitem
link Trieve Python Client, url='https://pypi.org/project/trieve-py-client/'
heading Navigate to header System Diagram
link Navigate to header, url='https://docs.trieve.ai/getting-started/introduction#system-diagram'
StaticText
image
paragraph
StaticText Services in blue are horizontally scalable and can be run in a distributed manner.
paragraph
image trieve-system-diagram, url='https://cdn.trieve.ai/docs/Trieve-System-Diagram.webp'
button Expand image: trieve-system-diagram
link Quickstart, url='https://docs.trieve.ai/getting-started/quickstart'
image
link x, url='https://x.com/trieveai'
image
link discord, url='https://discord.gg/eBJXXZDB8z'
image
link github, url='https://github.com/devflowinc'
image
link linkedin, url='https://www.linkedin.com/company/trieveai'
image
link website, url='https://trieve.ai/'
image
link Powered by Mintlify, url='https://mintlify.com/preview-request?utm_campaign=poweredBy&utm_medium=docs&utm_source=docs.trieve.ai'
image
StaticText On this page
list
listitem
[444] link Quick Start, center=(1532,200), url='https://docs.trieve.ai/getting-started/introduction#quick-start'
listitem
[446] link Demos of Trieve in Action, center=(1540,232), url='https://docs.trieve.ai/getting-started/introduction#demos-of-trieve-in-action'
listitem
[448] link Client Libraries, center=(1540,264), url='https://docs.trieve.ai/getting-started/introduction#client-libraries'
listitem
[450] link System Diagram, center=(1540,296), url='https://docs.trieve.ai/getting-started/introduction#system-diagram'
alert, atomic
Reasoning for action: By clicking on the API Documentation link, I am navigating to the section of the website that contains detailed information about the Trieve API. This action is crucial because it sets the stage for accessing the 'Quickstart' guide and the 'Uploading Files to Trieve' section, which are essential to meet the user's requirements for learning how to effectively integrate and use the API.
Action: click(56) # Click on the API Documentation link to explore the API features.
Change Description: After clicking the 'API Documentation' link, the browser navigated to a new page titled 'Introduction - Trieve', displaying a comprehensive overview of the documentation, including links to various sections such as Getting Started, API Reference, and examples for building applications with Trieve.
Screenshot before:Screenshot after:---
Step 2:
Url (before/after):
https://docs.trieve.ai/getting-started/introduction
https://docs.trieve.ai/getting-started/quickstart
Content (before/after):
RootWebArea Introduction - Trieve, focused, url='https://docs.trieve.ai/getting-started/introduction'
main
[66] link Trieve home page light logo, center=(345,32), inner_text=Trieve home page, url='https://trieve.ai/'
image light logo, url='https://mintlify.s3.us-west-1.amazonaws.com/trieve/icons/trieve-logo.png'
[72] button Search or ask... Ctrl K, center=(960,32), inner_text=Search or ask...
Show more
Ctrl K, type=button
image
navigation
list
listitem
[94] link Support, center=(1292,31), url='mailto:humans@trieve.ai'
listitem
[96] link Dashboard, center=(1382,31), url='https://dashboard.trieve.ai/'
listitem
[98] link devflowinc/trieve 1789 155, center=(1522,32), inner_text=devflowinc/trieve
1789
155, url='https://github.com/devflowinc/trieve'
image
StaticText devflowinc
StaticText /
StaticText trieve
image
StaticText 1789
image
StaticText 155
[111] button Toggle dark mode, center=(1632,32)
image
[131] link Documentation, center=(326,88), url='https://docs.trieve.ai/getting-started/introduction'
[133] link API Reference, center=(454,88), url='https://docs.trieve.ai/api-reference/chunk/create-or-upsert-chunk-or-chunks'
[135] link Vector Inference, center=(586,88), url='https://docs.trieve.ai/vector-inference/introduction'
[137] link Site Search, center=(708,88), url='https://docs.trieve.ai/site-search/introduction'
[146] link TypeScript SDK, center=(384,158), url='https://ts-sdk.trieve.ai/'
image
[150] link Python SDK, center=(384,198), url='https://pypi.org/project/trieve-py-client/'
image
[154] link Github, center=(384,238), url='https://github.com/devflowinc/trieve'
image
[158] link Community, center=(384,278), url='https://discord.com/invite/E9sPRZqpDT'
image
[162] link Blog, center=(384,318), url='https://trieve.ai/blog'
image
heading Get Started
list
listitem
[169] link Introduction, center=(384,414), url='https://docs.trieve.ai/getting-started/introduction'
listitem
[173] link Quickstart, center=(384,450), url='https://docs.trieve.ai/getting-started/quickstart'
listitem
[177] link Trieve Primitives, center=(384,486), url='https://docs.trieve.ai/getting-started/trieve-primitives'
listitem
[181] link Screenshots, center=(384,522), url='https://docs.trieve.ai/getting-started/screenshots'
heading Self Hosting
list
listitem
[188] link Docker Compose Setup, center=(384,624), url='https://docs.trieve.ai/self-hosting/docker-compose'
image
listitem
[193] link Local Kubernetes Setup, center=(384,660), url='https://docs.trieve.ai/self-hosting/local-kube'
image
listitem
[198] link AWS Self Hosting, center=(384,696), url='https://docs.trieve.ai/self-hosting/aws'
image
listitem
[203] link GCP Self Hosting, center=(384,732), url='https://docs.trieve.ai/self-hosting/gcp'
image
listitem
[208] link Azure, center=(384,768), url='https://docs.trieve.ai/self-hosting/azure'
heading Guides
list
listitem
[215] link Uploading Chunks to Trieve, center=(384,870), url='https://docs.trieve.ai/guides/create-chunk'
image
listitem
[220] link Uploading Files to Trieve, center=(384,906), url='https://docs.trieve.ai/guides/uploading-files'
image
listitem
[225] link Uploading CSV and JSONL Files to Trieve, center=(384,954), url='https://docs.trieve.ai/guides/uploading-csv-and-jsonl-files'
image
listitem
[230] link Searching with Trieve, center=(384,1002), url='https://docs.trieve.ai/guides/searching-with-trieve'
image
listitem
[235] link Recommending with Trieve, center=(384,1038), url='https://docs.trieve.ai/guides/recommending-with-trieve'
image
listitem
[240] link RAG with Trieve, center=(384,1074), url='https://docs.trieve.ai/guides/RAG-with-trieve'
image
listitem
link Analytics with Trieve, url='https://docs.trieve.ai/guides/analytics-quickstart'
image
listitem
link Creating Organizations and Datasets with Trieve, url='https://docs.trieve.ai/guides/create-organizations-and-dataset'
image
listitem
link Using Groups with Trieve, url='https://docs.trieve.ai/guides/group-with-trieve'
image
listitem
link Using Exposed API keys with Trieve, url='https://docs.trieve.ai/guides/using-exposed-api-keys'
image
heading Examples
list
listitem
link Build Search for a Job Board, url='https://docs.trieve.ai/examples/job-board'
image
listitem
link Build Search for Ecommerce, url='https://docs.trieve.ai/examples/ecommerce'
image
StaticText Get Started
heading Introduction
paragraph
StaticText Trieve is an API for building search, recommendations, and RAG experiences.
heading Navigate to header Quick Start
[292] link Navigate to header, center=(567,304), inner_text=, url='https://docs.trieve.ai/getting-started/introduction#quick-start'
StaticText
image
[297] link API Reference Check out the API Reference to see all of the available endpoints and options for integrating Trieve into your application., center=(763,435), inner_text=API Reference
Check out the API Reference to see all of the available endpoints and options for integrating Trieve into your application., url='https://docs.trieve.ai/api-reference'
image
heading API Reference
paragraph
StaticText Check out the API Reference to see all of the available endpoints and options for integrating Trieve into your application.
[295] span, center=(649,304), inner_text=Quick Start
[305] link Getting Started Get started with Trieve quickly., center=(1132,435), inner_text=Getting Started
Get started with Trieve quickly., url='https://docs.trieve.ai/getting-started/quickstart'
image
heading Getting Started
paragraph
StaticText Get started with Trieve quickly.
[313] link Build Search for a Job Board Learn how to build a search experience for a job board using Trieve., center=(763,621), inner_text=Build Search for a Job Board
Learn how to build a search experience for a job board using Trieve., url='https://docs.trieve.ai/examples/job-board'
image
heading Build Search for a Job Board
paragraph
StaticText Learn how to build a search experience for a job board using Trieve.
[321] link Build Search for Ecommerce Learn how to build a search experience for an ecommerce platform using Trieve., center=(1132,621), inner_text=Build Search for Ecommerce
Learn how to build a search experience for an ecommerce platform using Trieve., url='https://docs.trieve.ai/examples/ecommerce'
image
heading Build Search for Ecommerce
paragraph
StaticText Learn how to build a search experience for an ecommerce platform using Trieve.
paragraph
StaticText Search and RAG are powerful primitives, but can take months to implement and deploy in production. Trieve abstracts away the complexity of these tasks, allowing you to focus on building your product.
paragraph
StaticText With Trieve, you can build and deploy a ChatGPT like experience or a search engine on your data in a matter of hours.
heading Navigate to header Demos of Trieve in Action
[333] link Navigate to header, center=(567,950), inner_text=, url='https://docs.trieve.ai/getting-started/introduction#demos-of-trieve-in-action'
StaticText
image
heading Hackernews
[336] span, center=(705,950), inner_text=Demos of Trieve in Action
paragraph
image, url='https://trieve.b-cdn.net/docs/hackernews-search.png'
button Expand image
heading YCombinator Companies
paragraph
image, url='https://trieve.b-cdn.net/docs/yc-search.png'
button Expand image
list
listitem
link Trieve HN Discovery, url='https://hn.trieve.ai/'
list
listitem
link 📝 Launching Trieve HN Discovery - A Discovery Focused Search Engine for Hacker News, url='https://trieve.ai/launching-trieve-hn-discovery/'
listitem
link YCombinator Companies Search, url='https://yc.trieve.ai/'
list
listitem
link 📝 Building Search For the YC Company Directory With Trieve, Bun, and SolidJS, url='https://trieve.ai/building-search-for-yc-company-directory/'
listitem
link SteamDB Search, url='https://steamdb.trieve.ai/'
list
listitem
link 📝 Introducing Yet Another Steam Recommendation Engine!, url='https://trieve.ai/steam-recommendations'
listitem
strong
StaticText This documentation site itself!
StaticText (and all Mintlify documentation sites)
list
listitem
link 📝 Success Story: Mintlify, url='https://trieve.ai/success-story-mintlify/'
paragraph
StaticText If you are interested in a managed instance and/or SLA, reach out to us by emailing
link humans@trieve.ai, url='mailto:humans@trieve.ai'
StaticText .
paragraph
StaticText To engage with the Trieve community, join our our
link Discord, url='https://discord.com/invite/E9sPRZqpDT'
StaticText .
heading Navigate to header Client Libraries
link Navigate to header, url='https://docs.trieve.ai/getting-started/introduction#client-libraries'
StaticText
image
list
listitem
link Trieve TypeScript/JavaScript Client, url='https://ts-sdk.trieve.ai/'
listitem
link Trieve Python Client, url='https://pypi.org/project/trieve-py-client/'
heading Navigate to header System Diagram
link Navigate to header, url='https://docs.trieve.ai/getting-started/introduction#system-diagram'
StaticText
image
paragraph
StaticText Services in blue are horizontally scalable and can be run in a distributed manner.
paragraph
image trieve-system-diagram, url='https://cdn.trieve.ai/docs/Trieve-System-Diagram.webp'
button Expand image: trieve-system-diagram
link Quickstart, url='https://docs.trieve.ai/getting-started/quickstart'
image
link x, url='https://x.com/trieveai'
image
link discord, url='https://discord.gg/eBJXXZDB8z'
image
link github, url='https://github.com/devflowinc'
image
link linkedin, url='https://www.linkedin.com/company/trieveai'
image
link website, url='https://trieve.ai/'
image
link Powered by Mintlify, url='https://mintlify.com/preview-request?utm_campaign=poweredBy&utm_medium=docs&utm_source=docs.trieve.ai'
image
StaticText On this page
list
listitem
[444] link Quick Start, center=(1532,200), url='https://docs.trieve.ai/getting-started/introduction#quick-start'
listitem
[446] link Demos of Trieve in Action, center=(1540,232), url='https://docs.trieve.ai/getting-started/introduction#demos-of-trieve-in-action'
listitem
[448] link Client Libraries, center=(1540,264), url='https://docs.trieve.ai/getting-started/introduction#client-libraries'
listitem
[450] link System Diagram, center=(1540,296), url='https://docs.trieve.ai/getting-started/introduction#system-diagram'
alert, atomic
RootWebArea Quickstart - Trieve, focused, url='https://docs.trieve.ai/getting-started/quickstart'
main
[66] link Trieve home page light logo, center=(345,32), inner_text=Trieve home page, url='https://trieve.ai/'
image light logo, url='https://mintlify.s3.us-west-1.amazonaws.com/trieve/icons/trieve-logo.png'
[72] button Search or ask... Ctrl K, center=(960,32), inner_text=Search or ask...
Show more
Ctrl K, type=button
image
navigation
list
listitem
[94] link Support, center=(1292,31), url='mailto:humans@trieve.ai'
listitem
[96] link Dashboard, center=(1382,31), url='https://dashboard.trieve.ai/'
listitem
[98] link devflowinc/trieve 1789 155, center=(1522,32), inner_text=devflowinc/trieve
1789
155, url='https://github.com/devflowinc/trieve'
image
StaticText devflowinc
StaticText /
StaticText trieve
image
StaticText 1789
image
StaticText 155
[111] button Toggle dark mode, center=(1632,32)
image
[131] link Documentation, center=(326,88), url='https://docs.trieve.ai/getting-started/introduction'
[133] link API Reference, center=(454,88), url='https://docs.trieve.ai/api-reference/chunk/create-or-upsert-chunk-or-chunks'
[135] link Vector Inference, center=(586,88), url='https://docs.trieve.ai/vector-inference/introduction'
[137] link Site Search, center=(708,88), url='https://docs.trieve.ai/site-search/introduction'
[146] link TypeScript SDK, center=(384,158), url='https://ts-sdk.trieve.ai/'
image
[150] link Python SDK, center=(384,198), url='https://pypi.org/project/trieve-py-client/'
image
[154] link Github, center=(384,238), url='https://github.com/devflowinc/trieve'
image
[158] link Community, center=(384,278), url='https://discord.com/invite/E9sPRZqpDT'
image
[162] link Blog, center=(384,318), url='https://trieve.ai/blog'
image
heading Get Started
list
listitem
[169] link Introduction, center=(384,414), url='https://docs.trieve.ai/getting-started/introduction'
listitem
[173] link Quickstart, center=(384,450), focused, url='https://docs.trieve.ai/getting-started/quickstart'
listitem
[177] link Trieve Primitives, center=(384,486), url='https://docs.trieve.ai/getting-started/trieve-primitives'
listitem
[181] link Screenshots, center=(384,522), url='https://docs.trieve.ai/getting-started/screenshots'
heading Self Hosting
list
listitem
[188] link Docker Compose Setup, center=(384,624), url='https://docs.trieve.ai/self-hosting/docker-compose'
image
listitem
[193] link Local Kubernetes Setup, center=(384,660), url='https://docs.trieve.ai/self-hosting/local-kube'
image
listitem
[198] link AWS Self Hosting, center=(384,696), url='https://docs.trieve.ai/self-hosting/aws'
image
listitem
[203] link GCP Self Hosting, center=(384,732), url='https://docs.trieve.ai/self-hosting/gcp'
image
listitem
[208] link Azure, center=(384,768), url='https://docs.trieve.ai/self-hosting/azure'
heading Guides
list
listitem
[215] link Uploading Chunks to Trieve, center=(384,870), url='https://docs.trieve.ai/guides/create-chunk'
image
listitem
[220] link Uploading Files to Trieve, center=(384,906), url='https://docs.trieve.ai/guides/uploading-files'
image
listitem
[225] link Uploading CSV and JSONL Files to Trieve, center=(384,954), url='https://docs.trieve.ai/guides/uploading-csv-and-jsonl-files'
image
listitem
[230] link Searching with Trieve, center=(384,1002), url='https://docs.trieve.ai/guides/searching-with-trieve'
image
listitem
[235] link Recommending with Trieve, center=(384,1038), url='https://docs.trieve.ai/guides/recommending-with-trieve'
image
listitem
[240] link RAG with Trieve, center=(384,1074), url='https://docs.trieve.ai/guides/RAG-with-trieve'
image
listitem
link Analytics with Trieve, url='https://docs.trieve.ai/guides/analytics-quickstart'
image
listitem
link Creating Organizations and Datasets with Trieve, url='https://docs.trieve.ai/guides/create-organizations-and-dataset'
image
listitem
link Using Groups with Trieve, url='https://docs.trieve.ai/guides/group-with-trieve'
image
listitem
link Using Exposed API keys with Trieve, url='https://docs.trieve.ai/guides/using-exposed-api-keys'
image
heading Examples
list
listitem
link Build Search for a Job Board, url='https://docs.trieve.ai/examples/job-board'
image
listitem
link Build Search for Ecommerce, url='https://docs.trieve.ai/examples/ecommerce'
image
StaticText Get Started
heading Quickstart
paragraph
StaticText Quickly start building search, recommendations, and RAG for your application with Trieve
list
listitem
StaticText 1
paragraph
StaticText Create an account and dataset
paragraph
StaticText Head over to the
[518] link Trieve Dashboard, center=(854,394), url='https://dashboard.trieve.ai/'
StaticText to create an account and dataset. With a free account, you can upload up to 1000 chunks and 512 MB of files.
paragraph
image title, url='https://trieve.b-cdn.net/2024-08-07_14-19.png'
button Expand image: title
listitem
StaticText 2
paragraph
StaticText Upload your data
paragraph
StaticText You can interact with Trieve in two ways, either by using the UIs or by using the
link API, url='https://docs.trieve.ai/api-reference'
StaticText .
heading Using the UIs
paragraph
StaticText After creating your dataset on the dashboard, you will be brought to the dataset page. From there, you can upload your data by clicking on the “Upload File” button.
paragraph
image title, url='https://trieve.b-cdn.net/2024-08-07_14-25.png'
button Expand image: title
paragraph
StaticText Our API will automatically chunk your data for you in the background, and upload the resulting chunks into your Trieve dataset.
heading Using the API
paragraph
StaticText In order to interact with the API, you will need to grab your dataset ID and API key from the dashboard.
paragraph
StaticText You can find your dataset ID on the dataset page:
image title, url='https://trieve.b-cdn.net/2024-08-07_14-29.png'
button Expand image: title
paragraph
StaticText You can generate an API key on the API keys page:
image title, url='https://trieve.b-cdn.net/2024-08-07_14-30.png'
button Expand image: title
paragraph
StaticText You can then use the API to upload your data, by providing the dataset ID and API key in the headers of your request.
button Copy the contents from the code block
image
code
StaticText {
StaticText "Authorization": "<api-key>",
StaticText "TR-Dataset": "<dataset-id>"
StaticText }
paragraph
StaticText You can then use our
link upload file route, url='https://docs.trieve.ai/api-reference/file/upload-file'
StaticText to upload your files and start interacting with your data.
image Note
StaticText If you would like to manually pass chunks to Trieve, you can use the
link create chunks route, url='https://docs.trieve.ai/api-reference/chunk/create-or-upsert-chunk-or-chunks'
listitem
StaticText 3
paragraph
StaticText Interact with your data
paragraph
StaticText You can now interact with your data in a variety of ways. You can search your data, get recommendations, or use RAG to generate responses to user queries using our UIs or API.
heading Searching
paragraph
StaticText You can try searching on the sample data you added by visiting
link search.trieve.ai, url='https://search.trieve.ai/'
StaticText and entering a query in the search bar.
image Note
paragraph
StaticText Make sure to select the dataset you uploaded the sample data to using the selector dropdown on the top left.
paragraph
image example-search-ui-query, url='https://cdn.trieve.ai/docs/example-search-ui-query.png'
button Expand image: example-search-ui-query
heading RAG (Retrieval Augmented Generation)
paragraph
StaticText You can try RAG on the sample data you added by visiting
link chat.trieve.ai, url='https://chat.trieve.ai/'
StaticText and entering a query in the chat box.
paragraph
image trieve-rag-example, url='https://cdn.trieve.ai/docs/trieve-rag-example.png'
button Expand image: trieve-rag-example
link Introduction, url='https://docs.trieve.ai/getting-started/introduction'
image
link Trieve Primitives, url='https://docs.trieve.ai/getting-started/trieve-primitives'
image
link x, url='https://x.com/trieveai'
image
link discord, url='https://discord.gg/eBJXXZDB8z'
image
link github, url='https://github.com/devflowinc'
image
link linkedin, url='https://www.linkedin.com/company/trieveai'
image
link website, url='https://trieve.ai/'
image
link Powered by Mintlify, url='https://mintlify.com/preview-request?utm_campaign=poweredBy&utm_medium=docs&utm_source=docs.trieve.ai'
alert, atomic
StaticText Quickstart - Trieve
Reasoning for action: By clicking on the Quickstart link, I access the relevant section that is designed to help new developers begin using the Trieve API effectively. This is a crucial step in meeting the user's goal of understanding how to integrate the Trieve API and upload files, as the Quickstart section typically contains essential instructions and guidance. The user's next step will likely be to locate the 'Uploading Files to Trieve' section within this Quickstart content.
Action: click(173) # Click on the Quickstart link to explore how to get started with Trieve.
Change Description: The browser state transitioned from the 'Introduction' page to the 'Quickstart' page of the Trieve documentation, indicated by the change in URL and the content focus shifting to a step-by-step guide for getting started with Trieve, including creating an account and uploading data.
Screenshot before:Screenshot after:---
Step 3:
Url (before/after):
https://docs.trieve.ai/getting-started/quickstart
https://docs.trieve.ai/guides/uploading-files
Content (before/after):
RootWebArea Quickstart - Trieve, focused, url='https://docs.trieve.ai/getting-started/quickstart'
main
[66] link Trieve home page light logo, center=(345,32), inner_text=Trieve home page, url='https://trieve.ai/'
image light logo, url='https://mintlify.s3.us-west-1.amazonaws.com/trieve/icons/trieve-logo.png'
[72] button Search or ask... Ctrl K, center=(960,32), inner_text=Search or ask...
Show more
Ctrl K, type=button
image
navigation
list
listitem
[94] link Support, center=(1292,31), url='mailto:humans@trieve.ai'
listitem
[96] link Dashboard, center=(1382,31), url='https://dashboard.trieve.ai/'
listitem
[98] link devflowinc/trieve 1789 155, center=(1522,32), inner_text=devflowinc/trieve
1789
155, url='https://github.com/devflowinc/trieve'
image
StaticText devflowinc
StaticText /
StaticText trieve
image
StaticText 1789
image
StaticText 155
[111] button Toggle dark mode, center=(1632,32)
image
[131] link Documentation, center=(326,88), url='https://docs.trieve.ai/getting-started/introduction'
[133] link API Reference, center=(454,88), url='https://docs.trieve.ai/api-reference/chunk/create-or-upsert-chunk-or-chunks'
[135] link Vector Inference, center=(586,88), url='https://docs.trieve.ai/vector-inference/introduction'
[137] link Site Search, center=(708,88), url='https://docs.trieve.ai/site-search/introduction'
[146] link TypeScript SDK, center=(384,158), url='https://ts-sdk.trieve.ai/'
image
[150] link Python SDK, center=(384,198), url='https://pypi.org/project/trieve-py-client/'
image
[154] link Github, center=(384,238), url='https://github.com/devflowinc/trieve'
image
[158] link Community, center=(384,278), url='https://discord.com/invite/E9sPRZqpDT'
image
[162] link Blog, center=(384,318), url='https://trieve.ai/blog'
image
heading Get Started
list
listitem
[169] link Introduction, center=(384,414), url='https://docs.trieve.ai/getting-started/introduction'
listitem
[173] link Quickstart, center=(384,450), focused, url='https://docs.trieve.ai/getting-started/quickstart'
listitem
[177] link Trieve Primitives, center=(384,486), url='https://docs.trieve.ai/getting-started/trieve-primitives'
listitem
[181] link Screenshots, center=(384,522), url='https://docs.trieve.ai/getting-started/screenshots'
heading Self Hosting
list
listitem
[188] link Docker Compose Setup, center=(384,624), url='https://docs.trieve.ai/self-hosting/docker-compose'
image
listitem
[193] link Local Kubernetes Setup, center=(384,660), url='https://docs.trieve.ai/self-hosting/local-kube'
image
listitem
[198] link AWS Self Hosting, center=(384,696), url='https://docs.trieve.ai/self-hosting/aws'
image
listitem
[203] link GCP Self Hosting, center=(384,732), url='https://docs.trieve.ai/self-hosting/gcp'
image
listitem
[208] link Azure, center=(384,768), url='https://docs.trieve.ai/self-hosting/azure'
heading Guides
list
listitem
[215] link Uploading Chunks to Trieve, center=(384,870), url='https://docs.trieve.ai/guides/create-chunk'
image
listitem
[220] link Uploading Files to Trieve, center=(384,906), url='https://docs.trieve.ai/guides/uploading-files'
image
listitem
[225] link Uploading CSV and JSONL Files to Trieve, center=(384,954), url='https://docs.trieve.ai/guides/uploading-csv-and-jsonl-files'
image
listitem
[230] link Searching with Trieve, center=(384,1002), url='https://docs.trieve.ai/guides/searching-with-trieve'
image
listitem
[235] link Recommending with Trieve, center=(384,1038), url='https://docs.trieve.ai/guides/recommending-with-trieve'
image
listitem
[240] link RAG with Trieve, center=(384,1074), url='https://docs.trieve.ai/guides/RAG-with-trieve'
image
listitem
link Analytics with Trieve, url='https://docs.trieve.ai/guides/analytics-quickstart'
image
listitem
link Creating Organizations and Datasets with Trieve, url='https://docs.trieve.ai/guides/create-organizations-and-dataset'
image
listitem
link Using Groups with Trieve, url='https://docs.trieve.ai/guides/group-with-trieve'
image
listitem
link Using Exposed API keys with Trieve, url='https://docs.trieve.ai/guides/using-exposed-api-keys'
image
heading Examples
list
listitem
link Build Search for a Job Board, url='https://docs.trieve.ai/examples/job-board'
image
listitem
link Build Search for Ecommerce, url='https://docs.trieve.ai/examples/ecommerce'
image
StaticText Get Started
heading Quickstart
paragraph
StaticText Quickly start building search, recommendations, and RAG for your application with Trieve
list
listitem
StaticText 1
paragraph
StaticText Create an account and dataset
paragraph
StaticText Head over to the
[518] link Trieve Dashboard, center=(854,394), url='https://dashboard.trieve.ai/'
StaticText to create an account and dataset. With a free account, you can upload up to 1000 chunks and 512 MB of files.
paragraph
image title, url='https://trieve.b-cdn.net/2024-08-07_14-19.png'
button Expand image: title
listitem
StaticText 2
paragraph
StaticText Upload your data
paragraph
StaticText You can interact with Trieve in two ways, either by using the UIs or by using the
link API, url='https://docs.trieve.ai/api-reference'
StaticText .
heading Using the UIs
paragraph
StaticText After creating your dataset on the dashboard, you will be brought to the dataset page. From there, you can upload your data by clicking on the “Upload File” button.
paragraph
image title, url='https://trieve.b-cdn.net/2024-08-07_14-25.png'
button Expand image: title
paragraph
StaticText Our API will automatically chunk your data for you in the background, and upload the resulting chunks into your Trieve dataset.
heading Using the API
paragraph
StaticText In order to interact with the API, you will need to grab your dataset ID and API key from the dashboard.
paragraph
StaticText You can find your dataset ID on the dataset page:
image title, url='https://trieve.b-cdn.net/2024-08-07_14-29.png'
button Expand image: title
paragraph
StaticText You can generate an API key on the API keys page:
image title, url='https://trieve.b-cdn.net/2024-08-07_14-30.png'
button Expand image: title
paragraph
StaticText You can then use the API to upload your data, by providing the dataset ID and API key in the headers of your request.
button Copy the contents from the code block
image
code
StaticText {
StaticText "Authorization": "<api-key>",
StaticText "TR-Dataset": "<dataset-id>"
StaticText }
paragraph
StaticText You can then use our
link upload file route, url='https://docs.trieve.ai/api-reference/file/upload-file'
StaticText to upload your files and start interacting with your data.
image Note
StaticText If you would like to manually pass chunks to Trieve, you can use the
link create chunks route, url='https://docs.trieve.ai/api-reference/chunk/create-or-upsert-chunk-or-chunks'
listitem
StaticText 3
paragraph
StaticText Interact with your data
paragraph
StaticText You can now interact with your data in a variety of ways. You can search your data, get recommendations, or use RAG to generate responses to user queries using our UIs or API.
heading Searching
paragraph
StaticText You can try searching on the sample data you added by visiting
link search.trieve.ai, url='https://search.trieve.ai/'
StaticText and entering a query in the search bar.
image Note
paragraph
StaticText Make sure to select the dataset you uploaded the sample data to using the selector dropdown on the top left.
paragraph
image example-search-ui-query, url='https://cdn.trieve.ai/docs/example-search-ui-query.png'
button Expand image: example-search-ui-query
heading RAG (Retrieval Augmented Generation)
paragraph
StaticText You can try RAG on the sample data you added by visiting
link chat.trieve.ai, url='https://chat.trieve.ai/'
StaticText and entering a query in the chat box.
paragraph
image trieve-rag-example, url='https://cdn.trieve.ai/docs/trieve-rag-example.png'
button Expand image: trieve-rag-example
link Introduction, url='https://docs.trieve.ai/getting-started/introduction'
image
link Trieve Primitives, url='https://docs.trieve.ai/getting-started/trieve-primitives'
image
link x, url='https://x.com/trieveai'
image
link discord, url='https://discord.gg/eBJXXZDB8z'
image
link github, url='https://github.com/devflowinc'
image
link linkedin, url='https://www.linkedin.com/company/trieveai'
image
link website, url='https://trieve.ai/'
image
link Powered by Mintlify, url='https://mintlify.com/preview-request?utm_campaign=poweredBy&utm_medium=docs&utm_source=docs.trieve.ai'
alert, atomic
StaticText Quickstart - Trieve
RootWebArea Uploading Files to Trieve - Trieve, focused, url='https://docs.trieve.ai/guides/uploading-files'
main
[66] link Trieve home page light logo, center=(345,32), inner_text=Trieve home page, url='https://trieve.ai/'
image light logo, url='https://mintlify.s3.us-west-1.amazonaws.com/trieve/icons/trieve-logo.png'
[72] button Search or ask... Ctrl K, center=(960,32), inner_text=Search or ask...
Show more
Ctrl K, type=button
image
navigation
list
listitem
[94] link Support, center=(1292,31), url='mailto:humans@trieve.ai'
listitem
[96] link Dashboard, center=(1382,31), url='https://dashboard.trieve.ai/'
listitem
[98] link devflowinc/trieve 1789 155, center=(1522,32), inner_text=devflowinc/trieve
1789
155, url='https://github.com/devflowinc/trieve'
image
StaticText devflowinc
StaticText /
StaticText trieve
image
StaticText 1789
image
StaticText 155
[111] button Toggle dark mode, center=(1632,32)
image
[131] link Documentation, center=(326,88), url='https://docs.trieve.ai/getting-started/introduction'
[133] link API Reference, center=(454,88), url='https://docs.trieve.ai/api-reference/chunk/create-or-upsert-chunk-or-chunks'
[135] link Vector Inference, center=(586,88), url='https://docs.trieve.ai/vector-inference/introduction'
[137] link Site Search, center=(708,88), url='https://docs.trieve.ai/site-search/introduction'
[146] link TypeScript SDK, center=(384,158), url='https://ts-sdk.trieve.ai/'
image
[150] link Python SDK, center=(384,198), url='https://pypi.org/project/trieve-py-client/'
image
[154] link Github, center=(384,238), url='https://github.com/devflowinc/trieve'
image
[158] link Community, center=(384,278), url='https://discord.com/invite/E9sPRZqpDT'
image
[162] link Blog, center=(384,318), url='https://trieve.ai/blog'
image
heading Get Started
list
listitem
[169] link Introduction, center=(384,414), url='https://docs.trieve.ai/getting-started/introduction'
listitem
[173] link Quickstart, center=(384,450), url='https://docs.trieve.ai/getting-started/quickstart'
listitem
[177] link Trieve Primitives, center=(384,486), url='https://docs.trieve.ai/getting-started/trieve-primitives'
listitem
[181] link Screenshots, center=(384,522), url='https://docs.trieve.ai/getting-started/screenshots'
heading Self Hosting
list
listitem
[188] link Docker Compose Setup, center=(384,624), url='https://docs.trieve.ai/self-hosting/docker-compose'
image
listitem
[193] link Local Kubernetes Setup, center=(384,660), url='https://docs.trieve.ai/self-hosting/local-kube'
image
listitem
[198] link AWS Self Hosting, center=(384,696), url='https://docs.trieve.ai/self-hosting/aws'
image
listitem
[203] link GCP Self Hosting, center=(384,732), url='https://docs.trieve.ai/self-hosting/gcp'
image
listitem
[208] link Azure, center=(384,768), url='https://docs.trieve.ai/self-hosting/azure'
heading Guides
list
listitem
[215] link Uploading Chunks to Trieve, center=(384,870), url='https://docs.trieve.ai/guides/create-chunk'
image
listitem
[220] link Uploading Files to Trieve, center=(384,906), focused, url='https://docs.trieve.ai/guides/uploading-files'
image
listitem
[225] link Uploading CSV and JSONL Files to Trieve, center=(384,954), url='https://docs.trieve.ai/guides/uploading-csv-and-jsonl-files'
image
listitem
[230] link Searching with Trieve, center=(384,1002), url='https://docs.trieve.ai/guides/searching-with-trieve'
image
listitem
[235] link Recommending with Trieve, center=(384,1038), url='https://docs.trieve.ai/guides/recommending-with-trieve'
image
listitem
[240] link RAG with Trieve, center=(384,1074), url='https://docs.trieve.ai/guides/RAG-with-trieve'
image
listitem
link Analytics with Trieve, url='https://docs.trieve.ai/guides/analytics-quickstart'
image
listitem
link Creating Organizations and Datasets with Trieve, url='https://docs.trieve.ai/guides/create-organizations-and-dataset'
image
listitem
link Using Groups with Trieve, url='https://docs.trieve.ai/guides/group-with-trieve'
image
listitem
link Using Exposed API keys with Trieve, url='https://docs.trieve.ai/guides/using-exposed-api-keys'
image
heading Examples
list
listitem
link Build Search for a Job Board, url='https://docs.trieve.ai/examples/job-board'
image
listitem
link Build Search for Ecommerce, url='https://docs.trieve.ai/examples/ecommerce'
image
StaticText Guides
heading Uploading Files to Trieve
paragraph
StaticText Learn how to upload your files to Trieve
heading Navigate to header Overview
[718] link Navigate to header, center=(567,304), inner_text=, url='https://docs.trieve.ai/guides/uploading-files#overview'
StaticText
image
paragraph
StaticText We provide the ability for users to upload their files to Trieve and use our automatic large language vision model chunking. When uploading a file to Trieve, we automatically group the chunks together to link them. This is done through our
[723] link upload file route, center=(1074,406), url='https://docs.trieve.ai/api-reference/file/upload-file'
StaticText .
[721] span, center=(640,304), inner_text=Overview
heading Navigate to header Uploading a File to Trieve
[726] link Navigate to header, center=(567,484), inner_text=, url='https://docs.trieve.ai/guides/uploading-files#uploading-a-file-to-trieve'
StaticText
image
paragraph
StaticText Our service supports various file types (e.g., HTML, DOCX, PDF). We use Apache Tika to convert these files to HTML to preserve formatting and then chunk them.
[729] span, center=(727,484), inner_text=Uploading a File to Trieve
heading Navigate to header Important Parameters
[733] link Navigate to header, center=(567,634), inner_text=, url='https://docs.trieve.ai/guides/uploading-files#important-parameters'
StaticText
image
list
[738] listitem, center=(948,702), inner_text=base64_file: To allow users to pass metadata with their file uploads, we require files to be base64 URL encoded. Convert + to -, / to _, and remove the ending = if present.
strong
code
StaticText base64_file
StaticText : To allow users to pass metadata with their file uploads, we require files to be base64 URL encoded. Convert
code
StaticText +
StaticText to
code
StaticText -
StaticText ,
code
StaticText /
StaticText to
code
StaticText _
StaticText , and remove the ending
code
StaticText =
StaticText if present.
[746] listitem, center=(948,780), inner_text=file_name: The name of the file being uploaded, including the extension. This will become the name of the resulting group.
strong
code
StaticText file_name
StaticText : The name of the file being uploaded, including the extension. This will become the name of the resulting group.
[749] listitem, center=(948,844), inner_text=group_tracking_id: This field allows you to assign an arbitrary ID to the group, aiding in coordination with your database system. You can search for this group using this ID.
strong
code
StaticText group_tracking_id
StaticText : This field allows you to assign an arbitrary ID to the group, aiding in coordination with your database system. You can search for this group using this ID.
[752] listitem, center=(948,908), inner_text=link, tag_set, and time_stamp: These fields are indexed to enable fast filtering of groups based on these attributes.
strong
code
StaticText link
StaticText ,
code
StaticText tag_set
StaticText , and
code
StaticText time_stamp
StaticText : These fields are indexed to enable fast filtering of groups based on these attributes.
[757] listitem, center=(948,972), inner_text=metadata: This field allows you to include any arbitrary metadata in the form of a JSON object with the group.
strong
code
StaticText metadata
StaticText : This field allows you to include any arbitrary metadata in the form of a JSON object with the group.
[736] span, center=(687,634), inner_text=Important Parameters
image Note
paragraph
StaticText For the best filtering performance, we recommend using the
code
StaticText link
StaticText ,
code
StaticText tag_set
StaticText , and
code
StaticText time_stamp
StaticText fields, as there are dedicated indexes for these. The metadata field has an index built for match queries but is not optimized for range queries.
heading Navigate to header Example Upload File Request
link Navigate to header, url='https://docs.trieve.ai/guides/uploading-files#example-upload-file-request'
StaticText
image
image Note
paragraph
StaticText Whenever you make a request to the Trieve API, you need to include the
code
StaticText TR-Dataset
StaticText header with your dataset ID and the
code
StaticText Authorization
StaticText header with your API key.
button Copy the contents from the code block
image
code
StaticText POST /api/file
StaticText Headers
StaticText :
StaticText {
StaticText "TR-Dataset"
StaticText :
StaticText "<Your Dataset ID>"
StaticText ,
StaticText "Authorization"
StaticText :
StaticText "<Your API Key>"
StaticText }
StaticText Body
StaticText :
StaticText {
StaticText "file_name"
StaticText :
StaticText "text.docx"
StaticText ,
StaticText "base64_file"
StaticText :
StaticText "SGVsbG8sIFdvcmxkIQ..."
StaticText ,
StaticText "metadata"
StaticText :
StaticText {
StaticText "todo"
StaticText :
StaticText "add what seems useful"
StaticText }
StaticText ,
StaticText "create_chunks"
StaticText :
StaticText true
StaticText ,
StaticText "group_tracking_id"
StaticText :
StaticText "test-group-tracking-id"
StaticText }
link Uploading Chunks to Trieve, url='https://docs.trieve.ai/guides/create-chunk'
image
link Uploading CSV and JSONL Files to Trieve, url='https://docs.trieve.ai/guides/uploading-csv-and-jsonl-files'
image
link x, url='https://x.com/trieveai'
image
link discord, url='https://discord.gg/eBJXXZDB8z'
image
link github, url='https://github.com/devflowinc'
image
link linkedin, url='https://www.linkedin.com/company/trieveai'
image
link website, url='https://trieve.ai/'
image
link Powered by Mintlify, url='https://mintlify.com/preview-request?utm_campaign=poweredBy&utm_medium=docs&utm_source=docs.trieve.ai'
image
StaticText On this page
list
listitem
[877] link Overview, center=(1532,200), url='https://docs.trieve.ai/guides/uploading-files#overview'
listitem
[879] link Uploading a File to Trieve, center=(1532,232), url='https://docs.trieve.ai/guides/uploading-files#uploading-a-file-to-trieve'
listitem
[881] link Important Parameters, center=(1540,264), url='https://docs.trieve.ai/guides/uploading-files#important-parameters'
listitem
[883] link Example Upload File Request, center=(1540,296), url='https://docs.trieve.ai/guides/uploading-files#example-upload-file-request'
alert, atomic
StaticText Uploading Files to Trieve - Trieve
Reasoning for action: I clicked on the 'Uploading Files to Trieve' link because this action is crucial to reaching the goal of understanding how to utilize the Trieve API for file uploads. By accessing this specific section, I will obtain the necessary step-by-step instructions that are essential for integrating Trieve's capabilities into a developer's application.
Action: click(220) # Click on the 'Uploading Files to Trieve' link to explore how to upload files to the platform.
Change Description: The browser navigated from the 'Quickstart' section of the Trieve documentation to the 'Uploading Files to Trieve' section, thereby changing the primary content displayed to users regarding file upload procedures and associated guidelines.
Screenshot before:Screenshot after:---