Getting started

​

Overview

• Create an account or sign in with Globus.
• Land on Home, where your projects are listed.
• Create your first Project.
• Open that project so you are ready to add data.

• Projects hold a body of work.
• Collections organize files inside a project.
• Assets are the individual records you upload or create.

• Email/password accounts must verify email before first sign-in.
• Globus sign-in uses your trusted identity provider and skips email verification.
• Uploading data, organizing files, search, and collaboration are covered in the next tutorials.

​

Optional: run the code examples

import os, requests

API   = os.environ.get("DATAERAI_SERVER", "https://<your-server>")
TOKEN = os.environ["DATAERAI_TOKEN"]

api = requests.Session()
api.headers.update({"Authorization": f"Bearer {TOKEN}"})

me = api.get(f"{API}/api/me/").json()
print("Signed in as", me["email"], "-", me["name"])

​

1. Sign in

1. Go to your Dataerai instance — you land on the Sign in page (/login).
2. Type your Email and Password, then click the purple Sign in button. (Forgot it? Use the Forgot password? link.)
3. To use an institutional identity instead, click Continue with Globus — this redirects you to Globus and returns you to the app once authorized.

me = api.get(f"{API}/api/me/").json()
print("Signed in as", me["email"])

​

2. Create an account

1. On the Sign in page, click the Sign up link (in Don’t have an account? Sign up) to open the create-account form at /signup.
2. Fill Full name, Email, Password, and Confirm password, then click Create account. (If the two passwords differ, the form shows Passwords do not match.)
3. You then see a Check your inbox confirmation. Click the verification link sent to your email, then use Back to sign in to return and sign in.

​

3. Your workspace

1. After signing in you arrive at Home. The header shows the Dataerai logo, a centered Search bar, a notifications bell, and the user account menu.
2. The main panel lists your Projects in a table with Name, Members, and Updated columns and an N results count. Each row is a folder icon, the project name, its member count, the last-updated date, and a star toggle.
3. Use Search at the top to jump to anything; click a project row to open it.

projects = api.get(f"{API}/api/projects/").json()
print(f"{len(projects)} projects")
for p in projects[:5]:
    print("-", p["name"], "|", p["id"])

​

4. Create your first project

1. On Home (the root view), click + New project in the top-right — it is only shown at the Home/root view.
2. In the Create project dialog, type a Name (required; placeholder Project name) and an optional Description (placeholder Project description).
3. Click Create (it shows Saving… while it saves). The new project appears in the Home list.
4. Click the new project’s row to open it. Inside a project the toolbar swaps to Upload, New collection, and New asset actions — the starting point for the next tutorials.

resp = api.post(f"{API}/api/projects/",
                json={"name": "My first project",
                      "description": "Created from the getting-started tutorial."})
resp.raise_for_status()                       # HTTP 201 Created
project = resp.json()
print("Created project:", project["id"])
print("Root collection:", project["root_collection_id"])

​

5. The SDK — your on-ramp to transfers

from dataerai import DataeraiClient

with DataeraiClient(binary_path="dataerai") as client:
    status = client.auth_status()
    print(f"Signed in as {status.user_email}; token expires {status.expires_at}")

​

Next steps

• Data and navigation
• Get data in and out
• Search & discover