Skip to content

Balloon

The Balloon response object captures the details of a numbered callout that appears on a technical drawing. Balloons connect annotations, bills of materials, and inspection requirements, so this model collects everything the API extracted about the marker. It records the identifier printed inside the balloon, its geometric location on the sheet, and any linkages to underlying features or notes. Downstream applications rely on the balloon to tie parts, operations, and measurements back to the correct reference in the drawing. Populating the Balloon object therefore allows automated routing of tasks, cross-referencing of components, and review of engineering changes without manually scanning the document. Use it whenever you need to know exactly where an instruction originates and how it relates to the rest of the specification.

Bases: Reference

Represents a balloon annotation in a drawing or part diagram.

PARAMETER DESCRIPTION
reference_id

Reference ID to identify the object.

TYPE: int

center

The (x, y) coordinates of the balloon's center on the diagram.

TYPE: Tuple[int, int]

Source code in werk24/models/v2/models.py
class Balloon(Reference):
    """
    Represents a balloon annotation in a drawing or part diagram.
    """

    center: Tuple[int, int] = Field(
        ...,
        description="The (x, y) coordinates of the balloon's center on the diagram.",
        examples=[(150, 200)],
    )