Skip to main content

๐Ÿ“ Step 1 โ€” Claim your workspace

  1. Sign in or create a Planetary account at https://planetaryapp.us/login.
  2. Create your workspace and copy the workspace ID displayed on the first dashboard card.
  3. Store your API key via Workspace settings โ†’ Public API so you can authenticate requests.
Storing API keys in a secrets manager (e.g., GitHub Secrets) protects you from accidental leaks and keeps the key rotation process painless.

โšก Step 2 โ€” Choose your deployment option

Each lane shares the same admin experiences, so you can prototype on Planetary Cloud and migrate to Vercel or self-host later.

๐Ÿงช Step 3 โ€” Test the API in 3 minutes

GET https://api.planetaryapp.us/v1/workspace/<workspace-id>/info
Authorization: Bearer orbit_{YOUR_API_KEY}
Replace <workspace-id> with the value from Step 1 and keep your key secret. Rotate keys if you suspect a compromise.

โœ… Step 4 โ€” Invite collaborators

  • Go to Workspace โ†’ Members โ†’ Invites and send magic links or set role-based permissions.
  • For APIs, include the role field when creating a member to control access (see the Workspaces guides).
  • Enable two-factor authentication for admins in Workspace โ†’ Security for extra protection.

๐Ÿ“‚ Next stops