API Overview

The Magnetite API is a RESTful service that allows you to generate personalized lead magnets programmatically.

Base URL

https://magnetite.ai/api

Authentication

All API requests require authentication using a Bearer token. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Get your API key from your project settings in the dashboard.

Available Endpoints

POST

/projects/generate

Generate a new lead magnet for a prospect

Creates a personalized lead magnet based on prospect information and returns a unique URL.

GET

/generation/:jobId/status

Check the status of a lead magnet generation job

Returns the current status and progress of a generation job.

GET

/leads/:leadId/job-status

Get job status by lead ID

Alternative endpoint to check status using the lead ID instead of job ID.

Request Format

All POST requests should use JSON format with the appropriate Content-Type header:

Content-Type: application/json

Response Format

All API responses are returned in JSON format. Successful responses include a success field set to true.

Success Response Example

{
  "success": true,
  "data": {
    // Response data
  }
}

Error Response Example

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Missing required field: email"
  }
}

Rate Limiting

API requests are rate limited to ensure fair usage:

Generation endpoint: 10 requests per minute
Status endpoints: 60 requests per minute

Rate limit information is included in response headers:

X-RateLimit-Limit: 10
X-RateLimit-Remaining: 9
X-RateLimit-Reset: 1642350000

Versioning

The API uses URL versioning. The current version is v1 and is included in the base URL. We'll maintain backward compatibility and announce any breaking changes well in advance.

Ready to start building?

Learn how to authenticate and make your first API call.

Authentication Guide →Generate Endpoint →