Kits

Get a kit

Returns a kit by its identifier: name, description, image, collection and tags.

Tool
filmo_kits_get
Access: Read

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_kits_get",
    "arguments": {
      "kitId": "kit_8f2a1c"
    }
  }
}

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

kitIdstringRequired

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
idstring

Unique identifier of the kit.

namestring

Kit name.

descriptionstring | null

Kit description; null if it has none.

imagestring | null

URL of the main image; null if it has none.

collectionIdstring | null

Collection it belongs to; null if it is in none.

collectionNamestring | null

Full path of the collection; null if it is in none.

tagsobject[]

Kit tags, with their identifier and name.

Show child attributes
tags.idstring

Unique identifier of the tag.

tags.namestring

Tag name.

componentsobject[]

Items that make up the kit, in display order.

Show child attributes
components.itemIdstring

Identifier of the item; read it in /api/v1/items/{itemId}.

components.itemNamestring

Item name, as recorded when it was added to the kit.

components.variantIdstring | null

Variant of the item, if one was chosen; null otherwise.

components.variantNamestring | null

Name of that variant; null if none.

components.quantitynumber

How many units of the item the kit includes.

components.positionnumber | null

Display order inside the kit (0-based); null if not set.

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/kits/{kitId}.

  • Kits

    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: true and the problem in the first text block. Branch on its code.

Was this page helpful?