Kits
Get a kit
Returns a kit by its identifier: name, description, image, collection and tags.
kits:readResult
generated from the schema
It does NOT return the items that compose it — the internal read does not guarantee them, and publishing a field that is sometimes missing is worse than not publishing it.
Arguments
Kit identifier.
Limits: min length 1
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique identifier of the kit.
Kit name.
Kit description; null if it has none.
URL of the main image; null if it has none.
Collection it belongs to; null if it is in none.
Full path of the collection; null if it is in none.
Items that make up the kit, in display order.
Show child attributesHide child attributes
Identifier of the item; read it in /api.
Item name, as recorded when it was added to the kit.
Variant of the item, if one was chosen; null otherwise.
Name of that variant; null if none.
How many units of the item the kit includes.
Display order inside the kit (0-based); null if not set.
Creation date in ISO 8601 UTC.
Last modification date in ISO 8601 UTC.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs GET /api/v1/kits/{kitId}.
Related pages
Link to this section: Related pagesKits
Get a kit
Returns a kit by its identifier: name, description, image, collection and tags.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?