Skip to main content
POST
Call Tool

Endpoint

Authentication

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

Request Body

string
required
Customer intelligence tool name. Must be one of the supported tool names below.
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 publicToolContracts. Use that package when building schema-driven clients or model tool definitions.

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 publicToolContracts, publicToolNames, Core-owned consumerToolPolicies, defaultToolNames, analyticalToolNames, piToolNames, cliToolNames, allPublicToolNames, publicOpenApiTransports, toolGatewayTransport, apiKeyValidationTransport, toolGatewayErrorCodes, toolGatewayErrorSchema, ingestTransport, and enum lists such as customerSourceTypes. OPPORTUNITY is the canonical CRM opportunity source type; CRM and CRM_OPPORTUNITY are accepted input aliases.

Examples

List Paying Customers

Get Customer Details

Search Customer Context

List Active Contact Transition Facts

Open One Source Record

Read Customer Features

Feature usage is factual historical evidence. A feature can report complete or partial counts, no matches in the requested window, or unavailable source evidence. Unavailable evidence is not converted to zero. Archive is the only self-service lifecycle action in the MVP. Creating a Feature also creates the supporting weekly event-count and active-days metrics inside Outlit; those metrics are not separate public resources.

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.