Skip to content

API

The API lives at api.getdesign.app. One endpoint, one response type: text/markdown.

GET https://api.getdesign.app/?url=<target>
Accept: text/markdown
Terminal window
curl "https://api.getdesign.app/?url=https://stripe.com" \
-H "Accept: text/markdown" \
-o stripe.design.md
NameTypeRequiredDescription
urlstringyesAbsolute URL to extract from. Must be publicly reachable.
viewportstringnoTarget viewport, e.g. 1440x900. Defaults to desktop.
  • 200 OK with Content-Type: text/markdown; charset=utf-8 and the full design.md body.
  • 400 Bad Request if url is missing or invalid.
  • 429 Too Many Requests if you exceed the public rate limit.
  • No authentication in v1.
  • The extractor renders the target in a real browser. First-run latency can be a few seconds.
  • Respect the target site’s terms when using the output.