Create a new artifact
curl --request POST \
--url https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts \
--header 'Content-Type: application/json' \
--header 'x-mp-api-key: <api-key>' \
--data '
{
"sourceArtifactId": "<string>",
"name": "Header tweaks"
}
'import requests
url = "https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts"
payload = {
"sourceArtifactId": "<string>",
"name": "Header tweaks"
}
headers = {
"x-mp-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-mp-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({sourceArtifactId: '<string>', name: 'Header tweaks'})
};
fetch('https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts', 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}/artifacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sourceArtifactId' => '<string>',
'name' => 'Header tweaks'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts"
payload := strings.NewReader("{\n \"sourceArtifactId\": \"<string>\",\n \"name\": \"Header tweaks\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-mp-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts")
.header("x-mp-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sourceArtifactId\": \"<string>\",\n \"name\": \"Header tweaks\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-mp-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sourceArtifactId\": \"<string>\",\n \"name\": \"Header tweaks\"\n}"
response = http.request(request)
puts response.read_body{
"artifactId": "<string>",
"files": [
"<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."
}{
"error": "You do not have access to this resource."
}Artifacts
Create a new artifact
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.
Use this to create a safe working branch before writing files — users can revert to the previous artifact if needed.
POST
/
v3
/
designs
/
{editorId}
/
artifacts
Create a new artifact
curl --request POST \
--url https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts \
--header 'Content-Type: application/json' \
--header 'x-mp-api-key: <api-key>' \
--data '
{
"sourceArtifactId": "<string>",
"name": "Header tweaks"
}
'import requests
url = "https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts"
payload = {
"sourceArtifactId": "<string>",
"name": "Header tweaks"
}
headers = {
"x-mp-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-mp-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({sourceArtifactId: '<string>', name: 'Header tweaks'})
};
fetch('https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts', 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}/artifacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sourceArtifactId' => '<string>',
'name' => 'Header tweaks'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts"
payload := strings.NewReader("{\n \"sourceArtifactId\": \"<string>\",\n \"name\": \"Header tweaks\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-mp-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts")
.header("x-mp-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sourceArtifactId\": \"<string>\",\n \"name\": \"Header tweaks\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-mp-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sourceArtifactId\": \"<string>\",\n \"name\": \"Header tweaks\"\n}"
response = http.request(request)
puts response.read_body{
"artifactId": "<string>",
"files": [
"<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."
}{
"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"
Body
application/json
Was this page helpful?
⌘I