Skip to main content
Index an agreement document

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

Response

Current index state.

status
enum<string>
required
Available options:
indexing,
searchable,
unavailable
chunk_count
integer
required
Required range: x >= 0
workflow_run_id
string<uuid> | null
required