Kits

Create a kit

Registers a named grouping of items that go out together.

Tool
filmo_kits_create
Access: Write

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_kits_create",
    "arguments": {
      "name": "Example"
    }
  }
}

generated from the schema

Tags go by NAME and one that does not exist is created, unlike POST /api/v1/tags/{tagId}/assignments, which asks for an identifier. Returns the created kit.

Arguments

namestringRequired

Kit name.

Limits: min length 1

descriptionstring

Kit description.

imagestring

URL of the main image.

collectionIdstring

Collection it belongs to.

tagsstring[]

Tags by NAME; a name that does not exist is created.

idempotencyKeystring

Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.

Limits: min length 1, max length 255

ifMatchstring

Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.

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 POST /api/v1/kits.

  • Kits

    Create a kit

    Registers a named grouping of items that go out together.

  • 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?