Skip to content
Peritus
API reference · Public record

Get sample

GET/v1/samples/{capability}

A key-free sample response of a capability, recorded from fixtures, never from live data.

scope
none
auth
none
operationId
GetSample

Parameters

Parameters
FieldInTypeRequiredLimits
capabilitypathask · fetch · resolve · compare · changes · enrich · search · field_requests · abstention_stale · abstention_ambiguous_subject · abstention_not_coveredyes

Response

200 · application/json. A recorded response: an envelope with its attributions, or, for field_requests, the field request document.

Problems

RFC 9457 application/problem+json. An abstention is not one of these: it is a 200.

Problems
HTTPCodeWhen
400INVALID_REQUESTMalformed JSON, unknown fields, bad filter, limit exceeded
404NOT_FOUNDUnknown response, job, document, or reserved route