Skip to content

Tools

12 methods on the Tools resource.

12 methods · 0 available to app tokens36 pages in SDK Reference

OpenAI Open in ChatGPTClaude Open in ClaudeGitHub Invertocat
import { Compozy } from "@compozy/client";

12 of 12

cancelPendingToolApproval

Cancel one pending tool approval

compozy.tools.cancelPendingToolApproval({ path, query }) → Promise<ToolApprovalStatusResponse>

Options

idstringpathrequired
Stable approval id
profilestringquery
Profile that owns the approval

POST /api/tools/approvals/{id}/cancelapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.tools.cancelPendingToolApproval({ path: { "id": "id" } });

createToolApproval

Mint a local single-use approval token for one tool invocation

compozy.tools.createToolApproval({ path, query, body }) → Promise<ToolApprovalResponse>

Options

idstringpathrequired
Canonical tool id
profilestringquery
Act as this profile by name

Request bodyToolApprovalRequest

POST /api/tools/{id}/approvalsapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.tools.createToolApproval({ path: { "id": "id" }, body: { /* request fields */ } });

getPendingToolApproval

Get one pending tool approval lifecycle

compozy.tools.getPendingToolApproval({ path, query }) → Promise<ToolApprovalStatusResponse>

Options

idstringpathrequired
Stable approval id
profilestringquery
Profile that owns the approval

GET /api/tools/approvals/{id}app tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.tools.getPendingToolApproval({ path: { "id": "id" } });

getTool

Get one operator-visible registry tool

compozy.tools.getTool({ path, query }) → Promise<ToolResponse>

Options

idstringpathrequired
Canonical tool id
workspace_idstringquery
Effective workspace id
workspacestringquery
Effective workspace reference
session_idstringquery
Effective session id
agent_namestringquery
Effective agent name
profilestringquery
Act as this profile by name

GET /api/tools/{id}app tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.tools.getTool({ path: { "id": "id" } });

invokeTool

Invoke a registry tool through executable dispatch

compozy.tools.invokeTool({ path, query, body }) → Promise<InvokeToolResponse>

Options

idstringpathrequired
Canonical tool id
profilestringquery
Act as this profile by name

Request bodyToolInvokeRequest

POST /api/tools/{id}/invokeapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.tools.invokeTool({ path: { "id": "id" }, body: { /* request fields */ } });

listToolApprovalGrants

List remembered native-tool approval decisions for one workspace

compozy.tools.listToolApprovalGrants({ query }) → Promise<ToolApprovalGrantListResponse>

Options

workspace_idstringqueryrequired
Workspace id or reference

GET /api/tool-approval-grantsapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.tools.listToolApprovalGrants({ query: { "workspace_id": "workspace_id" } });

listTools

List operator-visible registry tools

compozy.tools.listTools({ query }) → Promise<ToolsResponse>

Options

workspace_idstringquery
Effective workspace id
workspacestringquery
Effective workspace reference
session_idstringquery
Effective session id
agent_namestringquery
Effective agent name
profilestringquery
Act as this profile by name

GET /api/toolsapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.tools.listTools();

readToolArtifact

Read one retained oversized tool-result page

compozy.tools.readToolArtifact({ path, query }) → Promise<ToolArtifactPageResponse>

Options

workspace_idstringpathrequired
Durable workspace id or @user
artifact_idstringpathrequired
Opaque content-addressed artifact id
offsetintegerquery
Zero-based byte offset
limitintegerquery
Page size in bytes; defaults to and is capped at 65536
profilestringquery
Act as this profile by name

GET /api/workspaces/{workspace_id}/tool-artifacts/{artifact_id}app tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.tools.readToolArtifact({ path: { "workspace_id": "workspace_id", "artifact_id": "artifact_id" } });

resolvePendingToolApproval

Approve or deny one pending tool approval

compozy.tools.resolvePendingToolApproval({ path, query, body }) → Promise<ToolApprovalStatusResponse>

Options

idstringpathrequired
Stable approval id
profilestringquery
Profile that owns the approval

Request bodyResolveToolApprovalRequest

POST /api/tools/approvals/{id}/resolveapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.tools.resolvePendingToolApproval({ path: { "id": "id" }, body: { /* request fields */ } });

revokeToolApprovalGrant

Revoke one remembered native-tool approval decision in one workspace

compozy.tools.revokeToolApprovalGrant({ path, query }) → Promise<void>

Options

idstringpathrequired
Remembered approval grant id
workspace_idstringqueryrequired
Workspace id or reference

DELETE /api/tool-approval-grants/{id}app tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.tools.revokeToolApprovalGrant({ path: { "id": "id" }, query: { "workspace_id": "workspace_id" } });
Show all 12 methods

searchTools

Search operator-visible registry tools

compozy.tools.searchTools({ query, body }) → Promise<ToolsResponse>

Options

profilestringquery
Act as this profile by name

Request bodyToolSearchRequest

POST /api/tools/searchapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.tools.searchTools({ body: { /* request fields */ } });

setToolApprovalGrant

Set an explicit agent-wide or tool-wide native-tool approval decision

compozy.tools.setToolApprovalGrant({ query, body }) → Promise<ToolApprovalGrantResponse>

Options

workspace_idstringqueryrequired
Workspace id or reference

Request bodyToolApprovalGrantSetRequest

PUT /api/tool-approval-grantsapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.tools.setToolApprovalGrant({ query: { "workspace_id": "workspace_id" }, body: { /* request fields */ } });