Resolve a Magic Patterns URL to an editor ID
curl --request POST \
--url https://api.magicpatterns.com/api/v3/designs/resolve-url \
--header 'Content-Type: application/json' \
--header 'x-mp-api-key: <api-key>' \
--data '
{
"url": "https://www.magicpatterns.com/c/abc123"
}
'import requests
url = "https://api.magicpatterns.com/api/v3/designs/resolve-url"
payload = { "url": "https://www.magicpatterns.com/c/abc123" }
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({url: 'https://www.magicpatterns.com/c/abc123'})
};
fetch('https://api.magicpatterns.com/api/v3/designs/resolve-url', 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/resolve-url",
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([
'url' => 'https://www.magicpatterns.com/c/abc123'
]),
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/resolve-url"
payload := strings.NewReader("{\n \"url\": \"https://www.magicpatterns.com/c/abc123\"\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/resolve-url")
.header("x-mp-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://www.magicpatterns.com/c/abc123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.magicpatterns.com/api/v3/designs/resolve-url")
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 \"url\": \"https://www.magicpatterns.com/c/abc123\"\n}"
response = http.request(request)
puts response.read_body{
"editorId": "abc123"
}{
"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
Resolve a Magic Patterns URL to an editor ID
Given a Magic Patterns URL, returns the underlying editorId. Supports:
- Design URLs:
magicpatterns.com/c/<editorId> - Published URLs:
project-<slug>.magicpatterns.app - Canvas URLs:
magicpatterns.com/s/<canvasId>?nodeIds=<nodeId>
Use this when a user shares a Magic Patterns link and you need the
editorId to call other endpoints.
POST
/
v3
/
designs
/
resolve-url
Resolve a Magic Patterns URL to an editor ID
curl --request POST \
--url https://api.magicpatterns.com/api/v3/designs/resolve-url \
--header 'Content-Type: application/json' \
--header 'x-mp-api-key: <api-key>' \
--data '
{
"url": "https://www.magicpatterns.com/c/abc123"
}
'import requests
url = "https://api.magicpatterns.com/api/v3/designs/resolve-url"
payload = { "url": "https://www.magicpatterns.com/c/abc123" }
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({url: 'https://www.magicpatterns.com/c/abc123'})
};
fetch('https://api.magicpatterns.com/api/v3/designs/resolve-url', 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/resolve-url",
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([
'url' => 'https://www.magicpatterns.com/c/abc123'
]),
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/resolve-url"
payload := strings.NewReader("{\n \"url\": \"https://www.magicpatterns.com/c/abc123\"\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/resolve-url")
.header("x-mp-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://www.magicpatterns.com/c/abc123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.magicpatterns.com/api/v3/designs/resolve-url")
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 \"url\": \"https://www.magicpatterns.com/c/abc123\"\n}"
response = http.request(request)
puts response.read_body{
"editorId": "abc123"
}{
"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.
Body
application/json
A Magic Patterns design / published / canvas URL.
Example:
"https://www.magicpatterns.com/c/abc123"
Response
Resolved editor ID.
Example:
"abc123"
Was this page helpful?
⌘I