Node.js SDK (builds with queued edits)
import Migma from 'migma';
const migma = new Migma('YOUR_API_KEY');
const polled = await migma.emails.getEditStatus('EMAIL_ID', 'EDIT_ID');
if (polled.error) throw polled.error;
const status = polled.data;
if (status.status === 'completed' && status.result) console.log(status.result.html);
if (status.status === 'failed') {
console.error(status.error, status.changesMayHaveBeenSaved);
// Inspect the stored email before starting another edit.
}
curl 'https://api.migma.ai/v1/emails/EMAIL_ID/edits/EDIT_ID' \
-H 'Authorization: Bearer YOUR_API_KEY'
import requests
url = "https://api.migma.ai/v1/emails/{emailId}/edits/{editId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.migma.ai/v1/emails/{emailId}/edits/{editId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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.migma.ai/v1/emails/{emailId}/edits/{editId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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.migma.ai/v1/emails/{emailId}/edits/{editId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.migma.ai/v1/emails/{emailId}/edits/{editId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"editId": "<string>",
"emailId": "<string>",
"conversationId": "<string>",
"status": "pending",
"stage": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"pollAfterMs": 123,
"error": "<string>",
"changesMayHaveBeenSaved": true,
"result": {
"id": "<string>",
"emailId": "<string>",
"conversationId": "<string>",
"messageId": "<string>",
"slotIdx": 123,
"slotUuid": "<string>",
"status": "<string>",
"subject": "<string>",
"preheader": "<string>",
"html": "<string>",
"thumbnailUrl": "<string>",
"warnings": [
"<string>"
],
"updatedAt": "2023-11-07T05:31:56Z",
"screenshotUrl": "<string>"
}
},
"error": "<string>"
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}Get Email Edit Status
Get the exact queued edit status. Requires email:read and ownership of the email. A completed response includes the current saved Email in result. A failed response includes error and changesMayHaveBeenSaved; inspect the stored email before starting another edit. Failed or stalled jobs are not automatically rewritten. Do not infer this edit’s status from conversation generation status.
GET
/
v1
/
emails
/
{emailId}
/
edits
/
{editId}
Node.js SDK (builds with queued edits)
import Migma from 'migma';
const migma = new Migma('YOUR_API_KEY');
const polled = await migma.emails.getEditStatus('EMAIL_ID', 'EDIT_ID');
if (polled.error) throw polled.error;
const status = polled.data;
if (status.status === 'completed' && status.result) console.log(status.result.html);
if (status.status === 'failed') {
console.error(status.error, status.changesMayHaveBeenSaved);
// Inspect the stored email before starting another edit.
}
curl 'https://api.migma.ai/v1/emails/EMAIL_ID/edits/EDIT_ID' \
-H 'Authorization: Bearer YOUR_API_KEY'
import requests
url = "https://api.migma.ai/v1/emails/{emailId}/edits/{editId}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.migma.ai/v1/emails/{emailId}/edits/{editId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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.migma.ai/v1/emails/{emailId}/edits/{editId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<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.migma.ai/v1/emails/{emailId}/edits/{editId}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.migma.ai/v1/emails/{emailId}/edits/{editId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"editId": "<string>",
"emailId": "<string>",
"conversationId": "<string>",
"status": "pending",
"stage": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"pollAfterMs": 123,
"error": "<string>",
"changesMayHaveBeenSaved": true,
"result": {
"id": "<string>",
"emailId": "<string>",
"conversationId": "<string>",
"messageId": "<string>",
"slotIdx": 123,
"slotUuid": "<string>",
"status": "<string>",
"subject": "<string>",
"preheader": "<string>",
"html": "<string>",
"thumbnailUrl": "<string>",
"warnings": [
"<string>"
],
"updatedAt": "2023-11-07T05:31:56Z",
"screenshotUrl": "<string>"
}
},
"error": "<string>"
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}{
"success": false,
"error": "<string>",
"code": "<string>",
"data": {}
}Authorizations
API key authentication. Use 'Authorization: Bearer YOUR_API_KEY' where YOUR_API_KEY is obtained from the Migma dashboard under Settings → Developers → API Keys.
Path Parameters
Email ID used to start the edit.
Pattern:
^[0-9a-fA-F]{24}$Edit job ID returned by the async edit request.
Pattern:
^[a-f0-9-]{32,64}$Last modified on September 30, 2026
Was this page helpful?