Get design status
curl --request GET \
--url https://api.magicpatterns.com/api/v3/designs/{editorId}/status \
--header 'x-mp-api-key: <api-key>'import requests
url = "https://api.magicpatterns.com/api/v3/designs/{editorId}/status"
headers = {"x-mp-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-mp-api-key': '<api-key>'}};
fetch('https://api.magicpatterns.com/api/v3/designs/{editorId}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.magicpatterns.com/api/v3/designs/{editorId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-mp-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.magicpatterns.com/api/v3/designs/{editorId}/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-mp-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.magicpatterns.com/api/v3/designs/{editorId}/status")
.header("x-mp-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.magicpatterns.com/api/v3/designs/{editorId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-mp-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"isGenerating": true,
"activeArtifactId": "<string>",
"availableFiles": [
"<string>"
]
}{
"error": "You do not have access to this resource."
}{
"error": "You do not have access to this resource."
}{
"error": "You do not have access to this resource."
}{
"error": "You do not have access to this resource."
}Designs
Get design status
Returns the current state of a design: whether AI generation is in flight, the active artifact ID, and which files exist in that artifact.
Use this to poll after POST /v3/designs (with a prompt) or
POST /v3/designs/{editorId}/prompts. Poll no more than once every
60 seconds.
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>'import requests
url = "https://api.magicpatterns.com/api/v3/designs/{editorId}/status"
headers = {"x-mp-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-mp-api-key': '<api-key>'}};
fetch('https://api.magicpatterns.com/api/v3/designs/{editorId}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.magicpatterns.com/api/v3/designs/{editorId}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-mp-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.magicpatterns.com/api/v3/designs/{editorId}/status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-mp-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.magicpatterns.com/api/v3/designs/{editorId}/status")
.header("x-mp-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.magicpatterns.com/api/v3/designs/{editorId}/status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-mp-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"isGenerating": true,
"activeArtifactId": "<string>",
"availableFiles": [
"<string>"
]
}{
"error": "You do not have access to this resource."
}{
"error": "You do not have access to this resource."
}{
"error": "You do not have access to this resource."
}{
"error": "You do not have access to this resource."
}Authorizations
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
The design's editor ID.
Example:
"abc123"
Was this page helpful?