> For the complete documentation index, see [llms.txt](https://docs.raidrobotics.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.raidrobotics.org/raidscout/admin-guide/api-keys-and-outside-data.md).

# API keys and outside data

RAIDScout pulls data in from three outside sources. Nothing is ever sent out to them.

| Source                | Gives us                                                                                       |
| --------------------- | ---------------------------------------------------------------------------------------------- |
| **The Blue Alliance** | Event dates, teams, schedule, predicted match times, scores, match videos, rankings, alliances |
| **Match13**           | xP ratings per team (auto, teleop, endgame) and match forecasts                                |
| **Nexus**             | Queue status, estimated start and queue times, pit addresses                                   |

Each source is optional: without its key it just doesn't sync, and **Manage › Events** says so. When an event uses Nexus, its estimated times are used first, then The Blue Alliance's prediction, then the published schedule.

## Save or replace a key

**Manage › API keys** is admin-only.

1. Get the key: thebluealliance.com › Account › Read API Keys; match13.com › Account; frc.nexus/api.
2. Paste it next to the source and tap **Save**.
3. Use **Sync now** in **Manage › Events** to check it.

To replace a key, paste the new one and save. Keys are stored encrypted; only their last four characters are shown. **Remove** goes back to the key set in the Convex dashboard (**From Convex**), if there is one.

Saving keys needs `API_KEY_SECRET` set in the Convex dashboard first. If it isn't, the page says so; ask whoever maintains the app.

## When it syncs

Only around the active event (the day before through two days after): every minute while matches are coming up, until an hour before the next match overnight, and every 3 hours after the finals. Between events nothing runs.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.raidrobotics.org/raidscout/admin-guide/api-keys-and-outside-data.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
