Knowledge Research
curl --request POST \
--url https://api.wistx.ai/v1/knowledge/research \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"domains": {},
"content_types": {},
"include_cross_domain": true,
"include_global": true,
"format": "<string>",
"max_results": 123
}
'import requests
url = "https://api.wistx.ai/v1/knowledge/research"
payload = {
"query": "<string>",
"domains": {},
"content_types": {},
"include_cross_domain": True,
"include_global": True,
"format": "<string>",
"max_results": 123
}
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({
query: '<string>',
domains: {},
content_types: {},
include_cross_domain: true,
include_global: true,
format: '<string>',
max_results: 123
})
};
fetch('https://api.wistx.ai/v1/knowledge/research', 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.wistx.ai/v1/knowledge/research",
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([
'query' => '<string>',
'domains' => [
],
'content_types' => [
],
'include_cross_domain' => true,
'include_global' => true,
'format' => '<string>',
'max_results' => 123
]),
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.wistx.ai/v1/knowledge/research"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"domains\": {},\n \"content_types\": {},\n \"include_cross_domain\": true,\n \"include_global\": true,\n \"format\": \"<string>\",\n \"max_results\": 123\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.wistx.ai/v1/knowledge/research")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"domains\": {},\n \"content_types\": {},\n \"include_cross_domain\": true,\n \"include_global\": true,\n \"format\": \"<string>\",\n \"max_results\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wistx.ai/v1/knowledge/research")
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 \"query\": \"<string>\",\n \"domains\": {},\n \"content_types\": {},\n \"include_cross_domain\": true,\n \"include_global\": true,\n \"format\": \"<string>\",\n \"max_results\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"results": [
{
"article_id": "kb_abc123",
"domain": "security",
"subdomain": "database_security",
"content_type": "best_practice",
"title": "RDS Database Security Best Practices",
"summary": "Comprehensive guide to securing RDS databases including encryption, access control, and monitoring...",
"content": "Full article content...",
"tags": ["rds", "encryption", "iam", "monitoring"],
"categories": ["database", "security"],
"industries": ["finance", "healthcare"],
"cloud_providers": ["aws"],
"services": ["rds", "kms", "cloudwatch"],
"cross_domain_impacts": {
"compliance": {
"standards": ["PCI-DSS", "HIPAA"],
"controls": ["PCI-DSS-3.4", "HIPAA-164.312"]
},
"cost": {
"impact": "Encryption adds minimal cost (~5% overhead)",
"optimization": "Use KMS customer-managed keys for better cost control"
}
},
"source_url": "https://docs.aws.amazon.com/rds/...",
"quality_score": 0.95
}
],
"research_summary": {
"total_found": 45,
"domains_covered": ["security", "compliance", "infrastructure"],
"key_insights": [
"Encryption at rest and in transit is critical for RDS security",
"IAM-based access control reduces attack surface",
"Continuous monitoring detects anomalies early"
]
},
"metadata": {
"query_time_ms": 456,
"filters_applied": {
"domains": ["compliance", "security"],
"content_types": ["guide", "best_practice"]
}
}
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0,
"query_time_ms": 456
}
}
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": "Query must be at least 10 characters"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"detail": "Invalid authorization header. Expected 'Bearer {api_key}'"
}
{
"detail": "Invalid or expired token"
}
{
"error": {
"code": "QUOTA_EXCEEDED",
"message": "Query quota exceeded",
"details": {
"limit_type": "queries_per_month",
"current": 50,
"limit": 50
}
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred",
"details": null
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "DATABASE_ERROR",
"message": "Database connection failed",
"details": "Connection timeout"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
API Reference
Knowledge Research
Deep research tool for DevOps, infrastructure, compliance, FinOps, and platform engineering knowledge
POST
/
v1
/
knowledge
/
research
Knowledge Research
curl --request POST \
--url https://api.wistx.ai/v1/knowledge/research \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"query": "<string>",
"domains": {},
"content_types": {},
"include_cross_domain": true,
"include_global": true,
"format": "<string>",
"max_results": 123
}
'import requests
url = "https://api.wistx.ai/v1/knowledge/research"
payload = {
"query": "<string>",
"domains": {},
"content_types": {},
"include_cross_domain": True,
"include_global": True,
"format": "<string>",
"max_results": 123
}
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({
query: '<string>',
domains: {},
content_types: {},
include_cross_domain: true,
include_global: true,
format: '<string>',
max_results: 123
})
};
fetch('https://api.wistx.ai/v1/knowledge/research', 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.wistx.ai/v1/knowledge/research",
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([
'query' => '<string>',
'domains' => [
],
'content_types' => [
],
'include_cross_domain' => true,
'include_global' => true,
'format' => '<string>',
'max_results' => 123
]),
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.wistx.ai/v1/knowledge/research"
payload := strings.NewReader("{\n \"query\": \"<string>\",\n \"domains\": {},\n \"content_types\": {},\n \"include_cross_domain\": true,\n \"include_global\": true,\n \"format\": \"<string>\",\n \"max_results\": 123\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.wistx.ai/v1/knowledge/research")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"query\": \"<string>\",\n \"domains\": {},\n \"content_types\": {},\n \"include_cross_domain\": true,\n \"include_global\": true,\n \"format\": \"<string>\",\n \"max_results\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wistx.ai/v1/knowledge/research")
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 \"query\": \"<string>\",\n \"domains\": {},\n \"content_types\": {},\n \"include_cross_domain\": true,\n \"include_global\": true,\n \"format\": \"<string>\",\n \"max_results\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"results": [
{
"article_id": "kb_abc123",
"domain": "security",
"subdomain": "database_security",
"content_type": "best_practice",
"title": "RDS Database Security Best Practices",
"summary": "Comprehensive guide to securing RDS databases including encryption, access control, and monitoring...",
"content": "Full article content...",
"tags": ["rds", "encryption", "iam", "monitoring"],
"categories": ["database", "security"],
"industries": ["finance", "healthcare"],
"cloud_providers": ["aws"],
"services": ["rds", "kms", "cloudwatch"],
"cross_domain_impacts": {
"compliance": {
"standards": ["PCI-DSS", "HIPAA"],
"controls": ["PCI-DSS-3.4", "HIPAA-164.312"]
},
"cost": {
"impact": "Encryption adds minimal cost (~5% overhead)",
"optimization": "Use KMS customer-managed keys for better cost control"
}
},
"source_url": "https://docs.aws.amazon.com/rds/...",
"quality_score": 0.95
}
],
"research_summary": {
"total_found": 45,
"domains_covered": ["security", "compliance", "infrastructure"],
"key_insights": [
"Encryption at rest and in transit is critical for RDS security",
"IAM-based access control reduces attack surface",
"Continuous monitoring detects anomalies early"
]
},
"metadata": {
"query_time_ms": 456,
"filters_applied": {
"domains": ["compliance", "security"],
"content_types": ["guide", "best_practice"]
}
}
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0,
"query_time_ms": 456
}
}
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": "Query must be at least 10 characters"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"detail": "Invalid authorization header. Expected 'Bearer {api_key}'"
}
{
"detail": "Invalid or expired token"
}
{
"error": {
"code": "QUOTA_EXCEEDED",
"message": "Query quota exceeded",
"details": {
"limit_type": "queries_per_month",
"current": 50,
"limit": 50
}
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred",
"details": null
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "DATABASE_ERROR",
"message": "Database connection failed",
"details": "Connection timeout"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
Deep research tool for DevOps, infrastructure, compliance, FinOps, and platform engineering knowledge
Base URL: The API playground uses
http://localhost:8000 for local development.
Switch to https://api.wistx.ai for production by selecting the server from the dropdown above.Endpoint
curl --request POST \
--url https://api.wistx.ai/v1/knowledge/research \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"query": "What are the best practices for securing RDS databases?",
"domains": ["compliance", "security"],
"content_types": ["guide", "best_practice"],
"include_cross_domain": true,
"include_global": true,
"format": "structured",
"max_results": 20
}'
import requests
api_key = "YOUR_API_KEY"
url = "https://api.wistx.ai/v1/knowledge/research"
response = requests.post(
url,
headers={
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json"
},
json={
"query": "What are the best practices for securing RDS databases?",
"domains": ["compliance", "security"],
"content_types": ["guide", "best_practice"],
"include_cross_domain": True,
"include_global": True,
"format": "structured",
"max_results": 20
}
)
data = response.json()
print(data)
const apiKey = "YOUR_API_KEY";
const url = "https://api.wistx.ai/v1/knowledge/research";
const response = await fetch(url, {
method: "POST",
headers: {
"Authorization": `Bearer ${apiKey}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
query: "What are the best practices for securing RDS databases?",
domains: ["compliance", "security"],
content_types: ["guide", "best_practice"],
include_cross_domain: true,
include_global: true,
format: "structured",
max_results: 20
})
});
const data = await response.json();
console.log(data);
package main
import (
"bytes"
"encoding/json"
"fmt"
"net/http"
)
func main() {
apiKey := "YOUR_API_KEY"
url := "https://api.wistx.ai/v1/knowledge/research"
payload := map[string]interface{}{
"query": "What are the best practices for securing RDS databases?",
"domains": []string{"compliance", "security"},
"content_types": []string{"guide", "best_practice"},
"include_cross_domain": true,
"include_global": true,
"format": "structured",
"max_results": 20,
}
jsonData, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", apiKey))
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
var result map[string]interface{}
json.NewDecoder(resp.Body).Decode(&result)
fmt.Printf("%+v\n", result)
}
require 'net/http'
require 'json'
require 'uri'
api_key = "YOUR_API_KEY"
url = URI("https://api.wistx.ai/v1/knowledge/research")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = "Bearer #{api_key}"
request["Content-Type"] = "application/json"
request.body = {
query: "What are the best practices for securing RDS databases?",
domains: ["compliance", "security"],
content_types: ["guide", "best_practice"],
include_cross_domain: true,
include_global: true,
format: "structured",
max_results: 20
}.to_json
response = http.request(request)
puts JSON.parse(response.body)
<?php
$apiKey = "YOUR_API_KEY";
$url = "https://api.wistx.ai/v1/knowledge/research";
$data = [
"query" => "What are the best practices for securing RDS databases?",
"domains" => ["compliance", "security"],
"content_types" => ["guide", "best_practice"],
"include_cross_domain" => true,
"include_global" => true,
"format" => "structured",
"max_results" => 20
];
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer " . $apiKey,
"Content-Type: application/json"
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
import java.net.HttpURLConnection;
import java.net.URL;
import java.io.OutputStream;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import com.google.gson.Gson;
import com.google.gson.JsonObject;
public class KnowledgeResearch {
public static void main(String[] args) throws Exception {
String apiKey = "YOUR_API_KEY";
URL url = new URL("https://api.wistx.ai/v1/knowledge/research");
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("POST");
conn.setRequestProperty("Authorization", "Bearer " + apiKey);
conn.setRequestProperty("Content-Type", "application/json");
conn.setDoOutput(true);
JsonObject payload = new JsonObject();
payload.addProperty("query", "What are the best practices for securing RDS databases?");
payload.addProperty("include_cross_domain", true);
payload.addProperty("include_global", true);
payload.addProperty("format", "structured");
payload.addProperty("max_results", 20);
Gson gson = new Gson();
String[] domains = {"compliance", "security"};
String[] contentTypes = {"guide", "best_practice"};
payload.add("domains", gson.toJsonTree(domains));
payload.add("content_types", gson.toJsonTree(contentTypes));
try (OutputStream os = conn.getOutputStream()) {
byte[] input = gson.toJson(payload).getBytes("utf-8");
os.write(input, 0, input.length);
}
BufferedReader br = new BufferedReader(new InputStreamReader(conn.getInputStream(), "utf-8"));
StringBuilder response = new StringBuilder();
String responseLine;
while ((responseLine = br.readLine()) != null) {
response.append(responseLine.trim());
}
System.out.println(response.toString());
}
}
Authorization
Request Body
Research query in natural language. Should be specific and detailed for best results.Minimum length: 10 characters
Maximum length: 10,000 characters
Maximum length: 10,000 characters
Filter results by knowledge domains.Options:
Maximum: 20 items
compliance- Compliance standards and requirementsfinops- Financial operations and cost optimizationdevops- DevOps practices and methodologiesinfrastructure- Infrastructure patterns and designssecurity- Security best practicesarchitecture- Architecture patterns and designscloud- Cloud-specific guidanceautomation- Automation strategiesplatform- Platform engineeringsre- Site Reliability Engineering
[] (all domains)Maximum: 20 items
Filter results by content type.Options:
Maximum: 20 items
guide- Step-by-step guidespattern- Design patternsstrategy- Strategic guidancechecklist- Checklists and proceduresreference- Reference documentationbest_practice- Best practices
[] (all content types)Maximum: 20 items
Include cross-domain relationships and impacts in results. Shows how compliance, cost, and security intersect.Default:
trueInclude global/shared knowledge base content. Set to
false to search only user’s indexed content.Default: trueResponse format for the research results.Options:
structured- Structured JSON format (default)markdown- Markdown format optimized for LLM consumptionexecutive_summary- High-level summary format
structuredResponse
{
"data": {
"results": [
{
"article_id": "kb_abc123",
"domain": "security",
"subdomain": "database_security",
"content_type": "best_practice",
"title": "RDS Database Security Best Practices",
"summary": "Comprehensive guide to securing RDS databases including encryption, access control, and monitoring...",
"content": "Full article content...",
"tags": ["rds", "encryption", "iam", "monitoring"],
"categories": ["database", "security"],
"industries": ["finance", "healthcare"],
"cloud_providers": ["aws"],
"services": ["rds", "kms", "cloudwatch"],
"cross_domain_impacts": {
"compliance": {
"standards": ["PCI-DSS", "HIPAA"],
"controls": ["PCI-DSS-3.4", "HIPAA-164.312"]
},
"cost": {
"impact": "Encryption adds minimal cost (~5% overhead)",
"optimization": "Use KMS customer-managed keys for better cost control"
}
},
"source_url": "https://docs.aws.amazon.com/rds/...",
"quality_score": 0.95
}
],
"research_summary": {
"total_found": 45,
"domains_covered": ["security", "compliance", "infrastructure"],
"key_insights": [
"Encryption at rest and in transit is critical for RDS security",
"IAM-based access control reduces attack surface",
"Continuous monitoring detects anomalies early"
]
},
"metadata": {
"query_time_ms": 456,
"filters_applied": {
"domains": ["compliance", "security"],
"content_types": ["guide", "best_practice"]
}
}
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0,
"query_time_ms": 456
}
}
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": "Query must be at least 10 characters"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"detail": "Invalid authorization header. Expected 'Bearer {api_key}'"
}
{
"detail": "Invalid or expired token"
}
{
"error": {
"code": "QUOTA_EXCEEDED",
"message": "Query quota exceeded",
"details": {
"limit_type": "queries_per_month",
"current": 50,
"limit": 50
}
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred",
"details": null
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "DATABASE_ERROR",
"message": "Database connection failed",
"details": "Connection timeout"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
Response Fields
Response data containing research results and summary.
Show Data properties
Show Data properties
List of knowledge articles matching the research query.
Show Article object properties
Show Article object properties
Examples
Research FinOps Best Practices
curl --request POST \
--url https://api.wistx.ai/v1/knowledge/research \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"query": "What are the best practices for optimizing cloud costs in AWS?",
"domains": ["finops"],
"content_types": ["best_practice", "guide"],
"max_results": 15
}'
response = requests.post(
"https://api.wistx.ai/v1/knowledge/research",
headers={"Authorization": f"Bearer {api_key}"},
json={
"query": "What are the best practices for optimizing cloud costs in AWS?",
"domains": ["finops"],
"content_types": ["best_practice", "guide"],
"max_results": 15
}
)
const response = await fetch("https://api.wistx.ai/v1/knowledge/research", {
method: "POST",
headers: {
"Authorization": `Bearer ${apiKey}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
query: "What are the best practices for optimizing cloud costs in AWS?",
domains: ["finops"],
content_types: ["best_practice", "guide"],
max_results: 15
})
});
Rate Limits
- Professional Plan: 2,000 queries/month
- Team Plan: 10,000 queries/month
- Enterprise Plan: Unlimited queries/month
Related Endpoints
- Compliance Requirements - Get compliance requirements
- Indexing - Index repositories and documentation