Docs
Auto Intelligence

API and MCP

Your rival dealers in Claude, ChatGPT or your own code: the daily inventory report, every car they list with its price history, and the weekly report. Separate from the other Alertedly APIs: their keys don't work here, and ours don't work there.

Access and plans

  • MCP (Claude, ChatGPT, Cursor, any MCP client) is on every plan. People connect by signing in with their Alertedly account and see the workspaces they belong to.
  • REST is on Advanced and Group. Integrations use an API key (alya_live_…) that an admin creates under Settings → API keys. A key belongs to one workspace: read, or read and write.
  • Send keys as X-API-Key: alya_live_… or Authorization: Bearer alya_live_…. People in several workspaces pick one with X-Workspace-Id (REST) or the tools' workspace argument (MCP).
  • Without the plan the answer is 402 PLAN_REQUIRED with an upgrade_url, your workspace's settings.

MCP server

MCP server URL
https://auto.alertedly.com/mcp

Streamable HTTP. In Claude: Settings → Connectors → Add custom connector, paste the URL and sign in. In ChatGPT: Open chatgpt.com/plugins, then + → Add custom MCP server: paste the server URL, choose OAuth, and sign in with your Alertedly account when asked. In Cursor: add this to ~/.cursor/mcp.json and sign in when Cursor asks. Name a dealer by its id, website or name.

Cursor: mcp.json
{
  "mcpServers": {
    "alertedly-auto": {
      "url": "https://auto.alertedly.com/mcp"
    }
  }
}
  • Tool
    get_overview
    Access
    read
    What it does
    The latest weekly report: headline, the moves to make first, your store and every rival (inventory, pricing, offers, Maps rank, reviews, service, ads).
  • Tool
    get_competitor_brief
    Access
    read
    What it does
    One rival dealer's part of the latest weekly report.
  • Tool
    list_competitors
    Access
    read
    What it does
    The rival dealers you track, your own store, and your plan's limit.
  • Tool
    add_competitor
    Access
    write
    What it does
    Track a rival dealer by its website. Its inventory is read daily from then on.
  • Tool
    remove_competitor
    Access
    write
    What it does
    Stop tracking a rival dealer. Past reports stay.
  • Tool
    get_inventory_changes
    Access
    read
    What it does
    The daily inventory report: what every lot added, sold and repriced since the day before; or a given date's.
  • Tool
    get_inventory_history
    Access
    read
    What it does
    Daily inventory counts per dealer: listed, in transit, arrivals, sold, price drops, average price and days on lot.
  • Tool
    get_inventory
    Access
    read
    What it does
    The cars one dealer lists now, with price history and days on lot; sold cars too if asked.
  • Tool
    list_reports
    Access
    read
    What it does
    Every report on file, newest first: weekly reports and daily inventory reports.
  • Tool
    get_report
    Access
    read
    What it does
    One report, weekly or daily, with every fact it was written from.
  • Tool
    get_settings
    Access
    read
    What it does
    Workspace name, where reports are emailed, and the Google searches watched.
  • Tool
    update_settings
    Access
    write
    What it does
    Rename the workspace, change the report email, or replace the searches watched (admins).
  • Tool
    get_plan
    Access
    read
    What it does
    Your plan, its limits, what it opens (MCP, REST) and the upgrade link.
  • Tool
    list_team
    Access
    read
    What it does
    Members and pending invites.
  • Tool
    invite
    Access
    write
    What it does
    Invite a teammate by email (admins).
  • Tool
    remove_member
    Access
    write
    What it does
    Remove a teammate or cancel an invite (admins).
  • Tool
    list_api_keys
    Access
    read
    What it does
    Live API keys, never the key itself (admins).
  • Tool
    create_api_key
    Access
    write
    What it does
    A new API key, shown once (admins).
  • Tool
    revoke_api_key
    Access
    write
    What it does
    Revoke an API key (admins).

Try: “What did my rivals sell and reprice overnight?”, “Which rival has the most aged used stock?”, “Is anyone discounting new cars this week?”, “Track northsidetoyota.com”.

REST API

Base URL
https://auto.alertedly.com/api/v1
Example
curl "https://auto.alertedly.com/api/v1/inventory/daily" -H "X-API-Key: alya_live_…"
  • Method
    GET
    Path
    /usage
    Scope
    read
    What
    Plan, limits, access, calls this month
  • Method
    GET
    Path
    /plan
    Scope
    read
    What
    Your plan, read-only
  • Method
    GET
    Path
    /overview
    Scope
    read
    What
    The latest weekly report across your rivals
  • Method
    GET
    Path
    /competitors
    Scope
    read
    What
    Rival dealers you track
  • Method
    POST
    Path
    /competitors
    Scope
    write
    What
    {"website"}: track a rival dealer
  • Method
    GET
    Path
    /competitors/{id}/brief
    Scope
    read
    What
    One rival's part of the latest weekly report
  • Method
    DELETE
    Path
    /competitors/{id}
    Scope
    write
    What
    Stop tracking a rival
  • Method
    GET
    Path
    /inventory/daily
    Scope
    read
    What
    ?date=YYYY-MM-DD: the daily inventory report (latest by default)
  • Method
    GET
    Path
    /inventory
    Scope
    read
    What
    ?days=…: daily inventory counts per dealer
  • Method
    GET
    Path
    /inventory/vehicles
    Scope
    read
    What
    ?dealer=…&include_sold=…&limit=…: one dealer's cars
  • Method
    GET
    Path
    /reports
    Scope
    read
    What
    ?kind=weekly|daily|all: reports, newest first
  • Method
    GET
    Path
    /reports/{id}
    Scope
    read
    What
    One report (markdown and HTML)
  • Method
    GET
    Path
    /settings
    Scope
    read
    What
    Settings
  • Method
    PATCH
    Path
    /settings
    Scope
    write
    What
    {"name"?, "brief_email"?, "searches"?}: change settings (admins)
  • Method
    GET
    Path
    /team
    Scope
    read
    What
    Members and invites
  • Method
    POST
    Path
    /team/invites
    Scope
    write
    What
    {"email", "role"}: invite (admins)
  • Method
    DELETE
    Path
    /team/members/{id}
    Scope
    write
    What
    Remove a member or cancel an invite (admins)
  • Method
    GET
    Path
    /api-keys
    Scope
    read
    What
    Live API keys (admins)
  • Method
    POST
    Path
    /api-keys
    Scope
    write
    What
    {"name", "scopes"}: a new key, shown once (admins)
  • Method
    DELETE
    Path
    /api-keys/{id}
    Scope
    write
    What
    Revoke a key (admins)

Limits and errors

  • 60 requests a minute per key or person; over it, 429 with Retry-After.
  • Errors are { error: { message, error_code }, request_id }: UNAUTHORIZED, PLAN_REQUIRED, INSUFFICIENT_SCOPE, NOT_FOUND, REFUSED (with the reason), RATE_LIMITED.
  • Inventory is read once a day; the weekly report numbers are from the latest weekly run.