Workspaces.build

Start here

What is workspaces.build
Quickstart
Core concepts
Glossary

Agent tiers

Tier model
Choosing a tier
Tier 0 — Lightest compute
Tier 1 — Code agent
Tier 2 — CLI agent
Tier 3 — Browser agent
Tier 4 — Computer-use agent

Architecture

System overview
Control plane
Data plane
Isolation runtimes
Scheduler and warm pools
Session lifecycle
Networking and egress
Storage, volumes, snapshots
Multi-region
Observability

Data model

Entities
Identifiers
State machines

API

Design principles
Authentication
Errors
Pagination and idempotency
Sessions
Runs and exec
Filesystem and ports
Browser control
Desktop control
Tools and MCP
Snapshots and volumes
Usage and billing
Webhooks
Rate limits

API reference

Overview
- List every invite sent for this projectGET
- Invite a teammatePOST

Billing

Metering model
Rate card
Quotas and limits
End-user billing
Invoices and credits

Dashboard

Surface map
Customer console
Infra console

Security

Isolation model
Policy engine
Secrets
Compliance

Operations

SLOs
Capacity planning
Runbooks
Incident response

Reference

Roadmap
Decision log
Changelog

Docs

Invite a teammate

POST/v1/invites

Request

Body

application/json

emailstring
The teammate's email address.
Example: "teammate@example.com"
rolestring
One of owner, admin, developer, operator, viewer. Defaults to viewer.
Example: "developer"

Responses

Created

Body

application/json

emailstringrequired
expires_atobjectrequired
idstringrequired
rolestringrequired
tokenstringrequired
Shown exactly once -- never retrievable again.

Body

{
  "email": "teammate@example.com",
  "role": "developer"
}

Request Sample: Shell / cURL

curl --request POST \
  --url https://api.workspaces.build/v1/invites \
  --header 'Accept: application/json, application/problem+json' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "teammate@example.com",
  "role": "developer"
}'

Response Example · 201

{
  "email": "string",
  "expires_at": {},
  "id": "string",
  "role": "string",
  "token": "string"
}