Overview
Get detailed descriptions for wines base on the wine name. Customize the description's tone and length with the style and length parameters. Each request will deduct 1 credit from your available balance.
Request
Endpoint: | /v1/wine-description |
Method: | GET |
Headers: | Authorization: <Your-API-Key> |
When forming your request, include a JSON payload with the specific parameters:
{
"wine_name": "your_wine_name",
"style": "your_selected_style", // optional
"length": "your_selected_length" // optional
}
Parameters
wine_name (required): The name of the wine you want to describe, e.g., "Sancerre, de Ladoucette Comte Lafond, Loire Valley, France (2019)".
style (optional): Define the tone and character of the description. Options are:
ClassicCasualPoeticTechnicalHumorous
length (optional): Define the length of the description. Options are:
ShortMediumLong
Response
The API returns a wine description based on the provided wine name, style, and length. The response also indicates the number of tokens remaining.
Example Request Body
{
"wine_name": "Sancerre, de Ladoucette Comte Lafond, Loire Valley, France (2019)",
"style": "Casual",
"length": "Medium"
}
Expected Response
{
"description": "Think juicy blackberries with a splash of oak. It's your go-to wine for a relaxed evening.",
"tokens_remaining": 49
}
Best Practices for Wine Naming
Wine Producer/Domaine/Chateau
Wine Name or Vineyard (if applicable)
Varietal (especially for New World wines or if relevant)
Region or Appellation
Vintage (year)
For example:
Old World Example:
Domaine de la Romanée-Conti, La Tâche, Burgundy, 2019
New World Example:
Silver Oak, Cabernet Sauvignon, Alexander Valley, 2019