---
title: "Resolve many names at once"
method: POST
path: "/v1/firearms/resolve"
tags: ["Firearms"]
---

# Resolve many names at once

`POST /v1/firearms/resolve`

## Request

- Base URL: `https://api.gunspec.io`
- URL: `https://api.gunspec.io/v1/firearms/resolve`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

The batch form of name resolution: up to 50 queries, one round trip, results returned in the order they were sent.

This is the shape an agent needs. Extracting the firearms named in a document, a forum thread or a spreadsheet column means resolving dozens of names at once, and doing that one request at a time is the difference between a call that can be made inline and one that cannot. Every query is scored exactly as the single form scores it.

**Requires Studio tier or higher.**

## Request body

- object
  - `queries` string[], required: The names to resolve. Between 1 and 50, each up to 200 characters.

## Response `200`

One result per query. A query that resolved to nothing is a result with `status: "not_found"`, never an error: one unknown name does not fail the batch.

- object
  - `success` boolean, required: Always true on a successful response. Every error carries `false` and an `error` object instead.
  - `data` object, required: The response payload.
    - `results` object[]: One result per query, in the order the queries were sent.
      - `query` string: The query this result answers, echoed back so a batch response can be matched to its request.
      - `status` string: One of `resolved` (exactly one record), `ambiguous` (several equally good, none chosen) or `not_found`.
      - `firearmId` string, nullable: The resolved catalog id. Null on `ambiguous` and `not_found`, since an ambiguous query is deliberately not decided for you.
      - `match` string, nullable: How the resolution was made, or null when nothing resolved. Never `fuzzy`: a suggestion is not a resolution.
      - `score` 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.
      - `matchedTokens` string[]: The words of the query a catalogued spelling accounted for.
      - `unresolvedTokens` string[]: The words it did not. Reported rather than guessed at: a variant we do not hold appears here instead of being silently dropped.
      - `alternatives` object[]: Other records this query could mean, best first. On `ambiguous` these are the tied candidates and choosing between them is yours.
        - `firearmId` string: The catalog id of this candidate.
        - `name` string: The catalogued name of this candidate.
        - `manufacturerName` string, nullable: The maker, or null where the record has none.
        - `match` string: How this candidate was matched. One of `slug`, `name`, `alternate`, `shorthand`, `base` (the name with its maker removed), `family` (the model designation with its trailing descriptor removed, e.g. `M4` from `M4 Carbine`) or `fuzzy`.
        - `matchedAlias` string, nullable: The catalogued spelling that matched, or null for a fuzzy suggestion.
        - `score` number: Confidence in this candidate, 0 to 1. Always 0 for a fuzzy suggestion, which is offered rather than scored.

## Other responses

- `400`: Validation error
- `401`: Missing or invalid API key
- `403`: The credential is valid and the caller is not permitted. Three causes, none of which reissuing a key changes: the plan is below the endpoint's tier, the account is suspended, or the key is not attached to the thing being acted on, meaning a user account for `/v1/me` or a shop for `/v1/vendor`. Distinct from 401, which means the credential is missing, malformed or expired and a new one can work.
- `413`: The request body is larger than this endpoint accepts, which is 1 MB for a JSON body. Refused from `Content-Length` before the body is read, so nothing was stored and the request can be split and resent. `error.maxBytes` carries the limit.
- `429`: A limit was reached. `RATE_LIMITED` is the per-minute limit: wait `Retry-After` seconds (a minute) and retry. `DAILY_CAP_EXCEEDED` is the plan's daily limit, per key: nothing will be served until the counters return to zero at midnight UTC. `MONTHLY_CAP_EXCEEDED` is the plan's monthly allowance, for the whole account: nothing will be served until midnight UTC on the first of next month, or until the plan changes. For both, `Retry-After` is the seconds until then and `error.resetsAt` says when as an instant. Calls made after a refusal are refused too and do not spend the month, and a free key that keeps calling is paused, so stop at the first one and resume at the reset.
- `500`: Internal server error

---

[API](https://skmtc.dev/gunspec/apis/gunspec-io-api.md) · [All operations](https://skmtc.dev/gunspec/apis/gunspec-io-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gunspec/apis/gunspec-io-api/revisions/f2e974d8b05c?raw)