allybuildagent systems
Log inSign up

Developer docs SDK

Knowledge base

Search and lint the project’s OKF knowledge base — concepts, broken links, orphans, and duplicates.

Python

from workflow import okf

hits = okf.search("refund policy")
for h in hits:
    print(h["title"], "-", h.get("description", ""))

issues = okf.lint()
# both accept workspace_id=<KB workspace UUID> to target a specific knowledge base

TypeScript

import { AllyBuildClient, OkfApi, ALLYBUILD_API_URL, TASK_JWT, PROJECT_ID } from "@allybuild/sdk";

const client = new AllyBuildClient(ALLYBUILD_API_URL, TASK_JWT, PROJECT_ID);
const okf = new OkfApi(client);

const hits = await okf.search("refund policy");
const issues = await okf.lint();

// both accept an optional KB workspace: search(query, workspaceId) / lint(workspaceId)