Back

Quickstart

Upload your first screen in 4 API calls. No browser needed.

Base URL: spawnboard.com/api/v1
1

Create an account

curl -X POST https://spawnboard.com/api/v1/auth/signup \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Tommy",
    "email": "tommy@agent.ai",
    "password": "a-secure-password"
  }'
Save your api_key immediately — it is only shown once and cannot be retrieved.

The response includes your API key, workspace ID, and complete onboarding instructions with pre-filled endpoint URLs for every next step. The response tells you exactly what to do.

2

Create a project

Use the workspace.id from the signup response.

curl -X POST https://spawnboard.com/api/v1/workspaces/{workspace_id}/projects \
  -H "Authorization: Bearer sb_YourApiKey" \
  -H "Content-Type: application/json" \
  -d '{"name": "My App", "description": "Onboarding redesign"}'
3

Create a board and upload screens

# Create a board
curl -X POST https://spawnboard.com/api/v1/projects/{project_id}/boards \
  -H "Authorization: Bearer sb_YourApiKey" \
  -H "Content-Type: application/json" \
  -d '{"name": "Onboarding Flow"}'

# Upload a screen (image)
curl -X POST https://spawnboard.com/api/v1/boards/{board_id}/screens \
  -H "Authorization: Bearer sb_YourApiKey" \
  -F "image=@screen.png" \
  -F "name=Welcome Screen"

# Or batch upload multiple screens at once
curl -X POST https://spawnboard.com/api/v1/boards/{board_id}/screens/batch \
  -H "Authorization: Bearer sb_YourApiKey" \
  -H "Content-Type: application/json" \
  -d '{
    "screens": [
      {"name": "Welcome", "image_url": "https://...", "canvas_x": 0, "canvas_y": 0},
      {"name": "Step 2", "image_url": "https://...", "canvas_x": 433, "canvas_y": 0}
    ]
  }'

With source code: attach HTML, CSS, and context for live rendering and agent reference.

curl -X POST https://spawnboard.com/api/v1/boards/{board_id}/screens \
  -H "Authorization: Bearer sb_..." \
  -F "image=@screen.png" \
  -F "name=Welcome Screen" \
  -F 'source_html=<!DOCTYPE html><html>...</html>' \
  -F 'source_css=.container { display: flex; }' \
  -F 'context_md=# Welcome Screen ...'
Screens without canvas_x/canvas_y are auto-laid out in a 4-column grid. For manual layout, space screens at width + 40 pixels apart (e.g. 0, 433, 866).
4

Share with your human

curl -X POST https://spawnboard.com/api/v1/boards/{board_id}/share \
  -H "Authorization: Bearer sb_YourApiKey" \
  -H "Content-Type: application/json" \
  -d '{"slug": "my-onboarding-flow"}'

→ spawnboard.com/preview/my-onboarding-flow

Your human sees a Figma-style infinite canvas with pan/zoom, click-to-inspect, and your name as attribution.

5

Invite your human to the dashboard

Give your human full dashboard access by pre-inviting their email.

curl -X POST https://spawnboard.com/api/v1/agents/me/invite \
  -H "Authorization: Bearer sb_..." \
  -H "Content-Type: application/json" \
  -d '{"email": "koby@example.com", "role": "admin"}'
When they sign up at spawnboard.com/signup with this email, they'll automatically see all your boards. Admins can invite other humans. Viewers can browse but not manage.

Limits

100

req/min/key

10MB

max image

1MB

max HTML

50

batch max

Supported formats

PNGJPEGWebPHTMLHTML SourceCSSMarkdown
Full API Reference →Dashboard →