⌕

Tài liệu tham khảo API

Other

GET/v1/legal/documents

List / filter legal documents

Param	In	Required
doc_type	query	no
agency	query	no
field	query	no
eff_status	query	no
issued_from	query	no
issued_to	query	no
effective_from	query	no
effective_to	query	no
q	query	no
sort	query	no
cursor	query	no
limit	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/legal/documents/{ref}

Get a single document

Param	In	Required
ref	path	yes
include	query	no
at	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/legal/documents/{ref}/units

Get a document's units

Param	In	Required
ref	path	yes
revision	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/legal/documents/{ref}/effectivity

Get a document's effectivity timeline

Param	In	Required
ref	path	yes
at	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/legal/documents/{ref}/relations

Get a document's relation graph

Param	In	Required
ref	path	yes
direction	query	no
types	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/legal/search

Search legal units (full-text, semantic, or hybrid)

Param	In	Required
q	query	yes
mode	query	no
doc_type	query	no
field	query	no
eff_status	query	no
limit	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/legal/changes

Change-event feed

Param	In	Required
since	query	yes
types	query	no
subtypes	query	no
doc_type	query	no
field	query	no
limit	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/legal/export

Bulk export (NDJSON)

Param	In	Required
doc_type	query	no
field	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/bidding/packages

List / filter bidding packages

Param	In	Required
q	query	no
category	query	no
selection_method	query	no
notice_type	query	no
province_code	query	no
investor	query	no
min_budget	query	no
max_budget	query	no
status	query	no
closing_after	query	no
sort	query	no
cursor	query	no
limit	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/bidding/packages/{tbmt_code}

Get a single bidding package

Param	In	Required
tbmt_code	path	yes
include	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/bidding/packages/{tbmt_code}/history

Get revision and change-event history for a bidding package

Param	In	Required
tbmt_code	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/bidding/investors

Aggregate investor and winning bidder statistics

Param	In	Required
q	query	no
province_code	query	no
role	query	no
limit	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/bidding/search

Search bidding units (GET query params — FTS, semantic, or hybrid)

Param	In	Required
q	query	yes
mode	query	no
category	query	no
province_code	query	no
status	query	no
min_budget	query	no
max_budget	query	no
limit	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/v1/bidding/search

Search bidding units (POST JSON body — FTS, semantic, or hybrid)

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/usage

Current-period usage

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/me

Caller identity

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/webhooks

List webhook subscriptions

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/v1/webhooks

Create a webhook subscription

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

DELETE/v1/webhooks/{subscription_id}

Delete a webhook subscription

Param	In	Required
subscription_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/v1/webhooks/{subscription_id}/test

Send a signed test event

Param	In	Required
subscription_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/webhooks/{subscription_id}/deliveries

List webhook delivery attempts

Param	In	Required
subscription_id	path	yes
cursor	query	no
limit	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/v1/webhooks/{subscription_id}/deliveries/{delivery_id}/redeliver

Redeliver a webhook delivery

Param	In	Required
subscription_id	path	yes
delivery_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/billing/providers

List available billing payment providers

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/billing/checkout

Start a PayPal subscription checkout

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/billing/cancel

Cancel at period end

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/billing

Get billing snapshot

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

PATCH/portal/billing/tax-info

Update org VAT tax info (PATCH)

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

PUT/portal/billing/tax-info

Update org VAT tax info (PUT)

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/paypal/webhook

PayPal webhook receiver

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/auth/signup

Create an account

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/auth/login

Log in with email + password

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/auth/logout

Log out

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/auth/me

Current account + current org + all org memberships

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/auth/verify

Confirm an email-verify token

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/auth/verify/resend

Resend the email-verify link

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/auth/forgot

Request a password-reset email

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/auth/reset

Reset a password from a reset-password token

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/auth/habify/start

Start Habify Hub OIDC login (GET)

Param	In	Required
next	query	no
redirect_uri	query	no
prompt	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/auth/habify/start

Start Habify Hub OIDC login (POST)

Param	In	Required
next	query	no
redirect_uri	query	no
prompt	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/auth/habify/callback

Complete Habify Hub OIDC callback (exchange code + PKCE verifier)

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

PATCH/portal/account

Update the calling account's display name

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/account/password

Change the calling account's password

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/keys

List the current org's API keys

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/keys

Create an API key

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

DELETE/portal/keys/{key_id}

Revoke an API key

Param	In	Required
key_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/org

Get the current org's settings

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

PATCH/portal/org

Update the current org's settings

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

DELETE/portal/org

Delete the current org (danger zone)

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/members

List org members and pending invites

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/invites

Invite a teammate by email

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/invites/{invite_id}/resend

Resend a pending invite

Param	In	Required
invite_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

DELETE/portal/invites/{invite_id}

Cancel a pending invite

Param	In	Required
invite_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/invites/accept

Accept an invite by token

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

PATCH/portal/members/{account_id}

Change a member's role

Param	In	Required
account_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

DELETE/portal/members/{account_id}

Remove a member from the org

Param	In	Required
account_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/usage

Current-org usage: per-day and per-endpoint breakdown

Param	In	Required
period	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/overview

Portal dashboard overview

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/webhooks

List the current org's webhook subscriptions

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/webhooks

Create a webhook subscription

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

PATCH/portal/webhooks/{subscription_id}

Edit or pause/resume a webhook subscription

Param	In	Required
subscription_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

DELETE/portal/webhooks/{subscription_id}

Delete a webhook subscription

Param	In	Required
subscription_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/webhooks/{subscription_id}/deliveries

List webhook delivery attempts

Param	In	Required
subscription_id	path	yes
cursor	query	no
limit	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/webhooks/{subscription_id}/test

Send a signed test event

Param	In	Required
subscription_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/webhooks/{subscription_id}/deliveries/{delivery_id}/redeliver

Redeliver a webhook delivery

Param	In	Required
subscription_id	path	yes
delivery_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/admin/sources

Per-source health grid (Ops home)

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/admin/queue-stats

Pipeline queue stats (Ops home)

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/admin/runs

List crawl runs

Param	In	Required
source	query	no
status	query	no
since	query	no
limit	query	no
offset	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/admin/runs/{run_id}

Crawl run detail

Param	In	Required
run_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/admin/runs/run/{source_key}

Run a source now

Param	In	Required
source_key	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/admin/failures

Parse-failure queue, grouped by error signature

Param	In	Required
status	query	no
limit	query	no
offset	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/admin/failures/{failure_id}/resolve

Flip a parse failure's status

Param	In	Required
failure_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/admin/failures/{failure_id}/reparse

Re-parse a single parse failure's raw object

Param	In	Required
failure_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/admin/reparse-batch

Batch-enqueue re-parse of open failures below a parser version

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/admin/records

Search records

Param	In	Required
q	query	no
limit	query	no
offset	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/admin/records/{natural_key}

Record detail

Param	In	Required
natural_key	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/admin/records/{natural_key}/revisions/{seq_a}/{seq_b}/diff

Structural diff between two revisions

Param	In	Required
natural_key	path	yes
seq_a	path	yes
seq_b	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/admin/records/{natural_key}/refetch

Force a re-fetch of a record's source URL

Param	In	Required
natural_key	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/admin/records/{natural_key}/rebuild-effectivity

Rebuild a record's legal_effectivity timeline

Param	In	Required
natural_key	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/admin/provisional

Provisional-record queue

Param	In	Required
limit	query	no
offset	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/admin/orgs

Orgs / customers list

Param	In	Required
q	query	no
plan	query	no
limit	query	no
offset	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/admin/orgs/{org_id}

Org detail

Param	In	Required
org_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/admin/orgs/{org_id}/comp

Comp an org onto a plan (manual staff grant)

Param	In	Required
org_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/admin/orgs/{org_id}/extend

Extend an org's current subscription period

Param	In	Required
org_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

POST/portal/admin/orgs/{org_id}/note

Attach a staff note to an org (log-only, D6)

Param	In	Required
org_id	path	yes

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/portal/admin/telemetry

Telemetry review: top queries/endpoints, zero-result flags, MCP/plan split

Param	In	Required
since	query	no
until	query	no

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/meta/status

API status

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/meta/freshness

Freshness SLA

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/v1/meta/plans

Plan matrix

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

GET/llms.txt

Agent-facing API description

Response: {success, data, meta} on 2xx, {success: false, error} otherwise — see Errors & envelope.

CrawlPipe