Skip to main content
GET
/
v3
/
designs
/
{editorId}
/
status
Get design status
curl --request GET \
  --url https://api.magicpatterns.com/api/v3/designs/{editorId}/status \
  --header 'x-mp-api-key: <api-key>'
{
  "isGenerating": true,
  "activeArtifactId": "<string>",
  "availableFiles": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://magicpatterns.mintlify.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-mp-api-key
string
header
required

Magic Patterns API key. The same key authenticates v3 REST and the MCP server. Create one at https://www.magicpatterns.com/settings/api-keys.

Path Parameters

​
editorId
string
required

The design's editor ID.

Example:

"abc123"

Response

Current design status.

​
isGenerating
boolean

True while AI generation is in flight.

​
activeArtifactId
string | null

The design's currently active artifact, or null if none.

​
availableFiles
string[]

File names in the active artifact.