> For the complete documentation index, see [llms.txt](https://docs.sportradar.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sportradar.com/personalization/api-reference/sports/bet-builders.md).

# Bet Builders

Sport bet builders related endpoints

## Get recommended bet builders

> Returns personalized bet builder recommendations.\
> \
> Produces recommended bet builders based on the provided input.\
> \
> If the \`event\_id\` parameter is passed, then \`count\` bet builders for the\
> given event will be generated.\
> \
> If an \`event\_id\` is not provided, then \`count\` bet builders will be generated.\
> In that case for each event its associated \`confidence\` will be also returned.\
> \
> The amount of bet builders to generate per event will be dynamically calculated\
> based on the personalization score of each event, promoting the most recommended ones.\
> The query parameter \`max\_count\_per\_event\` can be used to apply an upper limit on\
> that dynamically calculated number.\
> \
> The selections picked are the most relevant to the given user from the supported\
> ones. Validation steps are also applied to ensure that the produced bet builders\
> contain only valid and combinable selections.\
> \
> {% hint style="info" %}\
> \
> \## Supported data providers\
> \
> \
> The current endpoint is available for specific data providers only, which are:\
> \
> \<details>\
> &#x20; \<summary>\`Igt\`\</summary>\
> \- AmericanFootball\
> \- Baseball\
> \- Basketball\
> \- IceHockey\
> \</details>\
> \
> \<details>\
> &#x20; \<summary>\`Kambi\`\</summary>\
> \- AmericanFootball\
> \- Baseball\
> \- Basketball\
> \- Darts\
> \- Football\
> \- IceHockey\
> \- Tennis\
> \</details>\
> \
> \<details>\
> &#x20; \<summary>\`Openbet\`\</summary>\
> \- Baseball\
> \- Basketball\
> \- Football\
> \</details>\
> \
> \<details>\
> &#x20; \<summary>\`SR\`\</summary>\
> \- AmericanFootball\
> \- Baseball\
> \- Basketball\
> \- Cricket\
> \- Football\
> \- IceHockey\
> \- MMA\
> \- Tennis\
> \- Volleyball\
> \</details>\
> \
> \
> Contact the API team for integration with other data providers.\
> \
> {% endhint %}\
> \
> \
> {% hint style="info" %}\
> \
> \## Supported markets\
> \
> \
> Only a subset of the available markets can be used and combined in a bet builder.\
> Currently the supported markets are the following:\
> \
> \<details>\
> &#x20; \<summary>\`AmericanFootball\`\</summary>\
> \- Match result\
> \- Xth half result\
> \- Xth quarter result\
> \- Winner\
> \- Double chance\
> \- Handicap\
> \- Xth half handicap\
> \- Xth quarter handicap\
> \- Asian handicap\
> \- Total points\
> \- Xth half total points\
> \- Xth quarter total points\
> \- Home Team total points\
> \- Away Team total points\
> \- Total touchdowns\
> \- Total field goals\
> \- Total turnovers\
> \- Total sacks\
> \- Odd/Even points\
> \- 1st half odd/even points\
> \- Winning margin\
> \- Will there be Overtime\
> \- Last touchdown scorer\
> \- Player total touchdowns\
> \- Player total touchdown passes\
> \- Player total receptions\
> \- Player total field goals\
> \- Player total kicking points\
> \- Player total interceptions\
> \- Player total receiving touchdowns\
> \- Player total receiving yards\
> \- Player total rushing attempts\
> \- Player total rushing touchdowns\
> \- Player total rushing yards\
> \- Player total passing touchdowns\
> \- Player total passing yards\
> \- Player total pass attempts\
> \- Player total pass completions\
> \- Player longest reception\
> \- Player longest pass completion\
> \</details>\
> \
> \<details>\
> &#x20; \<summary>\`Baseball\`\</summary>\
> \- Match Result\
> \- Winner\
> \- Handicap\
> \- Total runs\
> \- Home total runs\
> \- Away total runs\
> \- Total home runs\
> \- Home total home runs\
> \- Away total home runs\
> \- Total runs odd or even\
> \- Total hits\
> \- Player total runs\
> \- Player total home runs\
> \- Player total hits\
> \- Player total bases\
> \- Player total strikeouts\
> \- Player total RBIs\
> \</details>\
> \
> \<details>\
> &#x20; \<summary>\`Basketball\`\</summary>\
> \- Match Result\
> \- Winner\
> \- Match result - 1st half\
> \- Match result - 1st quarter\
> \- Total points\
> \- Home total points\
> \- Away total points\
> \- Total points - 1st half\
> \- Home total points - 1st half\
> \- Away total points - 1st half\
> \- Total points - 1st quarter\
> \- Home total points - 1st quarter\
> \- Away total points - 1st quarter\
> \- Player total points\
> \- Player total assists\
> \- Player total rebounds\
> \- Player total blocks\
> \- Player total steals\
> \- Player total 3-points made\
> \</details>\
> \
> \<details>\
> &#x20; \<summary>\`Cricket\`\</summary>\
> \- Match winner\
> \- Total match fours\
> \- Total match sixes\
> \- Highest first over\
> \- Highest opening partnership\
> \- Most fours\
> \- Batter milestones\
> \- Top batter in match\
> \- Top bowler in match\
> \- Team of top batter\
> \- Team of top bowler\
> \</details>\
> \
> \<details>\
> &#x20; \<summary>\`Darts\`\</summary>\
> \- Checkout Total Points - Leg X\
> \- Leg X Winner\
> \- Result after X Legs\
> \- Match Odds (match result) - Full time\
> \- Total Legs - Over/Under\
> \- Total 180s - Over/Under\
> \- Player's Total 180s - Over/Under\
> \- Most 180s\
> \- Leg Handicap\
> \- 180 in Leg X\
> \- Player to score 180 in Leg X\
> \- 180s Handicap\
> \- Correct Score\
> \</details>\
> \
> \<details>\
> &#x20; \<summary>\`Football\`\</summary>\
> \- Match result\
> \- Match result - 1st half\
> \- Match result - 2nd half\
> \- Double chance\
> \- Double chance - 1st half\
> \- Draw no bet - 2nd half\
> \- Three way handicap - 2nd half\
> \- Both teams to score\
> \- Both teams to score - 1st half\
> \- Both teams to score - 2nd half\
> \- Total goals\
> \- Home total goals\
> \- Away total goals\
> \- Total goals - 1st half\
> \- Home total goals - 1st half\
> \- Away total goals - 1st half\
> \- Total goals - 2nd half\
> \- Home total goals - 2nd half\
> \- Away total goals - 2nd half\
> \- Total cards\
> \- Home total cards\
> \- Away total cards\
> \- Total corners\
> \- Home total corners\
> \- Away total corners\
> \- Corners 1x2\
> \- Player total goals\
> \- Player total assists\
> \- Player total shots on target\
> \- Player total shots\
> \- Player total passes\
> \- Player total tackles\
> \- Goal range\
> \- Home clean sheet\
> \- Away clean sheet\
> \- Home clean sheet - 2nd half\
> \- Away clean sheet - 2nd half\
> \- Xth player to score\
> \- Penalty shootout winner\
> \- Penalty shootout xth penalty scored\
> \- Penalty shootout xth goal\
> \- Penalty shootout winning margin\
> \- Penalty shootout total goals\
> \- Penalty shootout home total goals\
> \- Penalty shootout away total goals\
> \- Penalty shootout odd/even\
> \- Penalty shootout home odd/even\
> \- Penalty shootout away odd/even\
> \- First half total bookings\
> \- Home team first half total bookings\
> \- Away team first half total bookings\
> \- First half total corners\
> \- Home team first half total corners\
> \- Away team first half total corners\
> \- Player to be carded\
> \</details>\
> \
> \<details>\
> &#x20; \<summary>\`IceHockey\`\</summary>\
> \- Match result\
> \- Winner\
> \- Handicap\
> \- Handicap(incl. overtime and penalties)\
> \- 3-Way handicap\
> \- Both teams to score\
> \- Total goals\
> \- Home total goals\
> \- Away total goals\
> \- Player total goals\
> \- Xth goal\
> \- Xth period total goals\
> \- Xth period winner\
> \- Xth period home total goals\
> \- Xth period away total goals\
> \</details>\
> \
> \<details>\
> &#x20; \<summary>\`MMA\`\</summary>\
> \- 1x2\
> \- Winner\
> \- Total Rounds\
> \- Winning Method\
> \- Winning Method (Double Chance)\
> \- Will the fight go the distance\
> \- Winner & exact rounds\
> \- Home competitor total head strikes\
> \- Away competitor total head strikes\
> \- Home competitor total head strikes at round\
> \- Away competitor total head strikes at round\
> \- Home competitor exact knockdowns at round\
> \- Away competitor exact knockdowns at round\
> \</details>\
> \
> \<details>\
> &#x20; \<summary>\`Tennis\`\</summary>\
> \- Winner\
> \- Winner - Xth set\
> \- Result - Games\
> \- Game handicap\
> \- Game handicap - Xth set\
> \- Set handicap\
> \- Total sets\
> \- Total games\
> \- Total games - Xth set\
> \- Home player total games\
> \- Away player total games\
> \- Home player to win a set\
> \- Away player to win a set\
> \- Set to nil\
> \- Tiebreak occurrence\
> \- Exact sets\
> \- Total games odd or even\
> \- Total games odd or even - Xth set\
> \- Correct score\
> \- Correct score - Xth set\
> \- Player to win Xth set\
> \</details>\
> \
> \<details>\
> &#x20; \<summary>\`Volleyball\`\</summary>\
> \- Winner\
> \- Set handicap\
> \- Point handicap\
> \- Total points\
> \- Total sets\
> \- Competitor1 total\
> \- Competitor2 total\
> \- Odd/even\
> \- Exact sets\
> \- Double result (1st set/match)\
> \- xth set - winner\
> \- xth set - point handicap\
> \- xth set - total points\
> \- xth set - odd/even\
> \- xth set - xth point\
> \- xth set - race to x points\
> \- Competitor1 to win a set\
> \- Competitor2 to win a set\
> \- Will there be a 4th set\
> \- Will there be a 5th set\
> \- How many sets decided by extra points\
> \- Competitor1 to win exactly 1 set\
> \- Competitor2 to win exactly 1 set\
> \- Competitor1 to win exactly 2 sets\
> \- Competitor2 to win exactly 2 sets\
> \</details>\
> \
> \
> Notice that the above list contains the algorithm's \*\*supported\*\* markets.\
> It is the responsibility of the operator to provide VAIX with the\
> markets listed, or at least a subset of them, in order for them to be used.\
> \
> {% endhint %}\
> \
> \
> {% hint style="info" %}\
> \
> \## Personalized bet builder length\
> \
> \
> The option to dynamically calculate the bet builder's length based on the user's\
> preferences is supported, using the \`personalized\_length\` parameter. If used,\
> the length of each bet builder will be calculated based on the user's historical\
> preferences and behavior.\
> \
> Notice that in that case, the given \`length\` parameter will be ignored.\
> \
> {% endhint %}\
> \
> \
> {% hint style="info" %}\
> \
> \## Length of produced bet builder\
> \
> \
> There is the possibility that a bet builder with length less than the\
> requested one will be returned, in case the markets offered for the given\
> event are insufficient or not combinable.\
> \
> Mostly applicable to cases where a big bet builder length is requested (> 6).\
> \
> {% endhint %}\
> \
> \
> {% hint style="warning" %}\
> \
> \## Integration concerns\
> \
> \
> The bet builder related endpoints are guaranteed to return a valid bet builder\
> combination, including selections for markets the operator supports.\
> \
> Notice that no odds calculation is taking place, meaning that the overall odds\
> of the bet builder coupon should be calculated from the client's existing bet builder logic.\
> \
> {% endhint %}\
> \
> \
> {% hint style="info" %}\
> \
> \## Getting two recommender bet builders with 3 selections\
> \
> \
> In this example we get two recommender bet builders containing \`3\` selections each\
> for the event with id \`sr:match:40781327\`, for the user with id \`1\`.\
> \
> \`\`\`bash\
> $ curl --request GET \\\
> &#x20; \--url '<https://api.vaix.ai/api/sports/bet\\_builders/recommended?user=1\\&event\\_id=sr:match:40781327\\&length=3\\&count=2'\\>
> \`\`\`\
> \
> {% endhint %}\ <br>

````json
{"openapi":"3.0.1","info":{"title":"","version":"0.1.0"},"tags":[{"description":"Sport bet builders related endpoints","name":"Bet Builders"}],"servers":[{"description":"Production API","url":"https://api.vaix.ai"},{"description":"Staging (integration) API","url":"https://staging-api.vaix.ai"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"scheme":"bearer","type":"http"}},"schemas":{"RecommendedBetBuilder":{"additionalProperties":false,"description":"A recommended bet builder object","properties":{"begin":{"description":"The starting time of the event in UTC","format":"date-time","type":"string"},"bet_builders":{"description":"List with the event's recommended bet builders","items":{"oneOf":[{"description":"The betbuilders with their odds","properties":{"odds":{"description":"The calculated odds for the bet builder","type":"number"},"selections":{"description":"The bet builder's selections","items":{"description":"A bet builder's selection","properties":{"bet_offer_id":{"description":"The event specific market id","nullable":true,"type":"string"},"count":{"description":"How many bets are placed on the market","type":"integer"},"market":{"description":"The market's name","nullable":true,"type":"string"},"market_id":{"description":"The `market`'s id","nullable":true,"type":"number"},"market_type":{"description":"The market's type","nullable":true,"type":"string"},"market_type_id":{"description":"The `market_type`'s id","nullable":true,"type":"number"},"outcome":{"description":"The selection's outcome","nullable":true,"type":"string"},"outcome_id":{"description":"The `outcome`'s id","nullable":true,"type":"number"},"period":{"description":"The selection's period","nullable":true,"type":"string"},"period_id":{"description":"The `period`'s id","nullable":true,"type":"number"},"quote":{"description":"The selection's quote","type":"number"},"quote_group":{"description":"The group the quote belongs to","type":"string"},"selection_id":{"description":"The market selection id","type":"string"},"side":{"description":"The side of the market, back or lay (exchange only)","type":"string"},"uof_external_id":{"description":"The external market id","nullable":true,"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},{"description":"Array of bet builder selections","items":{"description":"A bet builder's selection","properties":{"bet_offer_id":{"description":"The event specific market id","nullable":true,"type":"string"},"count":{"description":"How many bets are placed on the market","type":"integer"},"market":{"description":"The market's name","nullable":true,"type":"string"},"market_id":{"description":"The `market`'s id","nullable":true,"type":"number"},"market_type":{"description":"The market's type","nullable":true,"type":"string"},"market_type_id":{"description":"The `market_type`'s id","nullable":true,"type":"number"},"outcome":{"description":"The selection's outcome","nullable":true,"type":"string"},"outcome_id":{"description":"The `outcome`'s id","nullable":true,"type":"number"},"period":{"description":"The selection's period","nullable":true,"type":"string"},"period_id":{"description":"The `period`'s id","nullable":true,"type":"number"},"quote":{"description":"The selection's quote","type":"number"},"quote_group":{"description":"The group the quote belongs to","type":"string"},"selection_id":{"description":"The market selection id","type":"string"},"side":{"description":"The side of the market, back or lay (exchange only)","type":"string"},"uof_external_id":{"description":"The external market id","nullable":true,"type":"string"}},"type":"object"},"type":"array"}]},"type":"array"},"confidence":{"description":"Confidence score, the highest the value the more confident the recommendation of the item\n","type":"number"},"country":{"description":"The country the event takes place at","nullable":true,"type":"string"},"country_id":{"description":"The id of the country the event takes place at","nullable":true,"type":"string"},"event_id":{"description":"The unique event id","type":"string"},"event_type":{"description":"The type of the event, e.g. `outright","nullable":true,"type":"string"},"league":{"description":"The league associated with the current event","nullable":true,"type":"string"},"league_id":{"description":"The id of the event's league","nullable":true,"type":"string"},"participant_ids":{"description":"The id of the event participants","items":{"type":"string"},"nullable":true,"type":"array"},"participants":{"description":"The participants of the event","items":{"type":"string"},"nullable":true,"type":"array"},"sport":{"description":"The sport of the event, e.g. `soccer`","nullable":true,"type":"string"},"sport_id":{"description":"The id of the event's sport","nullable":true,"type":"string"},"status":{"description":"The status of the event, e.g. `live`","type":"string"}},"type":"object"},"Error":{"additionalProperties":false,"description":"The generic API's error response","properties":{"error":{"description":"Description of the error","type":"string"},"status":{"description":"response status","type":"string"}},"type":"object"},"Errors":{"additionalProperties":false,"description":"The generic API's errors response","properties":{"errors":{"description":"An object with the request errors","type":"object"}},"type":"object"},"UnprocessableEntityError":{"oneOf":[{"additionalProperties":false,"description":"The generic API's error response","properties":{"error":{"description":"Description of the error","type":"string"},"status":{"description":"response status","type":"string"}},"type":"object"},{"additionalProperties":false,"description":"The generic API's errors response","properties":{"errors":{"description":"An object with the request errors","type":"object"}},"type":"object"}]}}},"paths":{"/api/sports/bet_builders/recommended":{"get":{"description":"Returns personalized bet builder recommendations.\n\nProduces recommended bet builders based on the provided input.\n\nIf the `event_id` parameter is passed, then `count` bet builders for the\ngiven event will be generated.\n\nIf an `event_id` is not provided, then `count` bet builders will be generated.\nIn that case for each event its associated `confidence` will be also returned.\n\nThe amount of bet builders to generate per event will be dynamically calculated\nbased on the personalization score of each event, promoting the most recommended ones.\nThe query parameter `max_count_per_event` can be used to apply an upper limit on\nthat dynamically calculated number.\n\nThe selections picked are the most relevant to the given user from the supported\nones. Validation steps are also applied to ensure that the produced bet builders\ncontain only valid and combinable selections.\n\n{% hint style=\"info\" %}\n\n## Supported data providers\n\n\nThe current endpoint is available for specific data providers only, which are:\n\n<details>\n  <summary>`Igt`</summary>\n- AmericanFootball\n- Baseball\n- Basketball\n- IceHockey\n</details>\n\n<details>\n  <summary>`Kambi`</summary>\n- AmericanFootball\n- Baseball\n- Basketball\n- Darts\n- Football\n- IceHockey\n- Tennis\n</details>\n\n<details>\n  <summary>`Openbet`</summary>\n- Baseball\n- Basketball\n- Football\n</details>\n\n<details>\n  <summary>`SR`</summary>\n- AmericanFootball\n- Baseball\n- Basketball\n- Cricket\n- Football\n- IceHockey\n- MMA\n- Tennis\n- Volleyball\n</details>\n\n\nContact the API team for integration with other data providers.\n\n{% endhint %}\n\n\n{% hint style=\"info\" %}\n\n## Supported markets\n\n\nOnly a subset of the available markets can be used and combined in a bet builder.\nCurrently the supported markets are the following:\n\n<details>\n  <summary>`AmericanFootball`</summary>\n- Match result\n- Xth half result\n- Xth quarter result\n- Winner\n- Double chance\n- Handicap\n- Xth half handicap\n- Xth quarter handicap\n- Asian handicap\n- Total points\n- Xth half total points\n- Xth quarter total points\n- Home Team total points\n- Away Team total points\n- Total touchdowns\n- Total field goals\n- Total turnovers\n- Total sacks\n- Odd/Even points\n- 1st half odd/even points\n- Winning margin\n- Will there be Overtime\n- Last touchdown scorer\n- Player total touchdowns\n- Player total touchdown passes\n- Player total receptions\n- Player total field goals\n- Player total kicking points\n- Player total interceptions\n- Player total receiving touchdowns\n- Player total receiving yards\n- Player total rushing attempts\n- Player total rushing touchdowns\n- Player total rushing yards\n- Player total passing touchdowns\n- Player total passing yards\n- Player total pass attempts\n- Player total pass completions\n- Player longest reception\n- Player longest pass completion\n</details>\n\n<details>\n  <summary>`Baseball`</summary>\n- Match Result\n- Winner\n- Handicap\n- Total runs\n- Home total runs\n- Away total runs\n- Total home runs\n- Home total home runs\n- Away total home runs\n- Total runs odd or even\n- Total hits\n- Player total runs\n- Player total home runs\n- Player total hits\n- Player total bases\n- Player total strikeouts\n- Player total RBIs\n</details>\n\n<details>\n  <summary>`Basketball`</summary>\n- Match Result\n- Winner\n- Match result - 1st half\n- Match result - 1st quarter\n- Total points\n- Home total points\n- Away total points\n- Total points - 1st half\n- Home total points - 1st half\n- Away total points - 1st half\n- Total points - 1st quarter\n- Home total points - 1st quarter\n- Away total points - 1st quarter\n- Player total points\n- Player total assists\n- Player total rebounds\n- Player total blocks\n- Player total steals\n- Player total 3-points made\n</details>\n\n<details>\n  <summary>`Cricket`</summary>\n- Match winner\n- Total match fours\n- Total match sixes\n- Highest first over\n- Highest opening partnership\n- Most fours\n- Batter milestones\n- Top batter in match\n- Top bowler in match\n- Team of top batter\n- Team of top bowler\n</details>\n\n<details>\n  <summary>`Darts`</summary>\n- Checkout Total Points - Leg X\n- Leg X Winner\n- Result after X Legs\n- Match Odds (match result) - Full time\n- Total Legs - Over/Under\n- Total 180s - Over/Under\n- Player's Total 180s - Over/Under\n- Most 180s\n- Leg Handicap\n- 180 in Leg X\n- Player to score 180 in Leg X\n- 180s Handicap\n- Correct Score\n</details>\n\n<details>\n  <summary>`Football`</summary>\n- Match result\n- Match result - 1st half\n- Match result - 2nd half\n- Double chance\n- Double chance - 1st half\n- Draw no bet - 2nd half\n- Three way handicap - 2nd half\n- Both teams to score\n- Both teams to score - 1st half\n- Both teams to score - 2nd half\n- Total goals\n- Home total goals\n- Away total goals\n- Total goals - 1st half\n- Home total goals - 1st half\n- Away total goals - 1st half\n- Total goals - 2nd half\n- Home total goals - 2nd half\n- Away total goals - 2nd half\n- Total cards\n- Home total cards\n- Away total cards\n- Total corners\n- Home total corners\n- Away total corners\n- Corners 1x2\n- Player total goals\n- Player total assists\n- Player total shots on target\n- Player total shots\n- Player total passes\n- Player total tackles\n- Goal range\n- Home clean sheet\n- Away clean sheet\n- Home clean sheet - 2nd half\n- Away clean sheet - 2nd half\n- Xth player to score\n- Penalty shootout winner\n- Penalty shootout xth penalty scored\n- Penalty shootout xth goal\n- Penalty shootout winning margin\n- Penalty shootout total goals\n- Penalty shootout home total goals\n- Penalty shootout away total goals\n- Penalty shootout odd/even\n- Penalty shootout home odd/even\n- Penalty shootout away odd/even\n- First half total bookings\n- Home team first half total bookings\n- Away team first half total bookings\n- First half total corners\n- Home team first half total corners\n- Away team first half total corners\n- Player to be carded\n</details>\n\n<details>\n  <summary>`IceHockey`</summary>\n- Match result\n- Winner\n- Handicap\n- Handicap(incl. overtime and penalties)\n- 3-Way handicap\n- Both teams to score\n- Total goals\n- Home total goals\n- Away total goals\n- Player total goals\n- Xth goal\n- Xth period total goals\n- Xth period winner\n- Xth period home total goals\n- Xth period away total goals\n</details>\n\n<details>\n  <summary>`MMA`</summary>\n- 1x2\n- Winner\n- Total Rounds\n- Winning Method\n- Winning Method (Double Chance)\n- Will the fight go the distance\n- Winner & exact rounds\n- Home competitor total head strikes\n- Away competitor total head strikes\n- Home competitor total head strikes at round\n- Away competitor total head strikes at round\n- Home competitor exact knockdowns at round\n- Away competitor exact knockdowns at round\n</details>\n\n<details>\n  <summary>`Tennis`</summary>\n- Winner\n- Winner - Xth set\n- Result - Games\n- Game handicap\n- Game handicap - Xth set\n- Set handicap\n- Total sets\n- Total games\n- Total games - Xth set\n- Home player total games\n- Away player total games\n- Home player to win a set\n- Away player to win a set\n- Set to nil\n- Tiebreak occurrence\n- Exact sets\n- Total games odd or even\n- Total games odd or even - Xth set\n- Correct score\n- Correct score - Xth set\n- Player to win Xth set\n</details>\n\n<details>\n  <summary>`Volleyball`</summary>\n- Winner\n- Set handicap\n- Point handicap\n- Total points\n- Total sets\n- Competitor1 total\n- Competitor2 total\n- Odd/even\n- Exact sets\n- Double result (1st set/match)\n- xth set - winner\n- xth set - point handicap\n- xth set - total points\n- xth set - odd/even\n- xth set - xth point\n- xth set - race to x points\n- Competitor1 to win a set\n- Competitor2 to win a set\n- Will there be a 4th set\n- Will there be a 5th set\n- How many sets decided by extra points\n- Competitor1 to win exactly 1 set\n- Competitor2 to win exactly 1 set\n- Competitor1 to win exactly 2 sets\n- Competitor2 to win exactly 2 sets\n</details>\n\n\nNotice that the above list contains the algorithm's **supported** markets.\nIt is the responsibility of the operator to provide VAIX with the\nmarkets listed, or at least a subset of them, in order for them to be used.\n\n{% endhint %}\n\n\n{% hint style=\"info\" %}\n\n## Personalized bet builder length\n\n\nThe option to dynamically calculate the bet builder's length based on the user's\npreferences is supported, using the `personalized_length` parameter. If used,\nthe length of each bet builder will be calculated based on the user's historical\npreferences and behavior.\n\nNotice that in that case, the given `length` parameter will be ignored.\n\n{% endhint %}\n\n\n{% hint style=\"info\" %}\n\n## Length of produced bet builder\n\n\nThere is the possibility that a bet builder with length less than the\nrequested one will be returned, in case the markets offered for the given\nevent are insufficient or not combinable.\n\nMostly applicable to cases where a big bet builder length is requested (> 6).\n\n{% endhint %}\n\n\n{% hint style=\"warning\" %}\n\n## Integration concerns\n\n\nThe bet builder related endpoints are guaranteed to return a valid bet builder\ncombination, including selections for markets the operator supports.\n\nNotice that no odds calculation is taking place, meaning that the overall odds\nof the bet builder coupon should be calculated from the client's existing bet builder logic.\n\n{% endhint %}\n\n\n{% hint style=\"info\" %}\n\n## Getting two recommender bet builders with 3 selections\n\n\nIn this example we get two recommender bet builders containing `3` selections each\nfor the event with id `sr:match:40781327`, for the user with id `1`.\n\n```bash\n$ curl --request GET \\\n  --url 'https://api.vaix.ai/api/sports/bet_builders/recommended?user=1&event_id=sr:match:40781327&length=3&count=2'\n```\n\n{% endhint %}\n\n","operationId":"get_recommended_bet_builders","parameters":[{"description":"Custom client header, the value should be the name of the group the user belongs to","in":"header","name":"x-vaix-client-id","required":true,"schema":{"type":"string"}},{"description":"Authentication method to be used, supported values [`vaix`, `iam`]. Defaults to `vaix`","in":"header","name":"x-vaix-authentication-method","required":false,"schema":{"type":"string"}},{"description":"The event id to get a bet builder for. If not set then the top `count` recommended events\nof the given `user` will be picked and bet builders for them will be generated.\n","in":"query","name":"event_id","required":false,"schema":{"type":"string"}},{"description":"How many bet builders to produce in total.","in":"query","name":"count","required":false,"schema":{"default":1,"maximum":20,"minimum":1,"type":"integer"}},{"description":" Optional upper limit to the amount of bet builders to generate per event.\n Since the number of bet builders to generate per event is dynamically calculated\n based on their confidence (so more bet builders are generated for highly recommended\n events), this parameter can be used to apply a limit, for example if one wants\n only one bet builder per event regardless of their personalization score. If not set,\n it will be ignored.\n","in":"query","name":"max_count_per_event","required":false,"schema":{"maximum":10,"minimum":1,"type":"integer"}},{"description":"The minimum event's starting datetime. If not explicitly set it defaults to `now`.","in":"query","name":"from","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Considers events starting after the from timestamp plus the given minutes/hours/days.\nIf not set defaults to `0 minutes`.\nThe value must be in range [-7d - 7d].\n","in":"query","name":"from_offset","required":false,"schema":{"default":"0","pattern":"^[+-]?[0-9]+([.][0-9]+)?[smhd]?$","type":"string"}},{"description":"Considers events starting till the `from` timestamp plus the given\nminutes/hours/days. If not set defaults to one day (24 hours).\nThe value must be in range [`-7d` - `7d`].\n","in":"query","name":"to_offset","required":false,"schema":{"default":"2d","pattern":"^[+-]?[0-9]+([.][0-9]+)?[smhd]?$","type":"string"}},{"description":"The bet builder length.","in":"query","name":"length","required":false,"schema":{"default":2,"maximum":10,"minimum":2,"type":"integer"}},{"description":"Optional filtering on the events and markets to consider. The event related filters are ignored\nin case the `event_id` parameter is provided. It expects a string adhering\nto the filtering format, as described in the filtering section, e.g. `market_status:eq:OPEN`.\n","in":"query","name":"filters","required":false,"schema":{"enum":["sport","sport_id","country","country_id","league","league_id","status","booking_status","event_type","participants","participant_ids","user_country","user_state","market","market_id","market_type","market_type_id","outcome","outcome_id","market_status","market_group_status","trade_status","trade_market_status","period_id","bet_builder","market_bet_builder","quote"],"type":"string"}},{"description":"If set to true, the odds of the bet builder will be calculated and included in the response.\nOnly applicable if configured for your token.\n","in":"query","name":"include_odds","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"If set to `true`, ensures that player props and team-level markets\nin each bet builder are aligned to the same team.\nTeam-neutral markets like totals (over/under) are always included.\n\nDefaults to `false`, where no such check is performed.\n","in":"query","name":"align_team_markets","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"If set to `true`, ensures that any player-specific selection in each\nbet builder is for the same player, while the remaining selections are\naligned to that player's team (when they are team-specific).\nTeam-neutral markets like totals (over/under) are always included.\n\nDefaults to `false`, where no such check is performed.\n","in":"query","name":"align_player_markets","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"If set to `true`, returns bet builders that only include player\nmarkets. Defaults to `false`.\n","in":"query","name":"only_player_markets","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"The user to get recommended bet builder for.","in":"query","name":"user","required":true,"schema":{"type":"string"}},{"description":"If `true`, calculates the bet builder's length dynamically based on user's preferences.\nNote that if set to `true` then it ignores the `length` parameter. Defaults to `false`.\n","in":"query","name":"personalized_length","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"The columns to sort the results by. It expects a string adhering to\nthe ordering format, as described in the ordering section, e.g.\n`+league_confidence,-sport_confidence`.\n","in":"query","name":"order_by","required":false,"schema":{"enum":["league_confidence","sport_confidence","country_confidence","begin"],"type":"string"}},{"description":"Optional selection of the object fields to retrieve. It expects a comma\nseparated list of strings, as described in the field selection section,\ne.g. `event_id,event_type`.\n","in":"query","name":"fields","required":false,"schema":{"default":["event_id","event_type","begin","country","country_id","league","league_id","sport","sport_id","participants","participant_ids","status","confidence","selection_id","bet_offer_id","market","market_id","market_type","market_type_id","uof_external_id","outcome","outcome_id","period","period_id","quote","quote_group","count","confidence"],"enum":["event_id","event_type","begin","country","country_id","league","league_id","sport","sport_id","participants","participant_ids","status","confidence","selection_id","bet_offer_id","market","market_id","market_type","market_type_id","uof_external_id","outcome","outcome_id","period","period_id","quote","quote_group","count","confidence"],"type":"string"}},{"description":"The operator to use for querying data. Notice that this is applied only\nif your account has access to multiple operators. In a different case\nthe assigned operator to your account is used and the value of this\nfield is ignored.\n","in":"query","name":"operator","required":false,"schema":{"type":"string"}},{"description":"The bookmaker id to use for querying data. Notice that this is applied only\nif your account has access to multiple operators. In a different case\nthe assigned operator to your account is used and the value of this\nfield is ignored. Note that this parameter is used together with the\n`sub_bookmaker_id` parameter.\n","in":"query","name":"bookmaker_id","required":false,"schema":{"type":"integer"}},{"description":"The sub-bookmaker id to use for querying data. Notice that this is applied only\nif your account has access to multiple operators. In a different case\nthe assigned operator to your account is used and the value of this\nfield is ignored. Note that this parameter is used together with the\n`bookmaker_id` parameter.\n","in":"query","name":"sub_bookmaker_id","required":false,"schema":{"type":"integer"}},{"description":"List of event types to consider when generating recommendations.\nOne or more types can be provided.\nAvailable options are:\n* `match`: Standard matches to be considered.\n* `seasonal`: Seasonal events to be considered.\n* `forced_events`: Handpicked events to be considered regardless of their start_time.\n","in":"query","name":"event_types","required":false,"schema":{"default":"match,forced_events","enum":["match","seasonal","forced_events"],"type":"string"}},{"description":"The location of the page where the request takes place.\n","in":"query","name":"location","required":false,"schema":{"type":"string"}},{"description":"Comma separated list of keywords. If given, this input will be used\nas user demographics data for the recommendations, e.g `country:gr,city:ath`.\n","in":"query","name":"raw","required":false,"schema":{"enum":["age_group","city","country"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"API response","properties":{"data":{"description":"Array of objects","items":{"$ref":"#/components/schemas/RecommendedBetBuilder"},"type":"array"},"status":{"description":"The status of the request","enum":["success","error"],"type":"string"}},"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Not Acceptable"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Request Entity Too Large"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityError"}}},"description":"Unprocessable Content"},"425":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Too Early"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal Server Error"}},"summary":"Get recommended bet builders","tags":["Bet Builders"]}}}}
````

## Get extended bet builders containing selections

> Returns bet builders that contain all of the given \`selection\_ids\`.\
> \
> In case of multiple input selection ids, the selection must be combinable,\
> otherwise an appropriate error message will be returned and no bet builders will be generated.\
> \
> The provided selections must belong to the same event. Bet builders are\
> generated using the same logic as the recommended bet builder endpoint,\
> starting from the provided selections and filling the remaining slots with valid,\
> recommended selections.\
> \
> {% hint style="info" %}\
> \
> \## Getting bet builders containing a selection\
> \
> \
> In this example we get 2 bet builders of length 3 that contain the selection with id\
> \`c495ac571a7e4ecf2014abd597d2c1aa\`.\
> \
> \`\`\`bash\
> $ curl --request GET \\\
> &#x20; \--url '<https://api.vaix.ai/api/sports/bet\\_builders/extended?user=12345\\&selection\\_ids=c495ac571a7e4ecf2014abd597d2c1aa\\&count=2\\&length=3'\\>
> \`\`\`\
> \
> {% endhint %}\ <br>

````json
{"openapi":"3.0.1","info":{"title":"","version":"0.1.0"},"tags":[{"description":"Sport bet builders related endpoints","name":"Bet Builders"}],"servers":[{"description":"Production API","url":"https://api.vaix.ai"},{"description":"Staging (integration) API","url":"https://staging-api.vaix.ai"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"scheme":"bearer","type":"http"}},"schemas":{"ExtendedBetBuilder":{"additionalProperties":false,"description":"A recommended bet builder object","properties":{"begin":{"description":"The starting time of the event in UTC","format":"date-time","type":"string"},"bet_builders":{"description":"List with the event's recommended bet builders","items":{"oneOf":[{"description":"The betbuilders with their odds","properties":{"odds":{"description":"The calculated odds for the bet builder","type":"number"},"selections":{"description":"The bet builder's selections","items":{"description":"A bet builder's selection","properties":{"bet_offer_id":{"description":"The event specific market id","nullable":true,"type":"string"},"count":{"description":"How many bets are placed on the market","type":"integer"},"market":{"description":"The market's name","nullable":true,"type":"string"},"market_id":{"description":"The `market`'s id","nullable":true,"type":"number"},"market_type":{"description":"The market's type","nullable":true,"type":"string"},"market_type_id":{"description":"The `market_type`'s id","nullable":true,"type":"number"},"outcome":{"description":"The selection's outcome","nullable":true,"type":"string"},"outcome_id":{"description":"The `outcome`'s id","nullable":true,"type":"number"},"period":{"description":"The selection's period","nullable":true,"type":"string"},"period_id":{"description":"The `period`'s id","nullable":true,"type":"number"},"quote":{"description":"The selection's quote","type":"number"},"quote_group":{"description":"The group the quote belongs to","type":"string"},"selection_id":{"description":"The market selection id","type":"string"},"side":{"description":"The side of the market, back or lay (exchange only)","type":"string"},"uof_external_id":{"description":"The external market id","nullable":true,"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},{"description":"Array of bet builder selections","items":{"description":"A bet builder's selection","properties":{"bet_offer_id":{"description":"The event specific market id","nullable":true,"type":"string"},"count":{"description":"How many bets are placed on the market","type":"integer"},"market":{"description":"The market's name","nullable":true,"type":"string"},"market_id":{"description":"The `market`'s id","nullable":true,"type":"number"},"market_type":{"description":"The market's type","nullable":true,"type":"string"},"market_type_id":{"description":"The `market_type`'s id","nullable":true,"type":"number"},"outcome":{"description":"The selection's outcome","nullable":true,"type":"string"},"outcome_id":{"description":"The `outcome`'s id","nullable":true,"type":"number"},"period":{"description":"The selection's period","nullable":true,"type":"string"},"period_id":{"description":"The `period`'s id","nullable":true,"type":"number"},"quote":{"description":"The selection's quote","type":"number"},"quote_group":{"description":"The group the quote belongs to","type":"string"},"selection_id":{"description":"The market selection id","type":"string"},"side":{"description":"The side of the market, back or lay (exchange only)","type":"string"},"uof_external_id":{"description":"The external market id","nullable":true,"type":"string"}},"type":"object"},"type":"array"}]},"type":"array"},"country":{"description":"The country the event takes place at","nullable":true,"type":"string"},"country_id":{"description":"The id of the country the event takes place at","nullable":true,"type":"string"},"event_id":{"description":"The unique event id","type":"string"},"event_type":{"description":"The type of the event, e.g. `outright","nullable":true,"type":"string"},"league":{"description":"The league associated with the current event","nullable":true,"type":"string"},"league_id":{"description":"The id of the event's league","nullable":true,"type":"string"},"participant_ids":{"description":"The id of the event participants","items":{"type":"string"},"nullable":true,"type":"array"},"participants":{"description":"The participants of the event","items":{"type":"string"},"nullable":true,"type":"array"},"sport":{"description":"The sport of the event, e.g. `soccer`","nullable":true,"type":"string"},"sport_id":{"description":"The id of the event's sport","nullable":true,"type":"string"},"status":{"description":"The status of the event, e.g. `live`","type":"string"}},"type":"object"},"Error":{"additionalProperties":false,"description":"The generic API's error response","properties":{"error":{"description":"Description of the error","type":"string"},"status":{"description":"response status","type":"string"}},"type":"object"},"Errors":{"additionalProperties":false,"description":"The generic API's errors response","properties":{"errors":{"description":"An object with the request errors","type":"object"}},"type":"object"},"UnprocessableEntityError":{"oneOf":[{"additionalProperties":false,"description":"The generic API's error response","properties":{"error":{"description":"Description of the error","type":"string"},"status":{"description":"response status","type":"string"}},"type":"object"},{"additionalProperties":false,"description":"The generic API's errors response","properties":{"errors":{"description":"An object with the request errors","type":"object"}},"type":"object"}]}}},"paths":{"/api/sports/bet_builders/extended":{"get":{"description":"Returns bet builders that contain all of the given `selection_ids`.\n\nIn case of multiple input selection ids, the selection must be combinable,\notherwise an appropriate error message will be returned and no bet builders will be generated.\n\nThe provided selections must belong to the same event. Bet builders are\ngenerated using the same logic as the recommended bet builder endpoint,\nstarting from the provided selections and filling the remaining slots with valid,\nrecommended selections.\n\n{% hint style=\"info\" %}\n\n## Getting bet builders containing a selection\n\n\nIn this example we get 2 bet builders of length 3 that contain the selection with id\n`c495ac571a7e4ecf2014abd597d2c1aa`.\n\n```bash\n$ curl --request GET \\\n  --url 'https://api.vaix.ai/api/sports/bet_builders/extended?user=12345&selection_ids=c495ac571a7e4ecf2014abd597d2c1aa&count=2&length=3'\n```\n\n{% endhint %}\n\n","operationId":"get_extended_bet_builders","parameters":[{"description":"Custom client header, the value should be the name of the group the user belongs to","in":"header","name":"x-vaix-client-id","required":true,"schema":{"type":"string"}},{"description":"Authentication method to be used, supported values [`vaix`, `iam`]. Defaults to `vaix`","in":"header","name":"x-vaix-authentication-method","required":false,"schema":{"type":"string"}},{"description":"Comma separated list of selection ids that must all belong to the same event.\nReturned bet builders will contain all of these selections.\n","in":"query","name":"selection_ids","required":true,"schema":{"type":"string"}},{"description":"How many bet builders to return.","in":"query","name":"count","required":false,"schema":{"default":1,"maximum":20,"minimum":1,"type":"integer"}},{"description":"The user to get recommended bet builder for.","in":"query","name":"user","required":true,"schema":{"type":"string"}},{"description":"The importance of user market preferences when combined\nwith the event weight (popular/trending markets of the event).\n","in":"query","name":"user_weight","required":false,"schema":{"default":0.95,"maximum":1,"minimum":0,"type":"number"}},{"description":"The bet builder length.","in":"query","name":"length","required":false,"schema":{"default":2,"maximum":10,"minimum":2,"type":"integer"}},{"description":"Optional filtering on the markets to consider. It expects a string adhering\nto the filtering format, as described in the filtering section, e.g. `market_status:eq:OPEN`.\n","in":"query","name":"filters","required":false,"schema":{"enum":["market","market_id","market_type","market_type_id","outcome","outcome_id","market_status","market_group_status","trade_status","trade_market_status","period_id","bet_builder","market_bet_builder","quote"],"type":"string"}},{"description":"The minimum confidence score for all selections to be considered.\nAny confidence lower than this will be shifted to `min_confidence`.\n","in":"query","name":"min_confidence","required":false,"schema":{"default":0.05,"maximum":1,"minimum":0,"type":"number"}},{"description":"The power to apply to the confidence scores. This is used to\nre-balance the confidence scores of the selections. Lower power\nmeans stronger re-balancing, bringing the confidence scores closer\nto each other.\n","in":"query","name":"power","required":false,"schema":{"default":0.6,"maximum":1,"minimum":0,"type":"number"}},{"description":"If set to `true`, ensures that player props and team-level markets\nin each bet builder are aligned to the same team.\nTeam-neutral markets like totals (over/under) are always included.\n\nDefaults to `false`, where no such check is performed.\n","in":"query","name":"align_team_markets","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"If set to `true`, ensures that any player-specific selection in each\nbet builder is for the same player, while the remaining selections are\naligned to that player's team (when they are team-specific).\nTeam-neutral markets like totals (over/under) are always included.\n\nDefaults to `false`, where no such check is performed.\n","in":"query","name":"align_player_markets","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"If set to `true`, returns bet builders that only include player\nmarkets. Defaults to `false`.\n","in":"query","name":"only_player_markets","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Optional selection of the object fields to retrieve. It expects a comma\nseparated list of strings, as described in the field selection section,\ne.g. `event_id,event_type`.\n","in":"query","name":"fields","required":false,"schema":{"default":["event_id","event_type","begin","country","country_id","league","league_id","sport","sport_id","participants","participant_ids","status","confidence","selection_id","bet_offer_id","market","market_id","market_type","market_type_id","uof_external_id","outcome","outcome_id","period","period_id","quote","quote_group","count","confidence"],"enum":["event_id","event_type","begin","country","country_id","league","league_id","sport","sport_id","participants","participant_ids","status","confidence","selection_id","bet_offer_id","market","market_id","market_type","market_type_id","uof_external_id","outcome","outcome_id","period","period_id","quote","quote_group","count","confidence"],"type":"string"}},{"description":"The operator to use for querying data. Notice that this is applied only\nif your account has access to multiple operators. In a different case\nthe assigned operator to your account is used and the value of this\nfield is ignored.\n","in":"query","name":"operator","required":false,"schema":{"type":"string"}},{"description":"The bookmaker id to use for querying data. Notice that this is applied only\nif your account has access to multiple operators. In a different case\nthe assigned operator to your account is used and the value of this\nfield is ignored. Note that this parameter is used together with the\n`sub_bookmaker_id` parameter.\n","in":"query","name":"bookmaker_id","required":false,"schema":{"type":"integer"}},{"description":"The sub-bookmaker id to use for querying data. Notice that this is applied only\nif your account has access to multiple operators. In a different case\nthe assigned operator to your account is used and the value of this\nfield is ignored. Note that this parameter is used together with the\n`bookmaker_id` parameter.\n","in":"query","name":"sub_bookmaker_id","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"additionalProperties":false,"description":"API response","properties":{"data":{"description":"Array of objects","items":{"$ref":"#/components/schemas/ExtendedBetBuilder"},"type":"array"},"status":{"description":"The status of the request","enum":["success","error"],"type":"string"}},"type":"object"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden"},"406":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Not Acceptable"},"413":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Request Entity Too Large"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityError"}}},"description":"Unprocessable Content"},"425":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Too Early"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal Server Error"}},"summary":"Get extended bet builders containing selections","tags":["Bet Builders"]}}}}
````


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sportradar.com/personalization/api-reference/sports/bet-builders.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
