Skip to content

API v1 · upa:inv:v1 · upa:sim:v1

Developers

Search, geometry and identification through API v1. The working application and this corpus share the same contract.

HTTP

GET /api/v1/patterns?kind=band&color=A&limit=20
GET /api/v1/patterns/p15_-_b02
POST /api/v1/identify

TypeScript

import { createClient } from '@upa-archive/client';
const upa = createClient({ baseUrl: location.origin });
const page = await upa.search({ kind: 'band', color: ['A'] });

Python

from upa_client import Client
upa = Client(base_url='http://localhost:8787')
page = upa.search(kind='band', color=['A'])

SDK source is prepared; npm and PyPI packages have not yet been published.

Search includes stitches with include=geometry. The page parameter is zero-based; pdfPage in responses is one-based. Identification separates exact identities from graded similarity.

Source

Publication and reuse terms for the corpus have not yet been settled.

Helen Hough. Ukrainian Folk Embroidery Patterns. James G Collins & Associates, 2025. Derived from folk patterns identified and drawn by Klymentij [Klemens] B. Habdank-Rohozynskyj.