Skip to main content
POST
Find the citations in a text and resolve each

Authorizations

Authorization
string
header
required

API key issued from the developer dashboard. Pass as Authorization: Bearer vq_key_... (preferred).

Body

application/json
text
string
required

The text to read, 1 to 200,000 characters (a brief is about 30,000). Longer is a 422, never a silent truncation: a partial list reported as the whole is a wrong answer. Plain text; a body that is mostly binary is a 422.

Required string length: 1 - 200000
Example:

"Plaintiff sued under 42 U.S.C. § 1983(b). See also Cal. Civ. Code § 1942 and 42 U.S.C. § 1983."

state
enum<string> | null

The jurisdiction of the DOCUMENT as a two-letter state code (the forum of a filing, the governing state of a matter). It labels and scopes a citation that names no jurisdiction of its own (Civil Rule 56.1, Gov. Code § 12940); a citation that names a jurisdiction is always checked against that one, whatever this says.

Available options:
al,
ak,
as,
az,
ar,
ca,
co,
ct,
de,
dc,
fl,
ga,
gu,
hi,
id,
il,
in,
ia,
ks,
ky,
la,
me,
md,
ma,
mi,
mn,
ms,
mo,
mt,
ne,
nv,
nh,
nj,
nm,
ny,
nc,
nd,
mp,
oh,
ok,
or,
pa,
pr,
ri,
sc,
sd,
tn,
tx,
ut,
vt,
vi,
va,
wa,
wv,
wi,
wy
Example:

"ca"

resolve
boolean
default:true

Resolve each distinct citation to its section (priced per distinct citation, see the endpoint's Cost). false returns the extraction alone, which is free.

Example:

true

includeUnresolved
boolean
default:true

false drops rows that did not resolve from citations. The counts and the charge are unchanged: an unresolved citation is a verdict that was paid for.

Example:

true

Response

The distinct citations found, each resolved unless resolve is false.

counts
ExtractCitationsCounts · object
required
textChars
integer
required

Characters of text read.

extractorVersion
string
required

The extractor's version. The same text can yield different citations when it changes, so cache extractions by text AND this value.

Example:

"0.6.0"

citations
ExtractedCitationRow · object[]

The distinct citations, in order of first appearance.

truncated
boolean
default:false

True when more than 200 distinct citations were found and citations holds the first of them. counts.found still reports the number found, and only the ones listed were resolved and charged.

creditsConsumed
number
default:0

Credits actually charged. 0 when resolve is false.

Example:

6

processingTimeMs
number
default:0

Server-side time for this request in milliseconds. Not billed on.

Example:

412