For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Resources

Fork this repo Get a demo

Documentation API Reference

API Reference

plant
Add a new plant to the store
Update an existing plant
Search plants by status
Search plants by tags
Find plant by ID
Get care instructions for a plant
Get container information for a plant
user
Logs user into the system
Logs out current logged-in user session
Get user by username
CreatePlant
GetPlant
ListPlants
UpdatePlant
DeletePlant
SearchPlants

Resources

Fork this repo Get a demo

API Reference plantstore.v1 PlantService

CreatePlant

Example request

1 {
2   "name": "example",
3   "scientific_name": "example",
4   "description": "example",
5   "price_cents": 42,
6   "category": 0,
7   "care_difficulty": 0,
8   "light_requirement": 0,
9   "watering_frequency": 0,
10   "pet_friendly": true,
11   "stock_quantity": 42,
12   "image_urls": [
13     "example"
14   ]
15 }

Example response

1 {
2   "id": "example",
3   "name": "example",
4   "scientific_name": "example",
5   "description": "example",
6   "price_cents": 42,
7   "category": 0,
8   "care_difficulty": 0,
9   "light_requirement": 0,
10   "watering_frequency": 0,
11   "pet_friendly": true,
12   "stock_quantity": 42,
13   "image_urls": [
14     "example"
15   ],
16   "created_at": {
17     "seconds": 42,
18     "nanos": 42
19   },
20   "updated_at": {
21     "seconds": 42,
22     "nanos": 42
23   }
24 }

Create a new plant listing

Was this page helpful?

GetPlant

CreatePlantRequest

Request

This endpoint expects an object.

namestring

Common name of the plant

scientific_namestring

Scientific name

descriptionstring

Description

price_centsinteger

Price in cents

categoryenum

Category

care_difficultyenum

Care difficulty

light_requirementenum

Light requirement

watering_frequencyenum

Watering frequency

pet_friendlyboolean

Pet-friendly flag

stock_quantityinteger

Initial stock quantity

image_urlslist of strings

Image URLs

Plant

Response

This endpoint returns an object.

idstring

Unique identifier for the plant

namestring

Common name of the plant (e.g., “Snake Plant”)

scientific_namestring

Scientific name (e.g., “Sansevieria trifasciata”)

descriptionstring

Detailed description of the plant

price_centsinteger

Price in cents (e.g., 2999 = $29.99)

categoryenum

Category of the plant

care_difficultyenum

Care difficulty level

light_requirementenum

Light requirements

watering_frequencyenum

Watering frequency

pet_friendlyboolean

Whether the plant is pet-friendly

stock_quantityinteger

Current stock quantity

image_urlslist of strings

URLs to plant images

created_atobject

When the plant was added to the store

updated_atobject

When the plant information was last updated