StreamBIM icon

StreamBIM

StreamBIM API: projects, IFC files, IFC search, converter jobs, sync, users, workflows, topics, checklists, attachments, documents

Folder → Create

AI-generated

Summary

Create a new folder within a specified StreamBIM project, optionally setting its name, parent folder, and attached labels.

Inputs

  • Project Name or ID (required) — Select the project from your StreamBIM account, either by name from the loaded list or by specifying its ID via expression.
  • Use Raw JSON Body — Toggle to supply the full folder JSON:API body directly instead of using individual typed fields.
  • Name — Specify the display name of the new folder; used if not supplying raw JSON body.
  • Parent Folder Name or ID — Select the parent folder by name or ID (use '0' for root); relevant when not using raw JSON body.
  • Label Names or IDs — Choose one or more labels to attach to the folder by name or ID; used if not supplying raw JSON body.
  • Body — Provide a raw JSON:API body to create the folder directly, bypassing typed input fields.

Output shape

a single JSON object representing the created folder resource.

The returned folder object is the created folder's JSON:API representation as returned from StreamBIM's API. Pagination does not apply to this operation. Errors will be returned for invalid inputs or API failures.

Examples

Example 1: Create a folder named 'My Folder' under the root folder with two labels attached in a specified project.

Set Project Name or ID; UseRawJsonBody false; Name 'My Folder'; Parent Folder ID '0'; choose Label IDs from the available labels.

Links

Discussion