Entities

A name to one id, before any filter

Call this before passing an id to about, by, entity_ids, channel_ids or channel; those filters refuse names with id_required. Pass context with the user's own words about the name ("the startup bank", "on My First Million"). The answer is one of three: best (the name means one entity: use it and name it), suggested (no entity is certain but one stands out, with reason and evidence: use it and tell the user you assumed it), or ask (several entities fit: show ask.options, or check every option id and answer per entity). For a show pass type=channel and use the youtube_channel_id; for a brand or a person use the id. Free; uses no credits.

get/v1/entities/resolve

Request

  • Base URL: https://api.arcmira.com
  • URL: https://api.arcmira.com/v1/entities/resolve
  • Auth: HTTP bearer

Query parameters

qstring required

A name, @handle, YouTube URL or channel id (UC...). One thing per call.

type'person' | 'organization' | 'product' | 'topic' | 'channel'

Restrict candidates to one type. Pass channel for a show and read best.youtube_channel_id.

limitinteger

Candidates to return, 1 to 15. Default 8.

contextstring

What the user said about the name, in their words ("the startup bank", "Canada's prime minister", "on My First Million"). Ranks candidates by their description and by the episodes they share with what the context names; a clear winner comes back as suggested with reason context.

src'mcp-tool'

The surface making this call. The Arcmira MCP server sends mcp-tool so every unlock link in a gate attributes to the directory install. Omit from your own client.

Response

Success

EntityResolveResponse required(unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.