# Magic Patterns > Magic Patterns is the AI-native workspace for designing your product. Start from your existing product & design system. Plan, explore & design variants quickly, hand off to code. - [Welcome](https://www.magicpatterns.com/docs/documentation/get-started/introduction.md): The AI-native workspace for designing your product. Start from your existing product & design system.
Plan, explore & design variants quickly, hand off to code. - [Features](https://www.magicpatterns.com/docs/documentation/features/overview.md): Explore all the features Magic Patterns has to offer - [Subscription plans](https://www.magicpatterns.com/docs/documentation/plans-and-billing/subscription-plans.md): Compare the Free, Starter, Business, and Enterprise plans, and upgrade, downgrade, or cancel your workspace's subscription. - [Credits and usage](https://www.magicpatterns.com/docs/documentation/get-started/credits-and-billing.md): How your workspace's shared credit pool works, what uses credits, and when credits refresh. - [On-demand usage](https://www.magicpatterns.com/docs/documentation/plans-and-billing/on-demand-usage.md): Keep generating after your workspace's shared credit pool runs out with workspace or personal on-demand usage, and set a budget for extra spend. - [Invoices and billing](https://www.magicpatterns.com/docs/documentation/plans-and-billing/invoices-and-billing.md): Download invoices, update your payment method, and fix a failed payment. - [Troubleshooting](https://www.magicpatterns.com/docs/documentation/troubleshooting/overview.md): Helpful tips for resolving issues - [Common Questions](https://www.magicpatterns.com/docs/documentation/get-started/faq.md): Frequently Asked Questions about Magic Patterns - [Support](https://www.magicpatterns.com/docs/documentation/get-started/support.md): How to get help with Magic Patterns - [What is MagicOS](https://www.magicpatterns.com/docs/documentation/magic-os/overview.md) - [Build your first prototype](https://www.magicpatterns.com/docs/documentation/magic-os/quickstart.md): In this guide, learn how to start a new Magic OS Project and ask the agent to make a change. You don't need anything prepared, since you can start by describing what you want. - [Navigating MagicOS](https://www.magicpatterns.com/docs/documentation/projects/navigating.md): Getting around the MagicOS canvas - [The canvas and files](https://www.magicpatterns.com/docs/documentation/magic-os/canvas-and-files.md): Add canvases, prototypes, documents, images, and more to your MagicOS. - [Prototypes and frames](https://www.magicpatterns.com/docs/documentation/projects/prototyping.md): Use a prototype or a frame on the MagicOS canvas. - [Agents and threads](https://www.magicpatterns.com/docs/documentation/magic-os/agents-and-threads.md): Hand work to the coordinator, follow parallel threads, and answer agents when they need you. - [Using references](https://www.magicpatterns.com/docs/documentation/projects/using-references.md): Add work that's already on the canvas to your chat or thread. - [Copy a website with the Chrome extension](https://www.magicpatterns.com/docs/documentation/importing/chrome-extension.md): Copy any web page with the Magic Patterns extension, then paste it into a MagicOS project as a frame. - [How to prompt](https://www.magicpatterns.com/docs/documentation/editor/how-to-prompt.md): Tips for getting the design you want from the agent in MagicOS. - [Using prompt templates](https://www.magicpatterns.com/docs/documentation/projects/prompt-templates.md): Example prompts to copy into a MagicOS chat. - [Sharing a design](https://www.magicpatterns.com/docs/documentation/projects/how-to-share.md): Share your design with your team or your agents, or publish it to a live URL. - [Choose how to import](https://www.magicpatterns.com/docs/documentation/design-systems/importing/overview.md): Bring an existing design system into Magic Patterns - [Import from code](https://www.magicpatterns.com/docs/documentation/design-systems/importing/github.md): Link a GitHub repository or upload a zip of your component library - [Connect a GitHub repo](https://www.magicpatterns.com/docs/documentation/importing/connect-github.md): Connect a GitHub repo so the agent can build using your real code. - [Connect your production library](https://www.magicpatterns.com/docs/documentation/design-systems/importing/npm-package.md): A guided setup for the React component library your product already ships - [Publish your site](https://www.magicpatterns.com/docs/documentation/publishing/publish-url.md): Publish a MagicOS prototype to a live URL, then update or unpublish it - [Host on a custom domain](https://www.magicpatterns.com/docs/documentation/get-started/custom-domain.md): Publish your design on a domain you own, like example.com. - [Choose how to export](https://www.magicpatterns.com/docs/documentation/exporting/overview.md): Send your design to Figma, your codebase, or a coding agent. - [Connect your AI coding tool](https://www.magicpatterns.com/docs/documentation/features/mcp-server/overview.md): Workflow to go roundtrip between design and code - [Adapt a Magic Patterns prototype to your codebase](https://www.magicpatterns.com/docs/documentation/exporting/integration-skill.md): Teach your coding agent to adapt a Magic Patterns prototype. - [MCP Tools & Workflows](https://www.magicpatterns.com/docs/documentation/features/mcp-server/available_tools.md): Tools available from the Magic Patterns MCP server and how to use them - [Getting Started](https://www.magicpatterns.com/docs/api/getting-started.md): Programmatic access to Magic Patterns with the v3 API - [Health check](https://www.magicpatterns.com/docs/api/health.md): Returns `200 OK` only when the supplied API key is valid and active. Returns `401 Unauthorized` for invalid or missing keys. Use this to verify your key and connectivity before making real requests. - [List design systems](https://www.magicpatterns.com/docs/api/list-design-systems.md): Returns every design system accessible to the authenticated user — both built-in (reserved) systems (e.g. Base, Shadcn, MUI) and any custom systems the user owns or has been invited to. - [Create a design](https://www.magicpatterns.com/docs/api/create-design.md): Creates a new Magic Patterns design. - [Resolve a Magic Patterns URL to an editor ID](https://www.magicpatterns.com/docs/api/resolve-design-url.md): Given a Magic Patterns URL, returns the underlying `editorId`. Supports: - [Get design status](https://www.magicpatterns.com/docs/api/get-design-status.md): Returns the current state of a design: whether AI generation is in flight, the active artifact ID, and which files exist in that artifact. - [Send a prompt](https://www.magicpatterns.com/docs/api/send-prompt.md): Sends a natural-language prompt to update an existing design. Returns immediately with a `requestId`; the AI generation runs in the background. - [Read recent message history](https://www.magicpatterns.com/docs/api/get-design-messages.md): Returns the last 10 chat items for a design (user prompts, AI responses, artifact versions, manual edits). Use `?skip=N` to paginate backwards through older items. Page size is fixed at 10. - [List version history](https://www.magicpatterns.com/docs/api/get-design-versions.md): Returns the most recent 20 artifact versions for a design, with their artifact IDs, labels, and titles. Use `?skip=N` to paginate backwards. Page size is fixed at 20. - [Get the active artifact](https://www.magicpatterns.com/docs/api/get-active-artifact.md): Returns the design's currently active artifact — the one shown in the editor and preview. Includes the artifact ID and the list of file names in it. - [Create a new artifact](https://www.magicpatterns.com/docs/api/create-artifact.md): Creates a new artifact by cloning an existing one (typically the currently active artifact). The new artifact becomes the active artifact for the design and a new version entry is added to the timeline. - [Read artifact files](https://www.magicpatterns.com/docs/api/read-artifact-files.md): Returns the contents of one or more files in an artifact. Files that don't exist in the artifact are simply omitted from the response. - [Write artifact files](https://www.magicpatterns.com/docs/api/write-artifact-files.md): Creates or overwrites one or more files in an artifact. Files that already exist are replaced; new files are appended. Files not mentioned in the request are left untouched. - [Publish an artifact](https://www.magicpatterns.com/docs/api/publish-artifact.md): Compiles the artifact's source files and sets it as the active artifact for the design. This is the final step in a code-first workflow: after writing files, call this to make the changes visible in the editor and live preview. - [Team Workspaces](https://www.magicpatterns.com/docs/documentation/collaboration/team-workspaces.md): Invite team members, manage your brand context, and configure workspace settings. - [Sharing Designs](https://www.magicpatterns.com/docs/documentation/editor/sharing.md): How to share Magic Patterns designs - [Comments](https://www.magicpatterns.com/docs/documentation/collaboration/inline-comments.md): Leave feedback on prototypes, frames, and canvases. - [Enterprises](https://www.magicpatterns.com/docs/documentation/enterprise/overview.md): Overview of Magic Patterns for Enterprises - [Security](https://www.magicpatterns.com/docs/documentation/enterprise/security.md): Magic Patterns' security model includes many considerations and initiatives - [SSO, SCIM & Domain Setup](https://www.magicpatterns.com/docs/documentation/enterprise/sso-scim-setup.md): Learn how to set up Single Sign-On (SSO), SCIM directory sync, and domain capture for your workspace - [Not Receiving a Login Code](https://www.magicpatterns.com/docs/documentation/enterprise/email-deliverability.md): Troubleshoot missing Magic Patterns login code emails - [Changelog](https://www.magicpatterns.com/docs/documentation/feature-releases/changelog.md): View the latest updates and releases on Magic Patterns ## OpenAPI Specs - [openapi-v3](/docs/openapi-v3.yml) - [openapi](/docs/openapi.yml) ## Optional - [What's new in Magic Patterns](https://www.magicpatterns.com/docs/documentation/magic-os/overview) - [Using your design system](https://www.magicpatterns.com/docs/documentation/design-systems/importing/overview) - [Handing off to code](https://www.magicpatterns.com/docs/documentation/features/mcp-server/overview) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.