---
title: "Get silhouette line art"
method: GET
path: "/v1/firearms/{id}/silhouette"
tags: ["Firearms"]
---

# Get silhouette line art

`GET /v1/firearms/{id}/silhouette`

## Request

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

Returns the scalable line-art silhouette for a firearm, sized to its real-world dimensions.

**Requires Builder tier or higher.**

## Path parameters

- `id` string, required

## Query parameters

- `format` 'raw' | 'svg' | 'datauri' | 'json'
- `stroke_width` integer
- `stroke_color` string

## Response `200`

The SVG file when `format=raw`, or the JSON envelope when `format` is `datauri` or `json`

- 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.
    - `id` string: Slug of the firearm.
    - `name` string: Display name, as the maker writes it.
    - `slug` string: Slug of the line-art file, which is the firearm slug.
    - `format` string: Which JSON form this is: `datauri` or `svg`.
    - `mimeType` string: Media type of the bytes, e.g. `image/png`.
    - `dataUri` string: Present when `format=datauri`: the SVG inlined as an RFC 2397 data URI.
    - `svg` string: Present when `format=json`: the SVG source, for parsing or manipulating in code.

## 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.
- `404`: Resource not found
- `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)