Client Analysis API

The Client Analysis API allows external services to trigger comprehensive client analysis programmatically. The analysis includes:

• Background market research
• SEO competitor analysis
• SEO diagnosis and recommendations
• Keyword clustering
• Query strategies
• AI visibility assessment
• Opportunity and feasibility summary

All endpoints require authentication via the X-API-Key header:

curl -X POST https://www.enception.ai/api/external/client-analysis/start \
  -H "X-API-Key: $CLIENT_ANALYSIS_SERVICE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"website_url": "https://example.com", ...}'

We support callback notifications when analysis completes. For callback integration details, please contact us at quanlai@enception.ai.

1. Start Analysis: POST to /start with website details and email. Save the returned id.
2. Wait for Callback: We will call your callback endpoint when the analysis completes. Alternatively, you can poll /status every 30-60 seconds.
3. Download Report: Use the fileUrl from the callback, or GET the PDF from /report/{id}.

Example Integration (Node.js)

const API_KEY = process.env.CLIENT_ANALYSIS_SERVICE_TOKEN;
const BASE_URL = 'https://www.enception.ai/api/external/client-analysis';

// Start analysis with callback email
async function startAnalysis(params) {
  const startRes = await fetch(`${BASE_URL}/start`, {
    method: 'POST',
    headers: {
      'X-API-Key': API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      ...params,
      email: 'user@example.com', // We'll call your callback when done
    }),
  });
  const { id } = await startRes.json();
  console.log(`Analysis started: ${id}`);
  return id;
}

// Your callback handler (receives POST when analysis completes)
// POST /api/agent/callback with: email, id, fileUrl
async function handleCallback(req) {
  const { email, id, fileUrl } = req.body;

  // Download the PDF report
  const pdfRes = await fetch(fileUrl, {
    headers: { 'X-API-Key': API_KEY },
  });
  const pdfBuffer = await pdfRes.arrayBuffer();
  // Save or process the PDF...
}

// Alternative: Poll for status (if not using callback)
async function pollStatus(id) {
  const statusRes = await fetch(`${BASE_URL}/status`, {
    method: 'POST',
    headers: {
      'X-API-Key': API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ id }),
  });
  return await statusRes.json();
}