# Vastu overlay SVG

`POST https://api.astroway.info/v1/render/vastu`

The /vastu/plan input drawn as an SVG in the plan's own coordinates on a transparent background, to lay straight over the floor-plan image: the 81-cell mandala with its deities, or the 16 zones, or the 8 directions as rays from the centre the school reads from, rooms coloured by verdict, the door with its pada, and a north arrow. `options.format: "svg"` returns the image itself.

Group: Vastu Shastra. Auth: `X-Api-Key` header. Operation ID: `render_vastu`.

## Parameters

| Name | In | Required | Type | Description |
|---|---|---|---|---|
| `fields` | query | no | string | Comma-separated dotted paths, relative to `data`, to keep in the response. A path is applied to every element of an array, so `planets.name` means the name of each planet. Paths that match nothing come back in `_fields_unmatched`; a list where nothing matches at all is a 400, because an empty object would be a confident wrong answer. |
| `precision` | query | no | integer | Round every non-integer number in the response to this many decimal places. Integers are left alone, because an id is not a measurement. Ecliptic longitudes ship with fourteen decimals by default; 2 is about a tenth of an arcminute. |
| `Idempotency-Key` | header | no | string | Unique per logical operation, kept across retries. For 24 hours from the first request, a repeat with the same key, method, path, body and query string returns the stored response with `Idempotent-Replayed: true` and costs 0 credits. The same key with a different body or query string is a 409 `IDEMPOTENCY_KEY_REUSED`; a repeat while the first is still running is a 409 `IDEMPOTENCY_IN_PROGRESS`. Only 2xx responses are kept. See /idempotency/. |

## Request body

| Field | Type | Required | Description |
|---|---|---|---|
| `coords` | object | yes |  |
| `coords.system` | "image" \| "metric" | yes |  |
| `coords.width` | number | no |  |
| `coords.height` | number | no |  |
| `coords.normalized` | boolean | no |  |
| `coords.units` | "m" \| "ft" | no |  |
| `northAngle` | number | yes |  |
| `northReference` | "true" \| "magnetic" | no |  |
| `declination` | number | no |  |
| `boundary` | number[][] | yes |  |
| `rooms` | object[] | no |  |
| `items` | object[] | no |  |
| `entrance` | number[] | no |  |
| `entranceMethod` | "eight-per-side" \| "mandala-cells" | no |  |
| `facing` | "E" \| "S" \| "W" \| "N" | no |  |
| `school` | "brihat-samhita" \| "mayamata" \| "sixteen-zone" | no |  |
| `scoreVersion` | 1 \| 2 | no |  |
| `options` | object | no |  |
| `options.layer` | "mandala" \| "zones" \| "directions" | no |  |
| `options.labels` | boolean | no |  |
| `options.width` | integer | no |  |
| `options.format` | "json" \| "svg" | no |  |

```json
{
  "coords": {
    "system": "image",
    "width": 1200,
    "height": 800
  },
  "northAngle": 0,
  "boundary": [
    [
      100,
      100
    ],
    [
      1100,
      100
    ],
    [
      1100,
      700
    ],
    [
      100,
      700
    ]
  ],
  "rooms": [
    {
      "type": "kitchen",
      "point": [
        1000,
        650
      ]
    }
  ],
  "options": {
    "layer": "zones"
  }
}
```

## Responses

| Status | Meaning |
|---|---|
| 200 | Successful calculation |
| 400 | Validation error |
| 401 | Missing or invalid API key |

### Success fields, under `data`

| Field | Type | Required | Description |
|---|---|---|---|
| `svg` | string | no |  |
| `layer` | string | no |  |
| `school` | string | no |  |
| `from` | string | no |  |
| `language` | string | no |  |
| `warnings` | object[] | no |  |

## Example

```bash
curl -X POST https://api.astroway.info/v1/render/vastu \
  -H "X-Api-Key: aw_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "coords": { "system": "image", "width": 1200, "height": 800 }, "northAngle": 0, "boundary": [ [ 100, 100 ], [ 1100, 100 ], [ 1100, 700 ], [ 100, 700 ] ], "rooms": [ { "type": "kitchen", "point": [ 1000, 650 ] } ], "options": { "layer": "zones" } }'
```

---

Rendered from https://api.astroway.info/v1/openapi.json. HTML page: https://api.astroway.info/docs/api/operations/render_vastu/