AIRM API Reference
Signal Neural AIRM (AI Reach Management) API gives you programmatic access to our GEO telemetry, AI crawler detection, injection payloads, and LLM citation monitoring. Automate your GEO strategy and integrate with your existing infrastructure.
Base URL & Authentication
All API requests must be made over HTTPS to our production endpoint.
https://api.signalneural.com/v1
Authentication is handled via an API key. Include your key in the X-API-Key header for all requests. You can generate and manage API keys from your dashboard under Settings > API Keys.
curl -X GET "https://api.signalneural.com/v1/crawlers" \
-H "X-API-Key: YOUR_API_KEY"
API uptime SLA
Enterprise & Elite plans include dedicated API support
API Endpoints
Complete reference for available endpoints.
/crawlers
Returns real-time AI crawler detection logs. Use query parameters to filter by crawler type, date range, or path.
Parameters
Show example response
{
"data": [
{
"crawler_type": "GPTBot",
"timestamp": "2024-01-15T10:30:00Z",
"path": "/features/geo",
"depth": 3,
"intent": "full_crawl"
}
],
"total": 42
}
/inject
Trigger contextual injection of JSON-LD or llms.txt payloads for a specific URL or crawler type.
Request Body
Show example request
{
"url": "https://signalneural.com/features/geo",
"crawler_type": "GPTBot",
"payload_type": "json-ld"
}
/citations
Retrieve LLM citation data for your content. Includes citing model, cited fragment, timestamp, and confidence score.
Query Parameters
/metrics
Get GEO performance metrics: citation growth, LLM visibility score, and competitor benchmarks.
Response Highlights
/status
Check API health and rate limit status.
Response Example
{
"status": "operational",
"version": "v5",
"rate_limit": {
"remaining": 987,
"limit": 1000,
"reset": "2024-01-15T11:00:00Z"
}
}
Error Codes & Troubleshooting
Common API error responses and how to resolve them.
Missing or invalid API key. Verify that you've included the X-API-Key header with a valid key from your dashboard.
Too many requests. Check the X-RateLimit-Reset response header to see when you can retry. Consider upgrading your plan for higher limits.
Your API key does not have permission for this resource. Check that your key is active and has the required scopes.
Validation error in request parameters. Review the error message in the response body for details.
1. Get API Key
Log into your dashboard, navigate to Settings > API Keys, and generate a new key. Copy it securely.
2. Make Your First Call
Use curl, Postman, or your preferred HTTP client to call /status – no parameters needed.
curl -H "X-API-Key: your_key" \ https://api.signalneural.com/v1/status
3. Integrate & Automate
Embed API calls into your CI/CD, reporting dashboards, or custom GEO tools. Monitor LLM citations automatically.
Frequently asked questions
Everything you need to know about the AIRM API.
What is the base URL for the AIRM API?
The base URL is `https://api.signalneural.com/v1`. All endpoints are relative to this URL.
How do I authenticate API requests?
Include your API key in the `X-API-Key` header. You can generate an API key from your dashboard under Settings > API Keys.
What rate limits apply to the API?
Essential plan: 1,000 requests per hour. Enterprise plan: 10,000 requests per hour. Elite plan: custom limits.
Which endpoints are available for crawler detection?
The `/crawlers` endpoint returns real-time AI crawler detection logs. Use filters to narrow by crawler type or time range.
Can I export citation data via API?
Yes. The `/citations` endpoint provides LLM citation data for your content, including citing model, cited fragment, timestamp, and confidence score.
Is there an API explorer or SDK?
Yes. We provide an interactive API explorer in your dashboard, along with official SDKs for Python, Node.js, and PHP. Contact support for early access.