Skip to main content
POST
Pin or clear an item's schema match
Route one item to a participating schema (review-queue equivalent). Auth0 + allowlist. Filing bills black_hole to the uploader, not the reviewer.

Authorizations

Authorization
string
header
required

Auth0 access token for a signed-in user. Send Authorization: Bearer <token>. The SPA and desktop agent use this. Prefer an organisation API key for server-to-server integrations.

Path Parameters

item_id
string
required

Body

application/json

POST /api/v2/ingest/items/<item_id>/match/ body (CONTRACT §2.6).

struct_slug=null clears any pin (→ UNMATCHED); a slug pins the struct's current published version (→ CLASSIFIED).

struct_slug
string | null
required
Required string length: 1 - 200

Response

200 body of POST /api/v2/ingest/items/<item_id>/match/.

item_id
string
required
state
string
required

"CLASSIFIED" (pinned) or "UNMATCHED" (cleared).

struct
object | null
required

{slug, name, version} of a pinned target — mirrors IngestItemSerializer.get_struct.