Collections

Create a collection

Creates a node of the tree the catalog is organized by.

Tool

filmo_collections_create

Writecollections:write

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

{
  "structuredContent": {
    "data": {
      "id": "id_8f2a1c",
      "name": "Example",
      "entityType": "item"
    },
    "meta": {
      "idempotencyKey": "<the key you sent, or the one the server generated>",
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

entityType decides what the tree is of (items by default) and CANNOT be changed afterwards. Omit parentCollectionId for a top-level collection.

Arguments

namestringRequired

Collection name.

Limits: min length 1

descriptionstring

Collection description.

parentCollectionIdstring

Parent collection. Omit it for a top-level collection.

iconstring

Collection icon.

entityTypestring

What the collection groups. Defaults to "item". It cannot be changed afterwards.

Available options: item, space, vehicle, staff, service

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

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 collection.

namestring

Collection name.

entityTypestring

What the collection groups: item, space, vehicle, staff or service.

Available options: item, space, vehicle, staff, service

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/collections.

Collections
Create a collection
Creates a node of the tree the catalog is organized by.
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?

Result

Arguments

Result

The same operation by REST

Related pages

Create a collection

Safe writes

Errors