Skip to main content
POST
/
v3
/
designs
/
{editorId}
/
prompts
Send a prompt
curl --request POST \
  --url https://api.magicpatterns.com/api/v3/designs/{editorId}/prompts \
  --header 'Content-Type: application/json' \
  --header 'x-mp-api-key: <api-key>' \
  --data '
{
  "prompt": "Add a footer with three columns of links."
}
'
import requests

url = "https://api.magicpatterns.com/api/v3/designs/{editorId}/prompts"

payload = { "prompt": "Add a footer with three columns of links." }
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({prompt: 'Add a footer with three columns of links.'})
};

fetch('https://api.magicpatterns.com/api/v3/designs/{editorId}/prompts', 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}/prompts",
  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([
    'prompt' => 'Add a footer with three columns of links.'
  ]),
  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}/prompts"

	payload := strings.NewReader("{\n  \"prompt\": \"Add a footer with three columns of links.\"\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}/prompts")
  .header("x-mp-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"Add a footer with three columns of links.\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.magicpatterns.com/api/v3/designs/{editorId}/prompts")

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  \"prompt\": \"Add a footer with three columns of links.\"\n}"

response = http.request(request)
puts response.read_body
{
  "requestId": "<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."
}
{
  "error": "You do not have access to this resource."
}

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"

Body

application/json
prompt
string
required

Natural language description of the change to make.

Example:

"Add a footer with three columns of links."

Response

Prompt accepted. Generation runs in the background.

requestId
string

Opaque identifier for this generation run.