---
title: "Trace a line run between two points through the detector's ink model"
method: POST
path: "/api/v0/components/{component_id}/schematic/trace-path"
tags: ["Components"]
---

# Trace a line run between two points through the detector's ink model

`POST /api/v0/components/{component_id}/schematic/trace-path`

## Request

- Base URL: `https://api.outerport.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.outerport.com/api/v0/components/{component_id}/schematic/trace-path`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/outerport/apis/outerport-api/docs/api/v0/components/:component_id/schematic/trace-path/post.ts> (a function with typed inputs; its response is checked against the schema)

Walks the page skeleton between `start` and `end` (page pixel coordinates) with the symbol, text and arrow boxes of the current graph blanked exactly as line detection blanks them, and measures the stroke under the walk. Returns `pixel_path: null` when no run joins the two points.

## Path parameters

- `component_id` string, required

## Query parameters

- `vc_id` string, required: Public ID of the target visual component

## Request body

- TracePathRequest
  - `start` TracePoint, required: A page pixel coordinate in the schematic's frame.
    - `x` number, required
    - `y` number, required
  - `end` TracePoint, required: A page pixel coordinate in the schematic's frame.
    - `x` number, required
    - `y` number, required

## Response `200`

Successful Response

- TracePathResponse: ``pixel_path`` is ``None`` when the skeleton holds no walk between the two points; the caller decides what a failed trace becomes (a straight segment, or nothing).
  - `pixel_path` array[], nullable, required
    - integer[]
  - `stroke` StrokeAppearance, required: How a drawn line looks, measured off the page image. Every field is optional: a colour-blind fallback trace has no `color`, and a stroke shorter than a dash period has no `pattern`.
    - `color` string, nullable
    - `pattern` 'solid' | 'dashed' | 'dotted' | 'dash_dot' | 'dash_dot_dot', nullable
    - `width_px` number, nullable
    - `dash_array` number[], nullable

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-25** `fcd15f6d35b4`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/outerport/apis/outerport-api/changes/api/v0/components/:component_id/schematic/trace-path/post.md)

---

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