Create group
create_groupCreate an empty group inside a parent or the document default. Use to add a container for later population with objects.
Instructions
Create an empty <g> group inside parent_id (must exist) or the document default parent.
When to use: making an EMPTY group to populate later. To wrap EXISTING objects in a new group
use group_objects; to move one object into an existing group use reparent_object.
Key params: parent_id (must exist) or the document default parent; object_id to pin the id.
Return shape: CreateResult — object_id is the new group id, bbox=None (empty), plus the
pipeline fields (operation_id, snapshot_id, changed, preview).
Example: create_group(doc_id)
Render and look before you trust this edit: render with render_preview (or live_render_view)
and inspect the result before relying on it; restore_snapshot reverts it if it is wrong.
Risk class: medium (reversible write-new on the working copy; original untouched).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| doc_id | Yes | ||
| object_id | No | ||
| parent_id | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bbox | No | ||
| doc_id | Yes | ||
| changed | Yes | ||
| summary | No | ||
| object_id | Yes | ||
| snapshot_id | Yes | ||
| operation_id | Yes | ||
| preview_after | No | ||
| preview_before | No |