Docs/API Reference

API Reference

Integrate Elynn AI data into your own applications and workflows using our REST API.

Enterprise Feature

API access is available on the Enterprise plan. Upgrade your plan to get API access.

Authentication

Authenticate your API requests using a Bearer token. You can find your API key in your dashboard under Settings > API.

curl -X GET "https://api.elynn.one/v1/visibility" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Security: Never expose your API key in client-side code. Always make API calls from your server.

Base URL

All API requests should be made to:

https://api.elynn.one/v1

Endpoints

GET/visibility

Get visibility metrics for a website.

Query Parameters

ParameterTypeDescription
website_idstringRequired. The website ID
start_datestringISO 8601 date (default: 30 days ago)
end_datestringISO 8601 date (default: today)
GET/mentions

Get brand mentions across AI engines.

Query Parameters

ParameterTypeDescription
website_idstringRequired. The website ID
enginestringFilter by AI engine (chatgpt, claude, perplexity, google)
limitintegerNumber of results (default: 50, max: 100)
GET/competitors

Get competitor visibility data.

Query Parameters

ParameterTypeDescription
website_idstringRequired. The website ID

Rate Limits

API requests are rate limited to ensure fair usage for all users.

PlanRequests/minuteRequests/day
Enterprise6010,000

Rate limit headers are included in all API responses: X-RateLimit-Remaining, X-RateLimit-Reset

Webhooks

Configure webhooks to receive real-time notifications when your visibility changes. Configure webhooks in your dashboard under Settings > Webhooks.

Available Events

  • visibility.changed - Visibility score changed significantly
  • mention.new - New brand mention detected
  • sentiment.changed - Sentiment shifted significantly
  • competitor.ranked - Competitor surpassed your ranking