Skip to main content
Search a terms document literally

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Path Parameters

id
string<uuid>
required

Body

application/json
agreement_id
string<uuid>
required
query
string
required
Required string length: 1 - 256

Response

Bounded passages and whether the complete extracted text was scanned.

status
enum<string>
required
Available options:
found,
not_found_in_extracted_text,
partial,
unavailable
matches_truncated
boolean
required
passages
string[]
required