TextQL Ontology Management Service API
The OntologyManagementService API from TextQL — 69 operation(s) for ontologymanagementservice.
Operations 69
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
POST
/textql.rpc.public.patches.OntologyManagementService/AddOntologySubmodule
Add a git submodule to the Ontology · AddOntologySubmodule
#
Ask an LLM
“Can I pull another git repository into my TextQL Ontology as a submodule?”
“Which branch does an Ontology submodule track when I mount an external repo?”
Tell an agent
Add the repo at {url} as an Ontology submodule mounted at {path}.
Mount submodule {url} at {path} tracking branch {branch}.
POST
/textql.rpc.public.patches.OntologyManagementService/ApprovePatch
Approve a pending Ontology patch · ApprovePatch
#
Ask an LLM
“What do I need to sign off on a patch someone proposed to the Ontology?”
“Why does approving an Ontology patch ask for the expected git ref?”
Tell an agent
Approve Ontology patch {patchId} at git ref {expectedGitRef}.
Give my approval to patch {patchId} so it can merge.
POST
/textql.rpc.public.patches.OntologyManagementService/ConfigureOntologyRemote
Connect the Ontology to a remote git repository · ConfigureOntologyRemote
#
Ask an LLM
“How do I link my Ontology to a hosted git repo so changes sync both ways?”
“Which auth methods can the Ontology git remote use: access token, SSH key or an app installation?”
Tell an agent
Set the Ontology git remote to {remoteUrl} with default branch {defaultBranch}.
Connect the Ontology to {remoteUrl} using auth type {authType} and push mode {pushMode}.
POST
/textql.rpc.public.patches.OntologyManagementService/CreateApprovalRule
Create an Ontology approval rule · CreateApprovalRule
#
Ask an LLM
“Can I require a certain number of reviewers before Ontology patches merge?”
“What does a new approval rule for Ontology folders look like?”
Tell an agent
Create a new Ontology approval rule defined as {rule}.
Add approval rule {rule} to govern patch merges.
POST
/textql.rpc.public.patches.OntologyManagementService/CreateContextPatchAutoApproveRule
Create a rule that auto-approves context patches · CreateContextPatchAutoApproveRule
#
Ask an LLM
“Can some context patches merge automatically without a human reviewer?”
“How do I set up auto-approval for low-risk context changes?”
Tell an agent
Create a context patch auto-approve rule: {rule}.
Add auto-approve rule {rule} so matching context patches skip review.
POST
/textql.rpc.public.patches.OntologyManagementService/CreateOntologyDirectory
Create a folder in the Ontology · CreateOntologyDirectory
#
Ask an LLM
“How do I add a new folder to the Ontology library?”
“Does creating an Ontology directory produce a commit with a message?”
Tell an agent
Create Ontology directory {path}.
Make folder {path} in the Ontology with commit message {commitMessage}.
POST
/textql.rpc.public.patches.OntologyManagementService/CreateOntologyFileUploadUrl
Get an upload URL for a new Ontology file · Streams how many folders and files a subtree holds, so the UI can report the…
#
Ask an LLM
“How do I upload a large binary file into the Ontology?”
“Do I need to state the MIME type and size before uploading an Ontology file?”
Tell an agent
Get an upload URL for Ontology file {path} of type {mimeType} and {sizeBytes} bytes.
Start an upload for {path} into the Ontology.
POST
/textql.rpc.public.patches.OntologyManagementService/DeleteApprovalRule
Delete an Ontology approval rule · DeleteApprovalRule
#
Ask an LLM
“How do I remove an approval rule that patches no longer need to satisfy?”
“What happens to merge requirements when I delete an approval rule?”
Tell an agent destructive · confirm first
Delete Ontology approval rule {id}.
Remove the merge approval requirement with rule id {id}.
POST
/textql.rpc.public.patches.OntologyManagementService/DeleteContextPatchAutoApproveRule
Delete a context patch auto-approve rule · DeleteContextPatchAutoApproveRule
#
Ask an LLM
“How do I stop context patches from being auto-approved?”
“Can I drop a single auto-approve rule and keep the others?”
Tell an agent destructive · confirm first
Delete context patch auto-approve rule {id}.
Turn off auto-approval by removing rule {id}.
POST
/textql.rpc.public.patches.OntologyManagementService/DeleteOntologyDirectory
Delete a folder from the Ontology · DeleteOntologyDirectory
#
Ask an LLM
“Can I delete an Ontology folder along with everything inside it?”
“What happens if I remove a non-empty Ontology directory without the recursive flag?”
Tell an agent destructive · confirm first
Delete Ontology directory {path} recursively.
Remove folder {path} from the Ontology with commit message {commitMessage}.
POST
/textql.rpc.public.patches.OntologyManagementService/DeleteOntologyFile
Delete a file from the Ontology · DeleteOntologyFile
#
Ask an LLM
“How do I delete a single file from the Ontology library?”
“Is deleting an Ontology file recorded as a commit?”
Tell an agent destructive · confirm first
Delete Ontology file {path}.
Remove file {path} from the Ontology, committing with {commitMessage}.
POST
/textql.rpc.public.patches.OntologyManagementService/DenyPatch
Deny a pending Ontology patch · DenyPatch
#
Ask an LLM
“How do I reject a patch someone proposed to the Ontology?”
“Can a denied Ontology patch be brought back later?”
Tell an agent
Deny Ontology patch {patchId} at git ref {expectedGitRef}.
Reject proposed patch {patchId}.
POST
/textql.rpc.public.patches.OntologyManagementService/ExchangeOntologyGithubCode
Finish GitHub OAuth for the Ontology remote · ExchangeOntologyGithubCode
#
Ask an LLM
“After the git host redirects back, how do I complete the Ontology connection with the auth code?”
“Does finishing the Ontology git OAuth flow need a PKCE code verifier?”
Tell an agent
Exchange OAuth code {code} with state {state} to finish linking the Ontology repo.
Complete the Ontology repo OAuth using code {code} and verifier {codeVerifier}.
POST
/textql.rpc.public.patches.OntologyManagementService/FinalizeOntologyFileUpload
Commit an uploaded file into the Ontology · FinalizeOntologyFileUpload
#
Ask an LLM
“Once my file is uploaded, how do I commit it into the Ontology?”
“What upload key do I pass to finalize an Ontology file upload?”
Tell an agent
Finalize the upload {uploadKey} as Ontology file {path}.
Commit uploaded file {path} with message {commitMessage}.
POST
/textql.rpc.public.patches.OntologyManagementService/GetCodeownerCoverage
Check how much of the Ontology has owners · GetCodeownerCoverage
#
Ask an LLM
“Which parts of my Ontology have no code owners assigned?”
“How much of the Ontology is covered by OWNERS rules?”
Tell an agent
Show the Ontology's codeowner coverage.
Report OWNERS coverage across the Ontology, timing out after {timeout_ms} ms.
POST
/textql.rpc.public.patches.OntologyManagementService/GetConfigExportCapabilities
See which objects can be exported as config · GetConfigExportCapabilities
#
Ask an LLM
“Which object types can I save into the Ontology as config files?”
“Am I allowed to export dashboards and playbooks as config?”
Tell an agent
List my config export capabilities.
Check config export permissions with a {timeout_ms} ms timeout.
POST
/textql.rpc.public.patches.OntologyManagementService/GetEffectiveOntologyOwners
Get the owners that actually apply to a path · GetEffectiveOntologyOwners
#
Ask an LLM
“Who effectively owns this Ontology path once inherited OWNERS rules are applied?”
“Which owners govern a file that has no OWNERS entry of its own?”
Tell an agent
Show the effective owners for Ontology path {path}.
Resolve inherited ownership for {path}.
POST
/textql.rpc.public.patches.OntologyManagementService/GetFileUsage
Rank Ontology files by usage · GetFileUsage
#
Ask an LLM
“Which Ontology files get used the most in chats?”
“Can I see file usage for just one folder over a chosen period?”
Tell an agent
Rank Ontology files under {pathPrefix} by usage over {observationPeriod}.
List file usage sorted {order}, {pageSize} per page.
POST
/textql.rpc.public.patches.OntologyManagementService/GetFileUsageTimeline
Chart Ontology file usage over time · GetFileUsageTimeline
#
Ask an LLM
“How has usage of files in an Ontology folder trended over time?”
“Is there a day-by-day timeline of Ontology file usage?”
Tell an agent
Show the usage timeline for files under {pathPrefix}.
Chart file usage under {pathPrefix} across {observationPeriod}.
POST
/textql.rpc.public.patches.OntologyManagementService/GetOntologyAnaConfig
Read the Ana config for an Ontology folder · GetOntologyAnaConfig
#
Ask an LLM
“What Ana configuration is set on this Ontology folder?”
“Is auto-attach turned on for a given Ontology path?”
Tell an agent
Get the Ana config at Ontology path {path}.
Show auto-attach and codeowner settings for {path}.
POST
/textql.rpc.public.patches.OntologyManagementService/GetOntologyFile
Read a file from the Ontology · GetOntologyFile
#
Ask an LLM
“How do I fetch the contents of one Ontology file?”
“Can I read a context file straight from the Ontology library?”
Tell an agent
Open Ontology file {path}.
Show me the current contents of {path} in the Ontology.
POST
/textql.rpc.public.patches.OntologyManagementService/GetOntologyGithubOAuthURL
Start GitHub OAuth for the Ontology remote · GetOntologyGithubOAuthURL
#
Ask an LLM
“Where do I send a user to authorize repo access for the Ontology?”
“Does the Ontology repo authorize link support a PKCE code challenge?”
Tell an agent
Get the repo OAuth authorize URL for the Ontology with state {state}.
Build the Ontology repo authorize link using challenge {codeChallenge}.
POST
/textql.rpc.public.patches.OntologyManagementService/GetOntologyHistoryFileDiff
Show a file's diff in a past Ontology commit · GetOntologyHistoryFileDiff
#
Ask an LLM
“What changed in a specific file in an earlier Ontology commit?”
“Can I see the diff for one path in Ontology history?”
Tell an agent
Show the diff of {path} in Ontology commit {commitId}.
Show the file diff from Ontology commit {commitId}.
POST
/textql.rpc.public.patches.OntologyManagementService/GetOntologyOwners
Read the OWNERS entries set on a path · GetOntologyOwners
#
Ask an LLM
“What OWNERS entries are defined directly on this Ontology folder?”
“How do I check who is listed as owner of a specific Ontology path?”
Tell an agent
Get the OWNERS entries declared on {path}.
List owners configured on Ontology folder {path}.
POST
/textql.rpc.public.patches.OntologyManagementService/GetOntologyRemote
Show the Ontology's git remote settings · GetOntologyRemote
#
Ask an LLM
“Which git repository is my Ontology connected to?”
“What push mode and default branch does the Ontology remote use?”
Tell an agent
Show the Ontology git remote configuration.
Fetch remote settings for the Ontology within {timeout_ms} ms.
POST
/textql.rpc.public.patches.OntologyManagementService/GetOntologySizeTimeline
Track the Ontology's size over time · GetOntologySizeTimeline
#
Ask an LLM
“How has the number of files in my Ontology grown?”
“Is there a size history for the Ontology over a chosen period?”
Tell an agent
Show the Ontology size timeline for {observationPeriod}.
Chart how big the Ontology has gotten.
POST
/textql.rpc.public.patches.OntologyManagementService/GetOntologySyncConflicts
List git sync conflicts in the Ontology · GetOntologySyncConflicts
#
Ask an LLM
“Are there merge conflicts blocking my Ontology from syncing with its remote?”
“Which files conflict between the Ontology and the remote repo?”
Tell an agent
Show outstanding Ontology sync conflicts.
Check for remote sync conflicts with a {timeout_ms} ms deadline.
POST
/textql.rpc.public.patches.OntologyManagementService/GetOntologyUsageSummary
Summarize Ontology usage · GetOntologyUsageSummary
#
Ask an LLM
“How heavily is the Ontology being used overall?”
“Can I get a headline usage summary of the Ontology for the last period?”
Tell an agent
Summarize Ontology usage over {observationPeriod}.
Give me the overall Ontology usage summary.
POST
/textql.rpc.public.patches.OntologyManagementService/GetPatch
Get an Ontology patch by id · GetPatch
#
Ask an LLM
“How do I look up an Ontology patch using its id?”
“Can I view an older revision of an Ontology patch?”
Tell an agent
Get Ontology patch {patchId}.
Show revision {revision} of patch {patchId}.
POST
/textql.rpc.public.patches.OntologyManagementService/GetPatchByNumber
Get an Ontology patch by its number · GetPatchByNumber
#
Ask an LLM
“Can I open an Ontology patch using its short number instead of the id?”
“Where do I find patch number 42 from the review list?”
Tell an agent
Open Ontology patch number {number}.
Look up the patch numbered {number}.
POST
/textql.rpc.public.patches.OntologyManagementService/GetPatchCapabilities
See what actions I can take on a patch · PlanConfigMigration reports what the lazy config migration WOULD do to this…
#
Ask an LLM
“Am I allowed to approve, deny or revert this Ontology patch?”
“Which review actions are open to me on a given patch?”
Tell an agent
Check my capabilities on patch {patchId}.
Tell me which actions I can take on Ontology patch {patchId}.
POST
/textql.rpc.public.patches.OntologyManagementService/GetRawPatch
Download the raw diff of an Ontology patch · GetRawPatch
#
Ask an LLM
“Can I get the raw git patch text for an Ontology change?”
“How do I export a patch as a plain diff?”
Tell an agent
Get the raw patch text for patch number {patchNumber}.
Export patch {patchNumber} as a unified diff.
POST
/textql.rpc.public.patches.OntologyManagementService/GetUsageDetailsForFile
Get usage details for one Ontology file · GetUsageDetailsForFile
#
Ask an LLM
“How often is a particular Ontology file used, and by whom?”
“Can I drill into the usage of a single file over a period?”
Tell an agent
Show usage details for Ontology file {filePath}.
Break down usage of {filePath} over {observationPeriod}.
POST
/textql.rpc.public.patches.OntologyManagementService/ListApprovalRules
List Ontology approval rules · ListApprovalRules
#
Ask an LLM
“What approval rules currently gate Ontology patch merges?”
“Which folders require reviewers before patches can merge?”
Tell an agent
List all Ontology approval rules.
Show the approval rules, waiting at most {timeout_ms} ms.
POST
/textql.rpc.public.patches.OntologyManagementService/ListChatsForFile
List chats that used an Ontology file · ListChatsForFile
#
Ask an LLM
“Which chats pulled in a given Ontology file?”
“Can I see the conversations that referenced a context file recently?”
Tell an agent
List chats that used {filePath}.
Show up to {limit} chats referencing {filePath} during {observationPeriod}.
POST
/textql.rpc.public.patches.OntologyManagementService/ListContextPatchAutoApproveRules
List context patch auto-approve rules · ListContextPatchAutoApproveRules
#
Ask an LLM
“Which rules let context patches merge without review?”
“What auto-approve rules exist for context patches today?”
Tell an agent
List the context patch auto-approve rules.
Show all auto-approve rules with a {timeout_ms} ms timeout.
POST
/textql.rpc.public.patches.OntologyManagementService/ListGoldenFiles
List Ontology files marked golden (deprecated) · Deprecated: use SetOntologyOwners with the desired entry set.
#
Ask an LLM
“Which Ontology files are flagged as golden?”
“Is the golden files list still supported now that OWNERS exists?”
Tell an agent
List the golden Ontology files.
Fetch the legacy golden file list within {timeout_ms} ms.
POST
/textql.rpc.public.patches.OntologyManagementService/ListOntologyEntries
Browse files and folders in the Ontology · ListOntologyEntries
#
Ask an LLM
“How do I browse the contents of an Ontology folder?”
“Can I list everything under an Ontology path recursively, including debug files?”
Tell an agent
List the entries in Ontology folder {path}.
Recursively list everything under {path} in the Ontology.
POST
/textql.rpc.public.patches.OntologyManagementService/ListOntologyHistory
List the Ontology's commit history · ListOntologyHistory
#
Ask an LLM
“What is the recent commit history of my Ontology?”
“Can I see the change history for just one Ontology path?”
Tell an agent
Show the Ontology commit history for {path}.
List the last {pageSize} Ontology commits.
POST
/textql.rpc.public.patches.OntologyManagementService/ListOntologyImports
List imports into the Ontology · ListOntologyImports
#
Ask an LLM
“What has been imported into my Ontology?”
“Is there a record of Ontology imports I can review?”
Tell an agent
List Ontology imports.
Show the Ontology import list, waiting up to {timeout_ms} ms.
POST
/textql.rpc.public.patches.OntologyManagementService/ListOntologySubmodules
List git submodules in the Ontology · ListOntologySubmodules
#
Ask an LLM
“Which external repos are mounted as submodules in the Ontology?”
“Where are the Ontology submodules mounted and which branches do they track?”
Tell an agent
List the Ontology's submodules.
Show every mounted submodule with a {timeout_ms} ms timeout.
POST
/textql.rpc.public.patches.OntologyManagementService/ListOntologySyncRuns
List past Ontology sync runs · ListOntologySyncRuns
#
Ask an LLM
“When did the Ontology last sync with its git remote, and did it succeed?”
“Can I page through the history of Ontology sync runs?”
Tell an agent
List recent Ontology sync runs.
Show {pageSize} sync runs starting from page token {pageToken}.
POST
/textql.rpc.public.patches.OntologyManagementService/ListPatchObjects
List the config objects in a patch · ListPatchObjects parses the config objects present at a patch's git ref and…
#
Ask an LLM
“Which playbooks and dashboards does a patch's config touch?”
“Can I see the display names and types of objects at a patch's git ref?”
Tell an agent
List the config objects in patch ref {patchRef}.
Show object types and Library paths at {patchRef}.
POST
/textql.rpc.public.patches.OntologyManagementService/ListPatchReviewers
List reviewers on an Ontology patch · ListPatchReviewers
#
Ask an LLM
“Who has been asked to review this Ontology patch?”
“Which reviewers are assigned to a given patch?”
Tell an agent
List reviewers for patch {patchId}.
Show who is reviewing Ontology patch {patchId}.
POST
/textql.rpc.public.patches.OntologyManagementService/ListPatches
List Ontology patches · ListPatches
#
Ask an LLM
“What Ontology patches are open and waiting for review?”
“Can I filter Ontology patches by status and hide auto-approved ones?”
Tell an agent
List Ontology patches with status {statuses}.
Show the {pageSize} most recent patches, including auto-approved ones.
POST
/textql.rpc.public.patches.OntologyManagementService/ListSkills
List skills available in the Ontology · ListSkills
#
Ask an LLM
“Which skills can I invoke with the slash autocomplete in chat?”
“Can I include unlisted skills when listing Ontology skills?”
Tell an agent
List the Ontology skills I can read.
List skills with include unlisted set to {includeUnlisted}.
POST
/textql.rpc.public.patches.OntologyManagementService/PlanOntologyMerge
Plan a merge between the Ontology and remote · PlanOntologyMerge
#
Ask an LLM
“What would a merge between my Ontology and its remote branch look like?”
“Can I plan an Ontology merge before running it?”
Tell an agent
Plan the Ontology merge with the remote.
Produce an Ontology merge plan within {timeout_ms} ms.
POST
/textql.rpc.public.patches.OntologyManagementService/PreviewOntologyPullFromRemote
Preview pulling remote changes into the Ontology · PreviewOntologyPullFromRemote
#
Ask an LLM
“What would change if I pulled the latest commits from the Ontology's remote?”
“Can I see incoming remote changes before pulling them into the Ontology?”
Tell an agent
Preview a pull from the Ontology remote.
Show incoming remote commits without applying them, timeout {timeout_ms} ms.
POST
/textql.rpc.public.patches.OntologyManagementService/PullOntologyFromRemote
Pull remote git changes into the Ontology · PullOntologyFromRemote
#
Ask an LLM
“How do I bring the latest commits from the remote repo into my Ontology?”
“Can I pull from a remote whose history is unrelated to the Ontology's?”
Tell an agent
Pull the Ontology from its remote, expecting remote head {expectedRemoteHeadHash}.
Pull remote changes onto local head {expectedLocalHeadHash}, acknowledging unrelated histories.
POST
/textql.rpc.public.patches.OntologyManagementService/PushOntologyToRemote
Push the Ontology to its git remote · PushOntologyToRemote
#
Ask an LLM
“How do I push my Ontology's commits up to the connected repo?”
“Can I force an Ontology push instead of waiting for the sync interval?”
Tell an agent
Push the Ontology to its remote now.
Push Ontology commits upstream, allowing {timeout_ms} ms.
POST
/textql.rpc.public.patches.OntologyManagementService/RecoverOntology
Recover a broken Ontology · RecoverOntology
#
Ask an LLM
“My Ontology repo is in a bad state; can I recover it?”
“What recovery levels are available when restoring the Ontology?”
Tell an agent destructive · confirm first
Recover the Ontology at level {level}.
Run Ontology recovery using recovery level {level}.
POST
/textql.rpc.public.patches.OntologyManagementService/RemoveOntologyRemote
Disconnect the Ontology from its git remote · Lists the skills under the ontology's flat skills/ root that the caller can…
#
Ask an LLM
“How do I unlink my Ontology from the remote repo it syncs with?”
“What happens to syncing once the Ontology remote is removed?”
Tell an agent destructive · confirm first
Remove the Ontology's git remote.
Disconnect the remote repo from the Ontology with a {timeout_ms} ms timeout.
POST
/textql.rpc.public.patches.OntologyManagementService/RemoveOntologySubmodule
Remove a git submodule from the Ontology · RemoveOntologySubmodule
#
Ask an LLM
“How do I unmount an external repo that was added as an Ontology submodule?”
“Can I drop a submodule without touching the rest of the Ontology?”
Tell an agent destructive · confirm first
Remove the Ontology submodule at {path}.
Unmount submodule {path}.
POST
/textql.rpc.public.patches.OntologyManagementService/RenameOntologyFile
Rename or move an Ontology file · RenameOntologyFile
#
Ask an LLM
“How do I rename a file in the Ontology?”
“Can I move an Ontology file to another folder in one commit?”
Tell an agent
Rename Ontology file {oldPath} to {newPath}.
Move {oldPath} to {newPath} with commit message {commitMessage}.
POST
/textql.rpc.public.patches.OntologyManagementService/RequestPatchReview
Request a review on an Ontology patch · RequestPatchReview
#
Ask an LLM
“How do I ask a teammate to review my Ontology patch?”
“Can I assign a specific member as reviewer on a patch?”
Tell an agent
Request review of patch {patchId} from member {reviewerMemberId}.
Ask {reviewerMemberId} to review my Ontology patch.
POST
/textql.rpc.public.patches.OntologyManagementService/ResolveOntologySyncConflict
Resolve an Ontology sync conflict · TriggerConfigDriftReconcile forces an immediate config-sync catch-up for the…
#
Ask an LLM
“How do I fix a merge conflict between the Ontology and its remote?”
“Can I supply the resolved file content for a sync conflict?”
Tell an agent
Resolve sync conflict {conflictId} with content {resolvedContent}.
Mark Ontology conflict {conflictId} as resolved.
POST
/textql.rpc.public.patches.OntologyManagementService/RestorePatch
Restore a denied Ontology patch · RestorePatch
#
Ask an LLM
“Can I reopen an Ontology patch that was denied?”
“How do I bring a rejected patch back into review?”
Tell an agent
Restore denied patch {patchId} at git ref {expectedGitRef}.
Reopen rejected Ontology patch {patchId}.
POST
/textql.rpc.public.patches.OntologyManagementService/RevertPatch
Revert a merged Ontology patch · RevertPatch
#
Ask an LLM
“How do I undo a patch that already merged into the Ontology?”
“Can I roll back the changes a merged patch made?”
Tell an agent destructive · confirm first
Revert merged patch {patchId}.
Undo the Ontology changes from patch {patchId}.
POST
/textql.rpc.public.patches.OntologyManagementService/SaveAllObjectsAsConfig
Export all objects of a type as Ontology config · SaveAllObjectsAsConfig
#
Ask an LLM
“Can I save every playbook or dashboard into the Ontology as config files at once?”
“How do I bulk-export all objects of one type as config?”
Tell an agent
Save all {objectType} objects as Ontology config.
Bulk-export every object of type {objectType} into config files.
POST
/textql.rpc.public.patches.OntologyManagementService/SaveObjectAsConfig
Export one object as Ontology config · SaveObjectAsConfig
#
Ask an LLM
“How do I save a single dashboard or playbook into the Ontology as config?”
“Can I version one specific object as a config file?”
Tell an agent
Save {objectType} {objectId} as Ontology config.
Export object {objectId} to a config file.
POST
/textql.rpc.public.patches.OntologyManagementService/SetOntologyFileGolden
Mark an Ontology file golden (deprecated) · Deprecated: use SetOntologyOwners with the complete desired entry set
#
Ask an LLM
“How do I flag an Ontology file as golden?”
“Is marking files golden deprecated in favor of OWNERS entries?”
Tell an agent
Mark Ontology file {path} as golden.
Set the golden flag on {path} to {golden}.
POST
/textql.rpc.public.patches.OntologyManagementService/SetOntologyOwners
Set the OWNERS entries for an Ontology path · SetOntologyOwners
#
Ask an LLM
“How do I assign owners to an Ontology folder?”
“Does sending an empty owner set open the directory to everyone?”
Tell an agent
Set owners on {path} to {entries}.
Replace the OWNERS entries for {path} and commit with {commitMessage}.
POST
/textql.rpc.public.patches.OntologyManagementService/TriggerConfigDriftReconcile
Force a config drift reconcile now · TriggerConfigDriftReconcile
#
Ask an LLM
“Can I make TextQL catch up config objects with the Ontology immediately?”
“How do I trigger a config-sync reconcile instead of waiting for the periodic one?”
Tell an agent
Trigger a config drift reconcile for my org.
Reconcile config with the Ontology HEAD now, timing out at {timeout_ms} ms.
POST
/textql.rpc.public.patches.OntologyManagementService/UpdateApprovalRule
Change an existing Ontology approval rule · UpdateApprovalRule
#
Ask an LLM
“How do I edit the requirements of an approval rule I already created?”
“Can I change how many approvers an existing rule demands?”
Tell an agent
Update approval rule {id} to {rule}.
Modify existing Ontology approval rule {id}.
POST
/textql.rpc.public.patches.OntologyManagementService/UpdateContextPatchAutoApproveRule
Change an existing auto-approve rule · UpdateContextPatchAutoApproveRule
#
Ask an LLM
“How do I adjust an auto-approve rule for context patches that already exists?”
“Can I narrow which context patches an existing auto-approve rule covers?”
Tell an agent
Update context patch auto-approve rule {id} to {rule}.
Edit existing auto-approve rule {id}.
POST
/textql.rpc.public.patches.OntologyManagementService/UpdateOntologySyncConfig
Change Ontology git sync settings · UpdateOntologySyncConfig
#
Ask an LLM
“How often does the Ontology sync with its remote, and can I change it?”
“Can I turn automatic Ontology syncing off?”
Tell an agent
Sync the Ontology every {syncIntervalMinutes} minutes.
Set Ontology sync enabled to {syncEnabled} with push mode {pushMode}.
POST
/textql.rpc.public.patches.OntologyManagementService/UpsertOntologyAnaConfig
Create or update Ana config for a folder · UpsertOntologyAnaConfig
#
Ask an LLM
“How do I turn on auto-attach for an Ontology folder's Ana config?”
“Can I set codeowners in the Ana config for a path?”
Tell an agent
Set Ana auto-attach on {path} to {autoAttach}.
Write Ana config for {path} with codeowners {codeowners}.
POST
/textql.rpc.public.patches.OntologyManagementService/UpsertOntologyFile
Create or overwrite an Ontology file · UpsertOntologyFile
#
Ask an LLM
“How do I write a new context file into the Ontology?”
“Can I overwrite an existing Ontology file's text in one call?”
Tell an agent
Write {content} to Ontology file {path}.
Save file {path} in the Ontology with commit message {commitMessage}.
POST
/textql.rpc.public.patches.OntologyManagementService/ValidateConfig
Validate the config in a patch · Read-only functional validation of a proposed config: parse + dependency…
#
Ask an LLM
“Will the config in my patch parse and resolve its dependencies?”
“Does a passing config validation guarantee the patch will merge?”
Tell an agent
Validate the config in patch {patchId}.
Dry-run config validation for {patchId} without saving anything.
Documentation
📖
Documentation
https://docs.textql.com/api-reference/v2/introduction
📖
APIReference
https://docs.textql.com/api-reference/v2/introduction
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/authentication/textql-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/rate-limits/textql-rate-limits.yml
📖
Documentation
https://docs.textql.com/api-reference/introduction
📖
APIReference
https://docs.textql.com/api-reference/introduction
Specifications
Other Resources
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/scopes/textql-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/errors/textql-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/conventions/textql-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/data-model/textql-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/asyncapi/textql-webhooks.yml
🔗
Deprecation
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/lifecycle/textql-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/textql/refs/heads/main/conformance/textql-conformance.yml