Developer Documentation
INDEX MATRIX Public REST API (v1)
Automate URL imports, trigger technical SEO audits, and query indexing states via standard REST endpoints.
API Authentication
All requests to /api/v1/* require a valid API key passed either via the standard Authorization Bearer header or the custom x-api-key header.
curl -X GET "https://app.indexmatrix.io/api/v1/credits" \
-H "Authorization: Bearer im_live_your_api_key_here"
-H "Authorization: Bearer im_live_your_api_key_here"
POST /api/v1/urlsDeducts 1 Credit (if autoAnalyze=true)
Add URL & Optional Auto-Audit
Adds a URL to your project. When autoAnalyze: true is passed, performs an immediate SSRF-hardened technical SEO audit and returns full diagnostics.
// Request Body (JSON)
{
"projectId": "7c1264c8-2b81-49b8-a720-3ce48a7051ff",
"url": "https://example.com/blog/technical-seo",
"autoAnalyze": true
}
// Successful Response (200 OK)
{
"success": true,
"data": {
"id": "url_39108f9c",
"normalizedUrl": "https://example.com/blog/technical-seo",
"status": "ANALYZED",
"analysis": {
"httpStatus": 200,
"responseTimeMs": 142,
"robotsMeta": "index, follow",
"canonicalUrl": "https://example.com/blog/technical-seo",
"passedAudit": true,
"issues": []
}
}
}
Deterministic Error Codes
When an API error occurs, INDEX MATRIX returns a structured error object with an actionable code and explanation:
{
"success": false,
"error": {
"code": "INSUFFICIENT_CREDITS",
"message": "Not enough credits to auto-analyze URL."
}
}