{"openapi":"3.1.0","info":{"title":"Highlightly Rugby (BYOK) API","version":"0.1.0","description":"Highlightly Rugby (BYOK) lets an AI assistant read your own Highlightly Rugby data through the Highlightly Rugby API with a key you supply (Highlightly API key). Read-only: 11 tools (list_matches, get_match, list_leagues, list_teams, get_team, get_standings, get_head_to_head, get_last_five_games, list_highlights, get_league, list_countries). The BYOK key travels with each request, is used for...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-highlightly-rugby.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-highlightly-rugby/docs"},"termsOfService":"https://connectorbay.com/byok-highlightly-rugby/terms"},"servers":[{"url":"https://byok-highlightly-rugby.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-highlightly-rugby/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_matches":{"post":{"operationId":"list_matches","summary":"List rugby matches with teams, league, date and score. Give at least one filter besides timezone, limit and offset, such","description":"List rugby matches with teams, league, date and score. Give at least one filter besides timezone, limit and offset, such as a date or a league. Use for \"Which rugby matches are on 2026-03-14\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"date":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Date as YYYY-MM-DD, for example 2024-03-08.","title":"Date"},"timezone":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Time zone identifier used for dates and times, for example 'Europe/London' (default Etc/UTC).","title":"Timezone"},"league_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"League id to filter by (from list_leagues).","title":"League Id"},"league_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"League or competition name to filter by, for example 'Six Nations U20'.","title":"League Name"},"season":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Season year, for example 2024.","title":"Season"},"home_team_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only items whose home team has this id.","title":"Home Team Id"},"away_team_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only items whose away team has this id.","title":"Away Team Id"},"home_team_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items whose home team has this name, for example 'Italy U20'.","title":"Home Team Name"},"away_team_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items whose away team has this name, for example 'Scotland U20'.","title":"Away Team Name"},"country_code":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Country code (ISO 3166), for example 'EU'.","title":"Country Code"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many results to return (default 100, at most 100; your plan may cap it lower).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging.","title":"Offset"}},"title":"list_matchesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_match":{"post":{"operationId":"get_match","summary":"Get one rugby match with teams, league, state and score plus events or statistics where the provider has them. Use for \"","description":"Get one rugby match with teams, league, state and score plus events or statistics where the provider has them. Use for \"What is the score and what happened in a rugby match with id 12345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Match id (from list_matches).","title":"Id","type":"integer"}},"required":["id"],"title":"get_matchArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_leagues":{"post":{"operationId":"list_leagues","summary":"List rugby leagues and competitions with country and available seasons, optionally filtered by name, country or season. ","description":"List rugby leagues and competitions with country and available seasons, optionally filtered by name, country or season. Use for \"Which rugby leagues are there in Spain\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"season":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":null,"description":"Season year, for example 2024.","title":"Season"},"league_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"League or competition name to filter by, for example 'Six Nations U20'.","title":"League Name"},"country_code":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Country code (ISO 3166), for example 'EU'.","title":"Country Code"},"country_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Country name, for example 'Europe'.","title":"Country Name"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many results to return (default 100, at most 100; your plan may cap it lower).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging.","title":"Offset"}},"title":"list_leaguesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_teams":{"post":{"operationId":"list_teams","summary":"List rugby teams with ids, optionally filtered by name. Use for \"Find the rugby team called Ireland\".","description":"List rugby teams with ids, optionally filtered by name. Use for \"Find the rugby team called Ireland\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Name or part of a name to search for, for example 'Italy U20'.","title":"Name"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":500,"description":"How many results to return (default 500, at most 500; your plan may cap it lower).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging.","title":"Offset"}},"title":"list_teamsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_team":{"post":{"operationId":"get_team","summary":"Get one rugby team by id. Use for \"Show the rugby team with id 1001\".","description":"Get one rugby team by id. Use for \"Show the rugby team with id 1001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Team id (from list_teams).","title":"Id","type":"integer"}},"required":["id"],"title":"get_teamArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_standings":{"post":{"operationId":"get_standings","summary":"Get the rugby table for a league and season, grouped by conference or stage, with each team's results and points. Use fo","description":"Get the rugby table for a league and season, grouped by conference or stage, with each team's results and points. Use for \"What are the Six Nations standings for 2025\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"league_id":{"description":"League id to filter by (from list_leagues).","title":"League Id","type":"integer"},"season":{"description":"Season year, for example 2022.","title":"Season","type":"integer"}},"required":["league_id","season"],"title":"get_standingsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_head_to_head":{"post":{"operationId":"get_head_to_head","summary":"List past rugby matches between two teams, with scores. Use for \"How have team 1001 and team 1002 done against each othe","description":"List past rugby matches between two teams, with scores. Use for \"How have team 1001 and team 1002 done against each other in rugby\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id_one":{"description":"Id of the first team.","title":"Team Id One","type":"integer"},"team_id_two":{"description":"Id of the second team.","title":"Team Id Two","type":"integer"}},"required":["team_id_one","team_id_two"],"title":"get_head_to_headArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_last_five_games":{"post":{"operationId":"get_last_five_games","summary":"List the last five finished rugby matches of a team, with scores. Use for \"How did rugby team 1001 do in its last five g","description":"List the last five finished rugby matches of a team, with scores. Use for \"How did rugby team 1001 do in its last five games\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"team_id":{"description":"Team id.","title":"Team Id","type":"integer"}},"required":["team_id"],"title":"get_last_five_gamesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_highlights":{"post":{"operationId":"list_highlights","summary":"List rugby video highlights (title, link and embed link) with the match they belong to. Free and basic plans may have re","description":"List rugby video highlights (title, link and embed link) with the match they belong to. Free and basic plans may have restrictions; give at least one filter such as a date or match id. Use for \"Are there rugby highlights for matches on 2026-03-14\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"country_code":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Country code (ISO 3166), for example 'EU'.","title":"Country Code"},"league_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"League or competition name to filter by, for example 'Six Nations U20'.","title":"League Name"},"league_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"League id to filter by (from list_leagues).","title":"League Id"},"date":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Date as YYYY-MM-DD, for example 2024-03-08.","title":"Date"},"timezone":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Time zone identifier used for dates and times, for example 'Europe/London' (default Etc/UTC).","title":"Timezone"},"season":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Season year, for example 2024.","title":"Season"},"match_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only items of this match id.","title":"Match Id"},"home_team_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items whose home team has this name, for example 'Italy U20'.","title":"Home Team Name"},"away_team_name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only items whose away team has this name, for example 'Scotland U20'.","title":"Away Team Name"},"limit":{"anyOf":[{"maximum":40,"minimum":1,"type":"integer"},{"type":"null"}],"default":40,"description":"How many results to return (default 40, at most 40; your plan may cap it lower).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip, for paging.","title":"Offset"}},"title":"list_highlightsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_league":{"post":{"operationId":"get_league","summary":"Get one rugby league by id with its country and seasons. Use for \"Show the rugby league with id 3001\".","description":"Get one rugby league by id with its country and seasons. Use for \"Show the rugby league with id 3001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"League id (from list_leagues).","title":"Id","type":"integer"}},"required":["id"],"title":"get_leagueArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_countries":{"post":{"operationId":"list_countries","summary":"List the countries known to the rugby data, optionally filtered by name. Use for \"Which countries are covered for rugby\"","description":"List the countries known to the rugby data, optionally filtered by name. Use for \"Which countries are covered for rugby\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Name or part of a name to search for, for example 'Europe'.","title":"Name"}},"title":"list_countriesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}