StudioHomepage
ServicesProjects

Create and manage Projects

Create a Project, list the Projects you can access, and delete a Project.

Available

Create a Project for each group of data that needs its own access and history, such as one per team, or one for production and one for experiments. You become the new Project's admin, so you can invite others straight away.

Prerequisites

  • You signed in to the Organization that owns the Project. See Sign in.
  • To create a Project, you have the Organization member or owner role.
  • The Organization has a storage default. See Storage.

Create a Project

Pass an optional description and an optional ID prefix. Spiral generates the Project ID. See Project IDs.

request = ProjectCreateProjectRequest(description="Robotics ingest", id_prefix="robotics")
project = client.projects.create_project(request).project
print(f"created {project.id} in {project.organization_id}")

You become a Project admin, and the Organization's other members get the default grants described in Access to a new Project.

In Spiral Studio:

  1. Select Create project from the Project list.
  2. Enter an optional description.
  3. Select Create project in the dialog. Studio opens the new Project.

List Projects

The list contains only the Projects that your identity can view.

for project in client.projects.list_projects_items():
    print(f"{project.id}: {project.description}")

Read one Project by ID:

curl https://api.spiraldb.dev/v1/projects/demo \
  -H "Authorization: Bearer $SPIRAL_TOKEN"

Delete a Project

Deleting a Project requires the Project admin role. The Project disappears from lists and the Project API no longer finds it by ID, so check that no pipeline still uses it first. There is no request to undo a deletion. Spiral does not delete the objects in the Project's bucket. A Project that owns Applications cannot be deleted; delete its Applications first.

client.projects.delete_project("demo")
print("deleted demo")

Troubleshooting

ErrorCauseFix
Project creation is disabled until your organization configures a storage default.The Organization has no storage default.Ask an Organization owner to configure storage.
Invalid project ID prefix.The prefix is empty, too long, or has characters other than lowercase letters, digits, and hyphens.Use at most 25 allowed characters.
Project creation uses the organization storage default.The request contains a filesystem field.Remove the field. Projects always use the Organization default.

Where next: grant access to the people and workloads that use the Project.

Found a problem? Edit this page or report an issue.

On this page