Skip to main content
POST
Call Tool

Endpoint

Authentication

Authorization
string
required
Outlit API key using the Bearer ok_... format.

Request Body

tool
string
required
Customer intelligence tool name. Must be one of the supported tool names below.
input
object
default:"{}"
Tool-specific input object. The input is validated against the shared @outlit/tools contract before the tool runs.

Supported Tools

Tool input schemas are published by @outlit/tools as customerToolContracts. Use that package when building schema-driven clients or model tool definitions.
outlit_send_notification is an action tool. Call it only when the user explicitly asks you to send, post, or notify a result. Prefer markdown for the human-readable body; payload can still carry JSON-serializable context. If destinations is omitted, Outlit uses the organization’s default notifier, currently Slack.

TypeScript Client

Use @outlit/tools when you want the same tool names and input contracts that power the CLI, Pi package, and public tool gateway:
The package also exports customerToolContracts, defaultAgentToolNames, actionToolNames, sqlToolNames, allCustomerToolNames, and enum lists such as customerSourceTypes for schema-driven agent integrations. OPPORTUNITY is the canonical CRM opportunity source type; CRM and CRM_OPPORTUNITY are accepted input aliases. SDK helpers and CLI commands trim and normalize source type filters before calling the tool gateway.

Examples

List Paying Customers

Get Customer Details

Search Customer Context

List Active Facts From Calls And Opportunities

Open One Source Record

Send a Slack Notification

Response

The response is the selected tool’s JSON result. List tools return paginated collections; exact lookup tools return the matched record or an error when the record cannot be found. Search returns grouped artifact-level source and fact results, not raw vector chunks. Fact results include provenance fields such as sourceType, sourceId, sourceOccurredAt, sourceQuote, and permalink when available. Example list response:

Error Responses

Invalid JSON, unknown tool names, or invalid tool inputs return 400:
Invalid credentials return 401. Plan API-call limits can return 402 or 429 with a stable billing code.