Manage Spaces

A Space is a workspace where your team can collaborate to create, manage, and publish content. Marketers, writers, and designers can work with the graphical user interface while developers can integrate their code base, including custom components for non-coding teammates to use.

This document covers the basics of using a Builder Space.

Prerequisites

You'll get the most out of this document if you are familiar with Understanding Spaces, which covers the concepts behind Spaces.

Create a Space

To create a Space:

Log in to Builder.
Hover over the Builder logo in the upper left corner to expand the left side bar.
Click the down arrow.
Hover over the Organization and click the Go button.
In the Organization tab, click the New Space button.
In the dialogue that opens, name the Space and choose Fusion or Publish as the type of Space you want.

The following video shows using these steps to go to an Organization called Free Tier Demos and creating a new Space called My New Space. This example creates a Fusion Space but also shows that you could select a Publish Space.

Access a Space

To go to a Space:

Log in to Builder.
Hover over the Builder logo in the upper left corner to expand the left side bar.
Click the down arrow.
Hover over the Organization to display its Spaces.
Click on the Space you'd like to access.

The following video shows using these steps to access one Space called Docs Demo and then switch to another Space in the same Organization called Another Space.

If the Space you need isn't in the list but does exist in that Organization, contact your team's Admin to make sure they've added you to the Organization and Space.

If you're using the Builder Shopify app, each store is a separate Space. When you install the app on your store, a Builder Space is automatically created.

Link directly to a space with `useSpace`

You can share a link that automatically switches the recipient into a specific space or environment when they open it. Append useSpace to any Builder dashboard URL:

https://builder.io/<path>?useSpace=<PUBLIC_API_KEY>

Replace <PUBLIC_API_KEY> with the Public API Key of the target Space or environment. Space keys as well as Environment keys are supported. Users can find their Public API Key under Account Settings.

useSpace is stripped from the URL once it's been handled, so the resulting address stays clean.

Examples

Goal	URL to share
Open the content list in a specific Space	`https://builder.io/content?useSpace=SPACE_API_KEY`
Open the models list in a specific environment	`https://builder.io/models?useSpace=ENV_API_KEY`
Open a specific model in a specific space	`https://builder.io/models/page?useSpace=SPACE_API_KEY`
Combine with other route parameters	`https://builder.io/content?model=page&useSpace=SPACE_API_KEY`

This works on any dashboard route. Add it alongside whatever other query parameters the destination page already uses.

What happens for the recipient

Already a member of the target space: Builder switches into that space and opens the linked page.
Not a member, but eligible to join: if the target Space allows self-join for members of its parent Organization, and the recipient belongs to that org, Builder adds them and opens the page.
Not signed in: the target space and path are remembered through sign-in/sign-up, then applied automatically afterward.
No path to the Space: if the recipient isn't a member and can't self-join, the parameter is ignored and they land on their current Space. Send an invite instead.

Choose where the link lands

Link to a specific path, such as /content or /models, if you want the recipient to land on that exact screen after the switch. If you link to /, /login, or /signup instead, Builder applies only the Space switch, since there's no specific page to route to. The recipient lands on their default page inside the target Space rather than a particular screen.

One-time use

useSpace only triggers once. After Builder applies the switch, reloading the page won't re-trigger it.

Note that sharing a useSpace link does not grant access. The recipient still needs to be signed in and either already be a member of the target Space or be eligible to self-join it.

Copy content from one Space to another

If you have more than one Space, you can copy content between those two Spaces.

To copy a content entry from one Space to another:

From the content entry, click the three dots in the top right corner and select Copy to another space.
Choose the Space to which you want to add the content. This will automatically route you to the space.
You can now create a new content entry or select an existing entry to copy the content into. If you want to make a new content entry, click + New and select the type of content entry to create.
Name your new entry and choose the blank template.
When the new page opens, click Copy content in the bottom right corner to paste in the copied content.

If this is content you want to reuse frequently, you can save time by saving it as a template. See Creating Templates for specific instructions.

The following video demonstrates these steps to copy a full Page of content from one Space to another:

Archive a Space

Important: Archiving a Space cannot be undone.

To archive a Space:

Go to Space Settings for the Space you want to archive.
Click on the three dots at the upper right.
Select Archive.
Click the OK button to confirm.

The next video shows this process.

Copy a Space

Enterprise plans

You can duplicate an entire Space, including all of its content and models within the Builder UI or with the API.

Copy a Space in Builder

To copy a Space in the Builder UI:

Go to the Settings for the Space you want to copy.
Click the three dots to the upper right and select Duplicate Space.
Name the new Space.
Click the Duplicate Space button.
Builder provides a dialogue letting you know that the Space is being copied. Click the Close button.
The new Space appears in the flyout menu. Select your new Space to enter it.

The next video shows copying a Space and entering that Space to show the same content and models:

Copy a Space with code

To copy a Space programmatically:

Create a new Space so you have somewhere to copy the existing Space to.
Create a Private API Key within the new Space.
Use the following code:

{ headers: { Authorization: 'bpk-private-key' }, method: 'POST', body: { spaceId: 'apiKey' name: 'name of new space' } }

This code represents the following:

Request headers: Include the Authorization header in the request with a value of 'bpk-private-key'. This indicates that you are using a Private API Key.
Request method: Use the POST method to send the request.
Request body: The request body is in JSON format and include the following properties:
spaceId: Replace apiKey with the actual API key or space ID of the space you want to copy.
name: Replace 'name of new space' with the name of the new space you want to create.

4. Make your POST request to the API endpoint as follows:

https://cdn.builder.io/api/v1/copy-space/create-space?apiKey={apiKey}

Was this article helpful?