Query a Knowledge Base

Query a Knowledge Base for matching results.

Use the retrieve API to query a Knowledge Base for information matching keywords or phrases.

When you query a knowledge base, you must submit a POST request:

1. Identify the Knowledge Base to query using its code in the URL of the request.

2. Specify the text to search the Knowledge Base for using the text parameter.

3. Specify filters to restrict the documents that are searched.

The API will return matching items (portions of legislation, judgment summaries) that match your query, including a score, the text of the portion, and metadata.

Query the knowledge base for matching items.

post

Retrieve items from the knowledge base that match your query.

Authorizations

cookieAuthtokenAuth

sessionidstringRequired

Path parameters

codestringRequired

Unique code identifying this knowledge base

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Details to retrieve items from a knowledge base.

textstringRequired

The text to find matching items for

top_kinteger · min: 1 · max: 100Optional

Number of results to return

Default: 10

Responses

200Success

application/json

post

/ai/v1/knowledge-bases/{code}/retrieve

HTTPcURLJavaScriptPython

POST /ai/v1/knowledge-bases/{code}/retrieve HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 350

{
  "text": "text",
  "top_k": 10,
  "filters": {
    "work_frbr_uri": "text",
    "work_frbr_uri__in": [
      "text"
    ],
    "expression_frbr_uri": "text",
    "expression_frbr_uri__in": [
      "text"
    ],
    "frbr_place": "text",
    "frbr_place__in": [
      "text"
    ],
    "frbr_doctype": "text",
    "frbr_doctype__in": [
      "text"
    ],
    "frbr_subtype": "text",
    "frbr_subtype__in": [
      "text"
    ],
    "repealed": true,
    "commenced": true,
    "principal": true
  }
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "results": [
    {
      "content": {
        "text": "text"
      },
      "metadata": {
        "work_frbr_uri": "text",
        "frbr_place": "text",
        "frbr_country": "text",
        "frbr_doctype": "text",
        "frbr_subtype": "text",
        "title": "text",
        "repealed": true,
        "commenced": true,
        "principal": true,
        "blurb": "text",
        "flynote": "text",
        "expression_date": "2025-12-18",
        "expression_frbr_uri": "text",
        "public_url": "text",
        "portion_type": "page",
        "portion_id": "text",
        "portion_title": "text",
        "portion_parent_ids": [
          "text"
        ],
        "portion_parent_titles": [
          "text"
        ],
        "portion_public_url": "text"
      },
      "score": 1
    }
  ]
}