Skip to main content
POST
Create an object
Requires object_types:write, a verified administrator, and Objects enabled for the workspace. Creation adds an empty definition. It does not automatically add a Name attribute or create records. Add attributes through the API, MCP, or the Object’s Attributes tab in Manage. The agent can propose creation using object_types_request with an idempotency_key distinct from the object’s key.

Parameters

string
required
Immutable key (singular by convention), such as objects.purchase_order. Begins with objects., followed by a lowercase letter and lowercase letters, numbers, or underscores. Maximum 73 characters including the prefix. Must be unique within the workspace. The slug test and slugs beginning with test_ are reserved.
string
Immutable collection slug, such as purchase-orders. Defaults to the key’s plural form with hyphens. Lowercase letters, numbers, and single hyphens; starts with a letter. Maximum 100 characters. Must be unique within the workspace, including archived Objects. Supply an explicit slug when the default collides or does not match your preferred collection name.
string
required
Name for one record. Maximum 100 characters.
string
required
Name for the collection. Maximum 100 characters.
string
Defaults to regular/cube. Supported icons are:regular/cube, regular/users, regular/user, regular/building, regular/briefcase, regular/id-card, regular/handshake, regular/globe, regular/laptop, regular/mobile-screen, regular/server, regular/database, regular/code, regular/gear, regular/wrench, regular/camera, regular/folder, regular/file-lines, regular/file-contract, regular/clipboard-check, regular/graduation-cap, regular/book, regular/certificate, regular/lightbulb, regular/calendar, regular/clock, regular/location-dot, regular/plane, regular/truck, regular/box-archive, regular/tag, regular/cart-shopping, regular/wallet, regular/credit-card, regular/coins, regular/receipt, regular/chart-line, regular/shield-check, regular/heart, regular/leaf.
string
Optional description. Maximum 1,000 characters.

Returns

Returns the created Object definition.