Resolve Many Names
The batch form of name resolution: up to 50 queries, one round trip, results returned in the order they were sent.
- stringheaderrequired
Your API key.
Authorization: Bearer <key>is accepted in its place.
- string[]required
The names to resolve. Between 1 and 50, each up to 200 characters.
- object
The response payload.
- object[]
One result per query, in the order the queries were sent.
- string
The query this result answers, echoed back so a batch response can be matched to its request.
- string
One of
resolved(exactly one record),ambiguous(several equally good, none chosen) ornot_found. - string | null
The resolved catalog id. Null on
ambiguousandnot_found, since an ambiguous query is deliberately not decided for you. - string | null
How the resolution was made, or null when nothing resolved. Never
fuzzy: a suggestion is not a resolution. - number
Confidence in the resolution, 0 to 1. Derived from how much of the query a catalogued spelling accounted for and how strong that spelling is as evidence.
- string[]
The words of the query a catalogued spelling accounted for.
- string[]
The words it did not. Reported rather than guessed at: a variant we do not hold appears here instead of being silently dropped.
- object[]
Other records this query could mean, best first. On
ambiguousthese are the tied candidates and choosing between them is yours.
- 400
VALIDATION_ERROR - 401
UNAUTHORIZED - 403
FORBIDDEN - 413
PAYLOAD_TOO_LARGE - 429
RATE_LIMITED - 500
INTERNAL_ERROR
Requires an API key with Studio tier or higher.
Up to 50 queries in one request, results returned in the order they were sent. Each is scored exactly as the single form scores it.
This is the shape to use when extracting the firearms named in a document, a thread or a spreadsheet column. Resolving those one at a time is the difference between a call you can make inline and one you cannot.
One unknown name does not fail the batch. It comes back as a result with status: "not_found".
- Minimum tier
- Studio+
- Monthly quota
- 150,000/mo
- Rate limit
- 120/min
- Daily cap
- 10,000
Figures shown are for this endpoint's minimum tier. Higher tiers raise every limit.