Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.arcmira.com/llms.txt

Use this file to discover all available pages before exploring further.

The Arcmira API exposes the same media-intelligence primitives that power arcmira.com: entity resolution, evidence-backed mentions, person appearances, related entity lists, watchlists, trackers, and a Pro+ commercial intelligence surface for ad reads and sponsors. It is HTTP/JSON, lives at https://api.arcmira.com, and is versioned under /v1. API calls draw from the same monthly row pool as web usage on your plan. There is no separate API tier.

​
Where to go next

Quickstart

Mint your first key, run /v1/search, /v1/entities/lookup, and /v1/mentions.

Authentication

Authorization: Bearer arc_sk_... or x-api-key.

Entities

Stable ent_<id> resolution and merge chains.

Mentions

Evidence rows tying entities to media with timestamps and sentiment.

Watchlists & Trackers

Programmatic tracking and recent alert delivery history.

Commercial intelligence

Ad reads, endorsements, and channel sponsors (Pro+).

API Reference

Full OpenAPI 3.1 endpoint reference and interactive playground.

​
Core surface

CapabilityEndpoint
Search entitiesGET /v1/search
Discovery search (ranked, fuzzy)GET /v1/entities/search
Resolve a name to an IDGET /v1/entities/lookup
Read an entityGET /v1/entities/{id}
Mentions for an entityGET /v1/entities/{id}/mentions
Cross-entity mentionsGET /v1/mentions
Person appearancesGET /v1/people/{slug}/appearances
Recommendations (ad reads, endorsements) — Pro+GET /v1/recommendations
Entity recommendations — Pro+GET /v1/entities/{id}/recommendations
Channel sponsors — Pro+GET /v1/channels/{channel_id}/sponsors
Feedback / corrections — Pro+POST /v1/feedback
Watchlists CRUDGET|POST|PATCH|DELETE /v1/watchlists[...]
Trackers CRUDGET|POST|PATCH|DELETE /v1/trackers[...]
Recent watchlist alertsGET /v1/watchlists/{id}/alerts
Recent tracker alertsGET /v1/trackers/{id}/alerts
Only person entities have appearances. Organizations, products, topics, and channels are exposed exclusively through mention endpoints. See Appearances vs. mentions.

​
Design principles

  • Stable IDs. Every entity is identified by an opaque, stable string of the form ent_<id>. Merges preserve the canonical ID and surface merged_from_id so old references keep resolving. Commercial rows use the parallel com_<id> scheme.
  • Cursor pagination. List endpoints take limit and cursor. Responses return data, has_more, and next_cursor. Cursors are opaque — pass them back verbatim.
  • Stable error envelope. Every error includes type, code, message, doc_url, and request_id, and every response carries an X-Request-Id header.
  • Idempotent writes. POST and PATCH requests to watchlists, trackers, and feedback accept an Idempotency-Key header.
  • Rate limits exposed. Every response includes RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset.
  • Pro+ commercial gate. Ad reads, endorsements, channel sponsors, mention enrichment via details=full, and feedback live behind the Pro+ tier and the recommendations:read / recommendations:write scopes. See Commercial intelligence.

​
Status

Arcmira v1 is generally available. See the changelog for release history and the roadmap for what is intentionally not yet shipped (SDKs, webhooks, exports, sandbox mode).