Call Tool
curl --request POST \
--url https://api.example.com/api/tools/call \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"tool": "<string>",
"input": {}
}
'import requests
url = "https://api.example.com/api/tools/call"
payload = {
"tool": "<string>",
"input": {}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({tool: '<string>', input: {}})
};
fetch('https://api.example.com/api/tools/call', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/tools/call",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tool' => '<string>',
'input' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/tools/call"
payload := strings.NewReader("{\n \"tool\": \"<string>\",\n \"input\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/tools/call")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"tool\": \"<string>\",\n \"input\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/tools/call")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tool\": \"<string>\",\n \"input\": {}\n}"
response = http.request(request)
puts response.read_bodyPlatform API
Call Tool
Call customer intelligence tools through the public tool gateway
POST
/
api
/
tools
/
call
Call Tool
curl --request POST \
--url https://api.example.com/api/tools/call \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"tool": "<string>",
"input": {}
}
'import requests
url = "https://api.example.com/api/tools/call"
payload = {
"tool": "<string>",
"input": {}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({tool: '<string>', input: {}})
};
fetch('https://api.example.com/api/tools/call', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/tools/call",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'tool' => '<string>',
'input' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/tools/call"
payload := strings.NewReader("{\n \"tool\": \"<string>\",\n \"input\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/tools/call")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"tool\": \"<string>\",\n \"input\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/tools/call")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tool\": \"<string>\",\n \"input\": {}\n}"
response = http.request(request)
puts response.read_bodyEndpoint
POST https://app.outlit.ai/api/tools/call
Authentication
string
required
Outlit API key using the
Bearer ok_... format.Request Body
{
"tool": "outlit_list_customers",
"input": {
"limit": 10,
"billingStatus": "PAYING"
}
}
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 | Purpose |
|---|---|
outlit_list_customers | Browse and filter customers by billing status, activity recency, revenue, traits, or name |
outlit_list_users | Browse and filter users by journey stage, activity recency, customer, traits, email, or name |
outlit_list_workspace_users | Browse internal workspace users such as CSMs, managers, account owners, and admins |
outlit_get_customer | Get full details for one customer, with optional related sections |
outlit_assign_customer_owner | Assign an active workspace member as the customer’s primary owner |
outlit_grant_customer_access | Share a customer with an active workspace member as a Viewer or Editor |
outlit_update_customer_access | Change an existing customer collaborator between Viewer and Editor |
outlit_revoke_customer_access | Remove a collaborator’s explicit access to a customer |
outlit_get_timeline | Get chronological customer activity across product, billing, support, and conversation channels |
outlit_list_facts | Browse stored customer facts and evidence |
outlit_get_fact | Retrieve one exact customer fact |
outlit_get_source | Retrieve one exact source record behind a fact or search result |
outlit_list_sources | List concrete source records such as calls, emails, calendar events, support tickets, Slack conversations, or opportunities |
outlit_search_customer_context | Search customer context semantically |
outlit_query | Run SQL against customer intelligence views |
outlit_schema | Inspect available analytics views |
outlit_list_destinations through outlit_archive_destination | Manage the safe destination lifecycle with masked configuration |
outlit_get_integration_capabilities through outlit_setup_integration | Negotiate and perform bounded integration setup, and read canonical configuration readiness |
outlit_get_customer_activation through outlit_update_customer_activation | Inspect, preview, and configure the ordinary activation event |
outlit_get_workspace_settings, outlit_update_workspace_settings | Read and update safe workspace settings |
outlit_list_features | Read configured Features, exact historical usage, eligible sources, and ready, partial, or unavailable candidate discovery |
outlit_create_feature | Create or idempotently return one Feature observed by one event rule |
outlit_archive_feature | Archive a Feature using its opaque id and current revision when another active feature remains |
outlit_get_customer_features | Read exact historical Feature usage for one authorized customer |
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:
npm install @outlit/tools
import { createOutlitClient, publicToolContracts } from "@outlit/tools"
const outlit = createOutlitClient({
apiKey: process.env.OUTLIT_API_KEY!,
})
const result = await outlit.callTool(
publicToolContracts.outlit_search_customer_context.toolName,
{
query: "What pricing concerns came up recently?",
customer: "acme.com",
sourceTypes: ["CALL", "EMAIL", "SUPPORT_TICKET", "OPPORTUNITY"],
topK: 5,
},
)
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
curl -X POST https://app.outlit.ai/api/tools/call \
-H "Authorization: Bearer ok_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"tool": "outlit_list_customers",
"input": {
"billingStatus": "PAYING",
"limit": 10
}
}'
Get Customer Details
{
"tool": "outlit_get_customer",
"input": {
"customer": "acme.com",
"include": ["users", "revenue", "recentTimeline"],
"timeframe": "30d"
}
}
Search Customer Context
{
"tool": "outlit_search_customer_context",
"input": {
"customer": "acme.com",
"query": "What renewal concerns came up recently?",
"sourceTypes": ["EMAIL", "CALL", "SUPPORT_TICKET", "OPPORTUNITY"],
"after": "2026-01-01T00:00:00Z",
"topK": 5
}
}
List Active Contact Transition Facts
{
"tool": "outlit_list_facts",
"input": {
"customer": "acme.com",
"status": ["ACTIVE"],
"sourceTypes": ["CALL", "OPPORTUNITY"],
"factTypes": ["CONTACT_DEPARTURE", "CONTACT_POSITION_CHANGE", "CONTACT_DISENGAGEMENT"],
"after": "2026-01-01T00:00:00Z",
"limit": 20
}
}
Open One Source Record
{
"tool": "outlit_get_source",
"input": {
"sourceType": "OPPORTUNITY",
"sourceId": "opp_123"
}
}
Read Customer Features
{
"tool": "outlit_get_customer_features",
"input": {
"customer": "acme.com",
"weeks": 12
}
}
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-levelsource 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:
{
"items": [
{
"id": "cus_123",
"name": "Acme",
"domain": "acme.com",
"billingStatus": "PAYING",
"activatedAt": "2026-01-15T09:30:00.000Z",
"firstSeenAt": "2025-12-02T17:05:00.000Z",
"lastActivityAt": "2026-04-10T18:22:11.000Z",
"contactCount": 42,
"currentMrr": 250,
"mrrCalculationStatus": "calculated",
"owner": null,
"daysSinceActivity": 3
}
],
"pagination": {
"hasMore": true,
"nextCursor": "cursor_abc",
"total": 128
}
}
Error Responses
Invalid JSON, unknown tool names, or invalid tool inputs return400:
{
"code": "INVALID_TOOL_INPUT",
"message": "Invalid tool input",
"retryable": false,
"requestId": "req_123"
}
401. Plan API-call limits can return 402 or 429 with a stable billing code.Was this page helpful?