Only this pageAll pages
Powered by GitBook
3 of 7

Developer Documentation

TomatoPy API Docs

Develop with the TomatoPy API

TomatoCookPizzaTasteHardwareModels

Tomato

Tomato acquisition and manipulation operations

Acquires virtual tomatoes

post
Body
varietystring · enumrequiredAvailable options:
ripenessnumber · max: 1required
weightnumberrequired
Responses
application/json
object[]optional
post
POST /v1/tomato/acquire HTTP/1.1
Host: api.tomatopy.example.com
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "variety": "San Marzano",
  "ripeness": 1,
  "weight": 1
}
[
  {
    "id": "text",
    "variety": "text",
    "ripeness": 1,
    "weight": 1,
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

Slices tomatoes to specified thickness

post
Body
tomato_idsstring[]required
methodstring · enumrequiredAvailable options:
sizestring · enumrequiredAvailable options:
consistencystring · enumrequiredAvailable options:
Responses
application/json
object[]optional
post
POST /v1/tomato/slice HTTP/1.1
Host: api.tomatopy.example.com
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "tomato_ids": [
    "text"
  ],
  "method": "dice",
  "size": "fine",
  "consistency": "uniform"
}
200

Successful slicing operation

[
  {
    "id": "text",
    "method": "text",
    "size": "text",
    "consistency": "text",
    "pieces": [
      {
        "id": "text",
        "size": 1,
        "weight": 1
      }
    ]
  }
]

Extracts juice with adjustable pressure

post
Body
tomato_idsstring[]required
pressurenumber · max: 1required
Responses
application/json
objectoptional
post
POST /v1/tomato/squeeze HTTP/1.1
Host: api.tomatopy.example.com
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "tomato_ids": [
    "text"
  ],
  "pressure": 1
}
200

Successful juice extraction

{
  "id": "text",
  "volume": 1,
  "concentration": 1,
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Cook

Cooking process operations

Simulates simmering process

post
Body
ingredientsobject[]required
temperaturenumberrequired
durationstringrequired
stirring_frequencystringoptional
Responses
application/json
objectoptional
post
POST /v1/cook/simmer HTTP/1.1
Host: api.tomatopy.example.com
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "ingredients": [
    {
      "id": "text",
      "name": "text",
      "amount": 1,
      "unit": "text",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "temperature": 1,
  "duration": "text",
  "stirring_frequency": "text"
}
200

Successful simmering process

{
  "id": "text",
  "name": "text",
  "ingredients": [
    {
      "id": "text",
      "name": "text",
      "amount": 1,
      "unit": "text",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "temperature": 1,
  "duration": "text",
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Virtually roasts ingredients

post
Body
ingredientsobject[]required
temperaturenumberrequired
durationstringrequired
turning_frequencystringoptional
Responses
application/json
object[]optional
post
POST /v1/cook/roast HTTP/1.1
Host: api.tomatopy.example.com
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "ingredients": [
    {
      "id": "text",
      "name": "text",
      "amount": 1,
      "unit": "text",
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "temperature": 1,
  "duration": "text",
  "turning_frequency": "text"
}
200

Successful roasting operation

[
  {
    "id": "text",
    "name": "text",
    "ingredients": [
      {
        "id": "text",
        "name": "text",
        "amount": 1,
        "unit": "text",
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "temperature": 1,
    "duration": "text",
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

Pizza

Pizza creation and baking operations

Creates virtual pizza foundations

post
Body
thicknessstring · enumrequiredAvailable options:
sizestring · enumrequiredAvailable options:
stylestring · enumrequiredAvailable options:
hydrationnumber · max: 1optional
fermentation_timestringoptional
flour_typestringoptional
salt_contentnumber · max: 1optional
Responses
application/json
objectoptional
post
POST /v1/pizza/base HTTP/1.1
Host: api.tomatopy.example.com
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "thickness": "thin",
  "size": "8inch",
  "style": "neapolitan",
  "hydration": 1,
  "fermentation_time": "text",
  "flour_type": "text",
  "salt_content": 1
}
200

Successfully created pizza base

{
  "id": "text",
  "thickness": "text",
  "size": "text",
  "style": "text",
  "hydration": 1,
  "fermentation_time": "text",
  "flour_type": "text",
  "salt_content": 1
}

Simulates baking a pizza

post
Body
pizza_idstringrequired
temperaturenumberrequired
durationstringrequired
rotation_frequencystringoptional
steam_injectionbooleanoptional
crust_developmentstring · enumoptionalAvailable options:
Responses
application/json
objectoptional
post
POST /v1/pizza/bake HTTP/1.1
Host: api.tomatopy.example.com
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "pizza_id": "text",
  "temperature": 1,
  "duration": "text",
  "rotation_frequency": "text",
  "steam_injection": true,
  "crust_development": "low"
}
200

Successfully baked pizza

{
  "id": "text",
  "base": {
    "id": "text",
    "thickness": "text",
    "size": "text",
    "style": "text",
    "hydration": 1,
    "fermentation_time": "text",
    "flour_type": "text",
    "salt_content": 1
  },
  "toppings": [
    {
      "id": "text",
      "name": "text",
      "amount": 1,
      "unit": "text",
      "distribution": "text"
    }
  ],
  "baking_parameters": {
    "temperature": 1,
    "duration": "text",
    "rotation_frequency": "text",
    "steam_injection": true,
    "crust_development": "text"
  },
  "quality_metrics": {
    "overall_score": 1,
    "crust_crispness": 1,
    "cheese_melt": 1,
    "topping_distribution": 1
  }
}

Taste

Taste testing and analysis operations

Analyzes the flavor profile of a dish

post
Body
dish_idstringrequired
depthstring · enumoptionalAvailable options:
include_aromabooleanoptional
include_texturebooleanoptional
Responses
application/json
objectoptional
post
POST /v1/taste/analyze HTTP/1.1
Host: api.tomatopy.example.com
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "dish_id": "text",
  "depth": "basic",
  "include_aroma": true,
  "include_texture": true
}
200

Successful taste analysis

{
  "id": "text",
  "sweetness": 1,
  "acidity": 1,
  "umami": 1,
  "aroma": {
    "intensity": 1,
    "complexity": 1,
    "primary_notes": [
      {
        "name": "text",
        "intensity": 1
      }
    ],
    "secondary_notes": [
      {
        "name": "text",
        "intensity": 1
      }
    ],
    "tertiary_notes": [
      {
        "name": "text",
        "intensity": 1
      }
    ]
  },
  "texture": {
    "firmness": 1,
    "juiciness": 1,
    "mouthfeel": 1,
    "structural_integrity": 1
  }
}

Compares flavor profiles of multiple dishes

post
Body
dish_idsstring[]required
metricsstring · enum[]required
Responses
application/json
objectoptional
post
POST /v1/taste/compare HTTP/1.1
Host: api.tomatopy.example.com
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "dish_ids": [
    "text"
  ],
  "metrics": [
    "sweetness"
  ]
}
200

Successful comparison

{
  "comparison_id": "text",
  "rankings": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "dish_id": "text",
        "score": 1
      }
    ]
  }
}

Hardware

Kitchen hardware integration operations

Gets status of kitchen hardware

get
Responses
application/json
objectoptional
get
GET /v1/hardware/status HTTP/1.1
Host: api.tomatopy.example.com
Accept: */*
200

Hardware status

{
  "ovens": [
    {
      "id": "text",
      "temperature": 1,
      "humidity": 1,
      "is_ready": true,
      "maintenance_needed": true
    }
  ],
  "stoves": [
    {
      "id": "text",
      "burners": [
        {
          "id": "text",
          "temperature": 1,
          "is_active": true
        }
      ],
      "is_ready": true,
      "maintenance_needed": true
    }
  ],
  "blenders": [
    {
      "id": "text",
      "speed": 1,
      "is_ready": true,
      "maintenance_needed": true
    }
  ]
}

Monitors hardware parameters

post
Body
equipment_idsstring[]required
parametersstring · enum[]required
durationstringrequired
Responses
application/json
objectoptional
post
POST /v1/hardware/monitor HTTP/1.1
Host: api.tomatopy.example.com
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "equipment_ids": [
    "text"
  ],
  "parameters": [
    "temperature"
  ],
  "duration": "text"
}
200

Monitoring data

{
  "monitoring_id": "text",
  "equipment_data": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": [
        1
      ]
    }
  }
}

Models

Models