StreamBIM icon

StreamBIM

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

Document → Create

AI-generated

Summary

Create a new document in a specified StreamBIM project and folder, optionally attaching labels and providing a filename and description, or supply the full JSON:API body for advanced control.

Inputs

  • Project Name or ID (required) — Select the target StreamBIM project by name or ID where the document will be created, loaded dynamically from your account region credential.
  • Use Raw JSON Body — Toggle to either enter the entire JSON:API request body manually or use typed fields for common document attributes.
  • Filename (required) — Name of the document file including extension (e.g., drawing.pdf). Used if not supplying raw JSON body.
  • Description — Optional textual description of the document.
  • Folder Name or ID (required) — Select the folder within the chosen project where the document will be stored, loaded dynamically or specified by ID.
  • Label Names or IDs — Optionally attach one or more labels to the new document by choosing from the list or specifying IDs.
  • Body (required) — Raw JSON:API formatted document body to create or update a document, used only if 'Use Raw JSON Body' is enabled.

Output shape

a single JSON:API formatted record representing the newly created document

The created document data conforms to the StreamBIM JSON:API format. Use the Use Raw JSON Body toggle to switch between simple typed field inputs and full API body input. Ensure project, folder, and required fields are correctly specified to avoid errors.

Examples

Example 1: Create with typed fields

Select a project and folder, specify filename and optional description, add labels if needed, then run to create the document.

Example 2: Create with raw JSON body

Enable 'Use Raw JSON Body' and provide the full JSON:API document object including attributes and relationships, useful for advanced cases.

Links

Discussion