---
title: "Create a schematic annotation"
method: POST
path: "/api/v0/components/{component_id}/schematic/annotations"
tags: ["Components"]
---

# Create a schematic annotation

`POST /api/v0/components/{component_id}/schematic/annotations`

## Path parameters

- `component_id` string, required

## Query parameters

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

## Request body

- CreateAnnotationRequest
  - `id` string, uuid4, required
  - `bbox` BoundingBox, required
    - `x0` integer, required
    - `y0` integer, required
    - `x1` integer, required
    - `y1` integer, required
    - `dpi` integer
    - `class_name` string, nullable
    - `text` string, nullable
    - `confidence` number, nullable
  - `content` string, nullable
  - `class` string, nullable
  - `subtype` string, nullable
  - `confidence` number

## Response `200`

Successful Response

- Annotation — A text region providing grounding but NOT topologically relevant. Bound to nodes, segments, ports, junctions, or terminals via `Association` records.
  - `id` string, required
  - `bbox` BoundingBox, required
    - `x0` integer, required
    - `y0` integer, required
    - `x1` integer, required
    - `y1` integer, required
    - `dpi` integer
    - `class_name` string, nullable
    - `text` string, nullable
    - `confidence` number, nullable
  - `content` string, nullable
  - `class` string, nullable
  - `subtype` string, nullable
  - `confidence` number

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/outerport/apis/outerport-api.md) · [All operations](https://skmtc.dev/outerport/apis/outerport-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/outerport/outerport-api/revisions/f565b46daaea/schema)