Write artifact files
curl --request PATCH \
--url https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts/{artifactId}/files \
--header 'Content-Type: application/json' \
--header 'x-mp-api-key: <api-key>' \
--data '
{
"files": [
{
"fileName": "App.tsx",
"code": "<string>"
}
]
}
'import requests
url = "https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts/{artifactId}/files"
payload = { "files": [
{
"fileName": "App.tsx",
"code": "<string>"
}
] }
headers = {
"x-mp-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-mp-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({files: [{fileName: 'App.tsx', code: '<string>'}]})
};
fetch('https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts/{artifactId}/files', 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/{artifactId}/files",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'files' => [
[
'fileName' => 'App.tsx',
'code' => '<string>'
]
]
]),
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/{artifactId}/files"
payload := strings.NewReader("{\n \"files\": [\n {\n \"fileName\": \"App.tsx\",\n \"code\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts/{artifactId}/files")
.header("x-mp-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"files\": [\n {\n \"fileName\": \"App.tsx\",\n \"code\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts/{artifactId}/files")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-mp-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"files\": [\n {\n \"fileName\": \"App.tsx\",\n \"code\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"files": [
"App.tsx",
"index.tsx",
"index.css"
]
}{
"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
Write artifact files
Creates or overwrites one or more files in an artifact. Files that already exist are replaced; new files are appended. Files not mentioned in the request are left untouched.
This only updates source files — it does not compile or publish.
Call POST /v3/designs/{editorId}/artifacts/{artifactId}/publish when
you’re done with all file changes to compile and set the artifact
active.
PATCH
/
v3
/
designs
/
{editorId}
/
artifacts
/
{artifactId}
/
files
Write artifact files
curl --request PATCH \
--url https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts/{artifactId}/files \
--header 'Content-Type: application/json' \
--header 'x-mp-api-key: <api-key>' \
--data '
{
"files": [
{
"fileName": "App.tsx",
"code": "<string>"
}
]
}
'import requests
url = "https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts/{artifactId}/files"
payload = { "files": [
{
"fileName": "App.tsx",
"code": "<string>"
}
] }
headers = {
"x-mp-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-mp-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({files: [{fileName: 'App.tsx', code: '<string>'}]})
};
fetch('https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts/{artifactId}/files', 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/{artifactId}/files",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'files' => [
[
'fileName' => 'App.tsx',
'code' => '<string>'
]
]
]),
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/{artifactId}/files"
payload := strings.NewReader("{\n \"files\": [\n {\n \"fileName\": \"App.tsx\",\n \"code\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts/{artifactId}/files")
.header("x-mp-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"files\": [\n {\n \"fileName\": \"App.tsx\",\n \"code\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.magicpatterns.com/api/v3/designs/{editorId}/artifacts/{artifactId}/files")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-mp-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"files\": [\n {\n \"fileName\": \"App.tsx\",\n \"code\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"files": [
"App.tsx",
"index.tsx",
"index.css"
]
}{
"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"
The artifact ID.
Body
application/json
Minimum array length:
1Show child attributes
Show child attributes
Response
Updated. Response lists all file names in the artifact after the write.
Example:
["App.tsx", "index.tsx", "index.css"]
Was this page helpful?