# ByteRover

> Search for people and their agents. Ask in plain language, and get passages with their page and heading, one cited answer, or "not found" when the files do not answer.

API base address: https://byterover.ai/api/v1
Authentication: Authorization: Bearer brv_... (an API key of the team)
MCP server: https://mcp.byterover.ai/mcp (tools: search, list, read, write, upload, download)

Each page has a Markdown form: add .md to its address. For agents: https://docs.byterover.ai/agents.md

# Docs

- Docs

  - **Get started**
  - [What ByteRover is](/): Search that shows the passage and the page. Ask in plain language, and get one cited answer, or "not found" when your files do not answer.
  - [Quickstart: the app](/quickstart/app): Upload a file, ask a question, and read the passage in its source. No code.
  - [Quickstart: your agent](/quickstart/agent): Connect an agent to your team's files, ask one question, and check the citation.
  - [Quickstart: the API](/quickstart/api): Add a file and search it. Two calls after the key.

  - **Concepts**
  - [Teams, drives and folders](/concepts/teams-drives-folders): How your files are organized, and what each level controls.
  - [Files: types, status and revisions](/concepts/files): Which files ByteRover reads, when a file becomes searchable, and what happens when a file changes.
  - [Results: passages, cited answers and "not found"](/concepts/results): What comes back from a search, and how you check it against the file.
  - [Search effort](/concepts/search-effort): Two levels of work for a search. Use medium for most questions, and high for the hard ones.

  - **The app**
  - [Create a team and a drive](/app/create-team-and-drive): Sign in, name your team, and make the drives that hold your files.
  - [Upload files](/app/upload-files): Add files or a whole folder to a drive, and know when you can search them.
  - [Ask a question and read the result](/app/ask-a-question): Type a question in plain language, and check the answer against the page it comes from.
  - [Share a drive](/app/share-a-drive): Give a teammate access to the files in a shared drive, with the role that fits their work.

  - **Agents**
  - [Connect an agent](/agents/connect): Give your agent one address and sign in one time. The agent can then search your team's drives.
  - [Tools: search, list, read, write, upload, download](/agents/tools): The six tools that a connected agent can call, with their inputs and their outputs.
  - [Permissions and sessions](/agents/permissions): An agent acts for one person. It reaches what that person can reach, and nothing more.
  - [Troubleshooting](/agents/troubleshooting): What to do when an agent does not connect, does not search, or returns an error.

  - **API**
  - [Authentication and API keys](/api/authentication): Create a key, send it in one header, and limit it to the drives and the actions that your code needs.
  - [Upload files](/api/upload-files): Send a file of up to 1 GB in parts, then follow it until it is searchable.
  - [Search](/api/search): Send a question, and get the passages that answer it, with the place of each one in its file.
  - [Read a document](/api/read-a-document): Get the text of one page, slide, sheet, section or range of a document.
  - [Errors and retries](/api/errors): Each error code, what it means, what to do, and when a second try is safe.
  - [Limits](/api/limits): Each limit of ByteRover in one place, with its number and its unit.

  - **Recipes**
  - [Upload a folder and search it](/api/recipes/upload-a-folder-and-search): One script that puts a folder of files in a drive, waits until they are searchable, and asks a question.

  - **Your team**
  - [Members and invitations](/team/members): Invite people to your team, give them drives, and remove them when they leave.
  - [Roles](/team/roles): Who can do what, in the team and in each drive.
  - [Pricing and billing](/team/pricing-and-billing): You pay for each search and for the files that you keep. Members have no cost.
  - [Security and data](/team/security): Who can see your files, what leaves your drive, and how to check each claim on this page.
- API reference

  - **Overview**
  - [API reference](/api-reference/introduction): The facts that hold for each operation: the address, the key, the shapes and the errors.
  - [All operations](/api-reference/operations): The 20 operations that an API key can call, by job, with the scope that each one needs.

  - **Search**
  - [Search](/api-reference/search): Returns the passages that answer a question, best first, from one or more drives.
- Changelog
  - [Changelog](/changelog): What changed in ByteRover, newest first. A change that can break your code has the mark Breaking.