API Documentation

X-Api-Key: YOUR_API_KEY
Content-Type: application/json

{
  "url": "https://www.example.com/page",
  "user_email": "author@company.com"
}

{
  "status": "success",
  "url": "https://www.example.com/page",
  "schema_found": true,
  "schema_data": {
    "result": [
      {
        "@context": "https://schema.org",
        "@type": "WebPage",
        "name": "Page title",
        "description": "Page description"
      }
    ]
  },
  "schema_status": "approved",
  "site_id": 123,
  "site_name": "Example Site"
}

{
  "status": "success",
  "schema_found": false,
  "message": "Schema has not been created for this URL. Please click Generate Schema."
}

{
  "url": "https://www.example.com/page",
  "submitter_email": "author@company.com",
  "approver_email": "manager@company.com",
  "source": "aem"
}

{
  "url": "https://www.thermofisher.com/bindingsite/us/en/clinical-applications/monoclonal-gammopathies.html",
  "user_email": "author@company.com",
  "component": "faq"
}

{
  "status": "success",
  "rewrite_found": true,
  "component_found": true,
  "component": "faq",
  "payload": {
    "heading": "Frequently Asked Questions About Monoclonal Gammopathies",
    "heading_tag": "h2",
    "items": [
      {
        "question": "What are monoclonal gammopathies?",
        "answer": "Monoclonal gammopathies are disorders caused by clonal plasma cells that produce abnormal monoclonal immunoglobulins (M-proteins)."
      }
    ],
    "placement": "before_related"
  },
  "derived": false,
  "rewrite_status": "draft",
  "validation_passed": true
}

{
  "payload": {
    "h1": "Monoclonal Gammopathies: Types, Diagnosis, and Monitoring",
    "aeo_summary": "Monoclonal gammopathies are a group of plasma cell disorders...",
    "value_proposition": {
      "text": "Monoclonal gammopathies are a group of plasma cell disorders characterized by abnormal production of monoclonal immunoglobulins (M-proteins).",
      "word_count": 17
    }
  },
  "derived": true
}

{
  "status": "success",
  "rewrite_found": true,
  "component_found": false,
  "component": "cta",
  "message": "This rewrite has no cta component.",
  "components_present": ["h1", "aeo_summary", "faq", "hero", "page_properties"]
}

{
  "url": "https://www.thermofisher.com/bindingsite/us/en/clinical-applications/monoclonal-gammopathies.html",
  "user_email": "author@company.com",
  "include": ["hero", "faq", "page_properties", "related_articles"]
}

curl -X POST "https://satelliteai.io/api/external/get-rewrite-component" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{
    \"url\": \"https://www.example.com/page\",
    \"user_email\": \"author@company.com\",
    \"component\": \"faq\"
  }"

const BASE = 'https://satelliteai.io/api/external';

async function getRewriteComponent(url, userEmail, component) {
  const res = await fetch(`${BASE}/get-rewrite-component`, {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ url, user_email: userEmail, component })
  });
  const data = await res.json();
  if (!res.ok) throw new Error(data.error || `HTTP ${res.status}`);
  if (!data.rewrite_found || !data.component_found) return null;
  return data.payload;
}