> ## 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.

# Get the active artifact

> 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.

Because the active artifact can change (the user may select a different
version in the UI, or AI generation may produce a new artifact),
always call this (or `GET /v3/designs/{editorId}/status`) to get the
latest active artifact before working with files.




## OpenAPI

````yaml openapi-v3.yml get /v3/designs/{editorId}/active-artifact
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/{editorId}/active-artifact:
    get:
      tags:
        - Artifacts
      summary: Get the active artifact
      description: |
        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.

        Because the active artifact can change (the user may select a different
        version in the UI, or AI generation may produce a new artifact),
        always call this (or `GET /v3/designs/{editorId}/status`) to get the
        latest active artifact before working with files.
      operationId: getActiveArtifactV3
      parameters:
        - $ref: '#/components/parameters/EditorId'
      responses:
        '200':
          description: Active artifact summary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ArtifactSummary'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  parameters:
    EditorId:
      name: editorId
      in: path
      required: true
      description: The design's editor ID.
      schema:
        type: string
        example: abc123
  schemas:
    ArtifactSummary:
      type: object
      properties:
        artifactId:
          type: string
        files:
          type: array
          items:
            type: string
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
          example: You do not have access to this resource.
  responses:
    Unauthorized:
      description: Missing or invalid API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: The caller does not have access to this resource.
      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'
  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.

````