Quickstart

For a visual run, bring your own Daytona and OpenAI keys. V1 has no getdesign run billing. You pay Daytona for browser capture and OpenAI for model usage. Run duration and provider costs vary by site.

Web

Open the dashboard, sign in, and save both provider keys under Settings → Provider keys. Then open Agent and paste a URL to generate a design.md.

API

curl "https://api.getdesign.app/v1/design?url=https://stripe.com" \
  -H "Authorization: Bearer $WORKOS_ACCESS_TOKEN" \
  -H "x-daytona-api-key: $DAYTONA_API_KEY" \
  -H "x-openai-api-key: $OPENAI_API_KEY" \
  -H "Accept: text/markdown" \
  -o stripe.design.md

Send a WorkOS access token plus the provider headers over HTTPS. There is no getdesign API key. See the API surface for JSON and progress events.

CLI

bunx @getdesign/cli https://stripe.com
bunx @getdesign/cli https://stripe.com --out stripe.design.md

Requires Bun, with DAYTONA_API_KEY and OPENAI_API_KEY set in your shell. No WorkOS token is needed. Default output is ./getdesign-runs/<slug>/design.md plus a sibling design.images/ folder. There is no interactive REPL.

SDK

bun add @getdesign/sdk

import { getDesign, streamDesign } from "@getdesign/sdk";

const options = {
  credentials: {
    daytonaApiKey: process.env.DAYTONA_API_KEY,
    openaiApiKey: process.env.OPENAI_API_KEY,
  },
};
const result = await getDesign("https://stripe.com", options);
console.log(result.markdown);

// Alternative: run with progress events instead.
for await (const event of streamDesign("https://stripe.com", options)) {
  if (event.type === "progress") console.log(event.event);
  if (event.type === "result") console.log(event.result.markdown);
  if (event.type === "error") throw new Error(event.error.error);
}

Run either example on a Bun server. Each call starts a separate provider-funded run. The SDK executes locally, not through the hosted API, and does not need a WorkOS token. It is not a browser or edge-runtime client. Visual results include result.images alongside the markdown.

Skill

Inside Claude Code, Codex, or Cursor:

npx skills add MohtashamMurshid/getdesign

Then ask your agent: “use the getdesign skill on https://linear.app”.

Next steps

• Bookmark Official URLs for every entry point (web app, docs, API, npm, GitHub).
• Learn what a design.md contains in Concepts.
• Pick a surface to go deeper: Web, API, CLI, SDK, Skill.
• Read the Next.js runtime notes before integrating.