Call customer intelligence tool

Call a public customer intelligence tool through the shared Outlit tool gateway.

POST /api/tools/call

Call customer intelligence tool

cURL

curl --request POST \
  --url https://app.outlit.ai/api/tools/call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tool": "outlit_search_customer_context",
  "input": {
    "customer": "acme.com",
    "query": "What renewal concerns came up recently?",
    "topK": 5
  }
}
'

import requests

url = "https://app.outlit.ai/api/tools/call"

payload = {
    "tool": "outlit_search_customer_context",
    "input": {
        "customer": "acme.com",
        "query": "What renewal concerns came up recently?",
        "topK": 5
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    tool: 'outlit_search_customer_context',
    input: {
      customer: 'acme.com',
      query: 'What renewal concerns came up recently?',
      topK: 5
    }
  })
};

fetch('https://app.outlit.ai/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://app.outlit.ai/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' => 'outlit_search_customer_context',
    'input' => [
        'customer' => 'acme.com',
        'query' => 'What renewal concerns came up recently?',
        'topK' => 5
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://app.outlit.ai/api/tools/call"

	payload := strings.NewReader("{\n  \"tool\": \"outlit_search_customer_context\",\n  \"input\": {\n    \"customer\": \"acme.com\",\n    \"query\": \"What renewal concerns came up recently?\",\n    \"topK\": 5\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://app.outlit.ai/api/tools/call")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tool\": \"outlit_search_customer_context\",\n  \"input\": {\n    \"customer\": \"acme.com\",\n    \"query\": \"What renewal concerns came up recently?\",\n    \"topK\": 5\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.outlit.ai/api/tools/call")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tool\": \"outlit_search_customer_context\",\n  \"input\": {\n    \"customer\": \"acme.com\",\n    \"query\": \"What renewal concerns came up recently?\",\n    \"topK\": 5\n  }\n}"

response = http.request(request)
puts response.read_body

200

{}

{
  "error": "Invalid tool input",
  "details": [
    {
      "path": [
        "limit"
      ],
      "message": "Too big: expected number to be <=1000"
    }
  ]
}

{
  "error": "Invalid credentials"
}

{
  "error": "<string>",
  "code": "<string>",
  "plan": "<string>",
  "feature": "<string>",
  "resetAt": 123
}

{
  "error": "<string>",
  "code": "<string>",
  "plan": "<string>",
  "feature": "<string>",
  "resetAt": 123
}

{
  "error": "Internal server error"
}

Authorizations

Authorization · string · header · required

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

Body

application/json

tool · enum<string> · required

Customer intelligence tool name from @outlit/tools.

Available options: outlit_list_customers, outlit_list_users, outlit_list_workspace_users, outlit_get_customer, outlit_get_timeline, outlit_list_facts, outlit_get_fact, outlit_get_source, outlit_list_sources, outlit_search_customer_context, outlit_query, outlit_schema, outlit_send_notification

input · object

Tool-specific input object validated against the shared @outlit/tools contract.

Response

200

application/json

Tool-specific JSON result.

The response is of type object.