canonical: https://jentic.com/apis/thebluealliance.com/thebluealliance

# The Blue Alliance API v3

Overview Information and statistics about FIRST Robotics Competition teams and events. Authentication All endpoints require an Auth Key to be passed in the header `X-TBA-Auth-Key`. If you do not have an auth key yet, you can obtain one from your [Account Page](/account). The API exposes 78 endpoints secured with apiKey authentication.

## For AI agents

Programmatically getstatus, getteams. Covers 78 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for identity and authentication only.

## Capabilities

- getStatus
- getTeams
- Integrate The Blue Alliance API v3 into automated workflows
- Query and filter The Blue Alliance API v3 records by parameters
- Monitor The Blue Alliance API v3 operational status and events

## Use cases

### Identity and Authentication Operations

Use the The Blue Alliance API v3 to perform identity auth operations programmatically. The API provides 78 endpoints covering core functionality including getstatus, getteams, getteamssimple.

Example prompt: Call GET /status to getstatus

### Automated TBA Management

Automate tba operations by combining multiple The Blue Alliance API v3 endpoints. Agents can getteams and then getteamssimple in a single workflow.

Example prompt: Call GET `/teams/{page_num}` to getteams, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call The Blue Alliance API v3 endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'getstatus', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/status` | getStatus |
| GET | `/teams/{page_num}` | getTeams |
| GET | `/teams/{page_num}/simple` | getTeamsSimple |
| GET | `/teams/{page_num}/keys` | getTeamsKeys |
| GET | `/teams/{year}/{page_num}` | getTeamsByYear |
| GET | `/teams/{year}/{page_num}/simple` | getTeamsByYearSimple |
| GET | `/teams/{year}/{page_num}/keys` | getTeamsByYearKeys |
| GET | `/team/{team_key}` | getTeam |

## Key resources

- **TBA** — Calls that expose TBA internals or status.
- **list** — Calls that return a list of records.
- **team** — Calls that return team or team-specific information.
- **event** — Calls that return event, or event-specific information.
- **match** — Calls that return match, or match-specific information.

## Why Jentic

- **Setup:** Wiring The Blue Alliance API by hand means passing your API key against www.thebluealliance.com and handling each team and status endpoint yourself. Through Jentic you install once, import The Blue Alliance from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The Blue Alliance API is read-only and puts targets like the team key and page number in the URL path (`/team/{team_key}`, `/teams/{year}/{page_num}`), so a rule can pin your agent to reads for one team. You choose the operations it may call, so it only reaches the endpoints you include.
- **Credential handling:** Your Blue Alliance API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get details for a team' or 'check the API status', and Jentic returns the matching Blue Alliance operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Auth0** — Alternative identity auth API
- **Okta** — Alternative identity auth API

## FAQ

### What authentication does the The Blue Alliance API v3 use?

The The Blue Alliance API v3 uses an API key passed in the `X-TBA-Auth-Key` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I getstatus with the The Blue Alliance API v3?

Yes. Use the GET /status endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the The Blue Alliance API v3?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I getstatus through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'getstatus'. Jentic returns the matching The Blue Alliance API v3 operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the The Blue Alliance API v3 have?

The The Blue Alliance API v3 exposes 78 endpoints covering tba, list, team operations.

### Can I limit what my agent is allowed to do with the The Blue Alliance API?

Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials your agent may use, and you pick exactly which endpoints to include. The Blue Alliance API is read-only, so an agent can only fetch data such as team, event, match, and status records and can never modify anything. Since targets like the team key and page number sit in the URL path, for example `/team/{team_key}` and `/teams/{year}/{page_num}`, you can pin the agent to reads for a single team or restrict it to just the status and team lookups you approve.