Tools reference/Blueprints

Blueprints tools.

A blueprint is a project saved so your organisation can install it again. Your AI tools can save a project as a blueprint (leaving out anything the key cannot read), search your organisation's private library, read a blueprint's questions and what it makes, and install it as a new project or as a folder in a project. A dry run shows what an install would make and changes nothing. An install is built out of sight and shown all at once, and can be undone for 30 days. A key must reach the place it installs into, and a key limited to some places cannot read the library.

The live list

Your AI tool can call searchTools with category: "blueprints" for the current list of these tools with every input. This page is the readable copy.

The tools

Every tool below keeps to the access of the key or sign-in that calls it, and to the person’s own role. A tool only sees the tools it may use.

  • getBlueprint

    Read one blueprint from your organisation's library: its versions and, for one version, its questions, parts and roles.

  • getBlueprintInstall

    Follow an install: its status, progress and report (what was made, what could not be carried, what Undo or Remove sample data kept), by installId or by the jobId installBlueprint returned.

  • installBlueprint

    Install a blueprint from your organisation's library as a new project in a workspace, or as a new folder in a project.

  • saveAsBlueprint

    Save a project, or chosen items in it, as a blueprint in your organisation's library, so it can be installed again.

  • searchBlueprints

    Find blueprints in your organisation's private library, by words and size.