> ## Documentation Index
> Fetch the complete documentation index at: https://magicpatterns.mintlify.site/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Resolve a Magic Patterns URL to an editor ID

> Given a Magic Patterns URL, returns the underlying `editorId`. Supports:

- Design URLs: `magicpatterns.com/c/<editorId>`
- Published URLs: `project-<slug>.magicpatterns.app`
- Canvas URLs: `magicpatterns.com/s/<canvasId>?nodeIds=<nodeId>`

Use this when a user shares a Magic Patterns link and you need the
`editorId` to call other endpoints.




## OpenAPI

````yaml openapi-v3.yml post /v3/designs/resolve-url
openapi: 3.0.3
info:
  title: Magic Patterns API (v3)
  version: 3.0.0
  description: |
    The Magic Patterns API v3 provides programmatic access to design generation,
    iteration, and code-level editing. v3 mirrors the surface of the Magic
    Patterns MCP server — a single key authenticates both transports.

    v3 bills against your normal Magic Patterns credit balance. There is no
    separate API subscription. Free tier users can call v3 up to their credit
    limit, identical to web and MCP usage.

    For the legacy v2 single-shot creation endpoint (separate $99/mo plan),
    see the v2 reference.
servers:
  - url: https://api.magicpatterns.com/api
security:
  - ApiKeyAuth: []
tags:
  - name: Health
  - name: Design Systems
  - name: Designs
  - name: Artifacts
paths:
  /v3/designs/resolve-url:
    post:
      tags:
        - Designs
      summary: Resolve a Magic Patterns URL to an editor ID
      description: |
        Given a Magic Patterns URL, returns the underlying `editorId`. Supports:

        - Design URLs: `magicpatterns.com/c/<editorId>`
        - Published URLs: `project-<slug>.magicpatterns.app`
        - Canvas URLs: `magicpatterns.com/s/<canvasId>?nodeIds=<nodeId>`

        Use this when a user shares a Magic Patterns link and you need the
        `editorId` to call other endpoints.
      operationId: resolveDesignUrlV3
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  description: A Magic Patterns design / published / canvas URL.
                  example: https://www.magicpatterns.com/c/abc123
      responses:
        '200':
          description: Resolved editor ID.
          content:
            application/json:
              schema:
                type: object
                properties:
                  editorId:
                    type: string
                    example: abc123
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  responses:
    BadRequest:
      description: Invalid or missing required input.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: The requested design or artifact does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
          example: You do not have access to this resource.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-mp-api-key
      description: >
        Magic Patterns API key. The same key authenticates v3 REST and the

        MCP server. Create one at
        https://www.magicpatterns.com/settings/api-keys.

````