> ## Documentation index
> Fetch the complete documentation index at: https://docs.odysseysignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get map guide image

> A picture of one type of map, drawn by the reference drawing

API versions: v1 (current) https://docs.odysseysignal.com/api/reference/get-map-guide-image.md

`GET /v1/maps/guide/image`

The guide's example drawn by its reference drawing, light theme, 640 px square.

Authentication: an API key in `X-Api-Key`, or `Authorization: Bearer <token>`.

## Parameters

### Query parameters

- `type` (string, required): The map to draw. One of `brand_position`, `demand_space_sizes`, `brand_profile`.
- `format` (string, default "png") One of `png`, `svg`.
- `variant` (string, nullable, always "position_di"): `position_di` (with `brand_position` only).

## Example request

```bash
curl "https://api.odysseysignal.app/v1/maps/guide/image?type=brand_position" \
  -H "X-Api-Key: $ODYSSEY_API_KEY"
```

## Response 200

Content: `image/png` or `image/svg+xml`.

## Errors

Errors are `application/problem+json` (RFC 9457): `type`, `title`, `status`, `detail` and, for some, more fields that say how to fix the call. The `type` is `https://api.odysseysignal.app/problems/<code>`.

| Status | Code | When |
|---|---|---|
| 400 | `invalid-request` | The request is not valid for this DataSet; `detail` says why. |
| 401 | `unauthorized` | No credential, or one that is not accepted. |
| 403 | `forbidden` | The credential is valid but does not cover what was asked. |
| 404 | `not-found` | Nothing there, or nothing this credential may read. |
| 422 | `validation-failed` | The request does not match the contract; `errors` lists each field. |
| 429 | `rate_limited` | Too many requests, or the monthly quota is used up. |
| 503 | `unavailable` | A service behind the API did not answer; try again. |