---
title: "Get Linear Ancillary Preview"
method: GET
path: "/v1/ancillaries/linear/{item_id}/preview"
tags: ["ancillaries"]
---

# Get Linear Ancillary Preview

`GET /v1/ancillaries/linear/{item_id}/preview`

## Request

- Base URL: `https://api.shapemaker.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.shapemaker.io/v1/ancillaries/linear/{item_id}/preview`
- Auth: OAuth 2
  - Password
  - Token URL: `/v1/auth`

This endpoint returns one metre of a library item in 3D, standing on its
own: a cable route without what it carries, an access ladder without a
cover. The library shows it when an item is clicked.

## Path parameters

- `item_id` integer, required

## Response `200`

Successful Response

- RenderableAncillary
  - `shapes` union[], required
    - union
      - RenderableShape3D
        - `type` 'box' | 'pipe' | 'prism' | 'cylinder' | 'tapered_cylinder', required
        - `geometry` union, required
          - BoxDimension
            - `height` number, required
            - `width` number, required
            - `depth` number, required
          - CylinderDimension
            - `length` number, required
            - `diameter` number, required
          - PolylineDimension
            - `points` Point[], required
              - …
            - `is_closed` boolean, required
          - TaperedCylinderDimension
            - `length` number, required
            - `diameter_bottom` number, required
            - `diameter_top` number, required
            - `sides` integer, required
          - NoDimension
        - `matrix` number[], required
        - `material` Material, required
          - `color` string, required
          - `opacity` number
          - `roughness` number
          - `metalness` number
      - RenderableShape2D
        - `type` 'line' | 'face'
        - `geometry` LineDimension, required
          - `start` Point, required
            - `x` number, required
            - `y` number, required
            - `z` number, required
            - `point_number` integer
          - `end` Point, required
            - `x` number, required
            - `y` number, required
            - `z` number, required
            - `point_number` integer
          - `width` number, required
          - `color` string
        - `style` 'solid' | 'dashed' | 'dotted' | 'dash-dot', required
        - `metadata` object, nullable
      - RenderableText
        - `type` 'text'
        - `position` Point, required
          - `x` number, required
          - `y` number, required
          - `z` number, required
          - `point_number` integer
        - `content` string, required
        - `size` number, required
        - `orientation` number
        - `props` object
      - Renderable3DModel
        - `type` 'object_3d'
        - `model` 'Paraboloid_1x1.glb' | 'North_label.glb' | 'Soil_geometry.glb' | 'Error_arrow.glb', required
        - `material` Material, required
          - `color` string, required
          - `opacity` number
          - `roughness` number
          - `metalness` number
        - `matrix` number[], required
  - `tenant_name` string, required
  - `id` integer, nullable: id of the ancillary for selection purposes

## Other responses

- `400`: Bad Request
- `422`: Validation Error

---

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