API Reference - WISTX Documentation

Welcome to the WISTX REST API documentation. The WISTX API provides programmatic access to compliance requirements, infrastructure pricing, knowledge research, and indexing capabilities.

Base URL

https://api.wistx.ai

Authentication

All API endpoints require authentication using Bearer tokens. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Keep your API key secure! Never commit it to version control or expose it in client-side code.

Getting Your API Key

Sign up at wistx.ai/api-key
Navigate to API Keys in your dashboard
Create a new API key or use an existing one
Copy the key and store it securely

You’ll get 3 free index jobs and 50 queries/month to start - no credit card required!

API Endpoints

Compliance & Security

Get Compliance Requirements

Get compliance requirements for infrastructure resources. Supports PCI-DSS, HIPAA, CIS, SOC2, NIST, ISO 27001, GDPR, FedRAMP, and more.

Knowledge & Research

Research Knowledge Base

Deep research tool for DevOps, infrastructure, compliance, FinOps, and platform engineering knowledge.

Search

Search Codebase

Search your indexed repositories, documentation, and documents using natural language queries.

Search Code Examples

Search infrastructure code examples from curated repositories. Supports 32+ code types (Terraform, Kubernetes, Docker, CI/CD, etc.) with filtering by cloud provider, services, quality score, and compliance standards.

Search Packages

Search DevOps/infrastructure packages across registries (PyPI, npm, Terraform, Crates.io, Go, Helm, Ansible, Maven, NuGet, RubyGems).

Regex Search

Search codebase using regex patterns with pre-built templates for security audits, compliance checks, and code analysis.

Web Search

Search the web for DevOps/infrastructure/compliance/FinOps/SRE information. Supports general web search and security-focused searches (CVEs, advisories).

Read Package File

Read specific file sections from package source code using SHA256 hash. Fetches packages on-demand from registries.

Indexing

Index Resources

Index GitHub repositories, documentation websites, and documents for user-specific search. Includes cost and compliance analysis.

Cost & FinOps

Calculate Infrastructure Cost

Calculate infrastructure costs for cloud resources. Get monthly/annual costs, cost breakdowns, and optimization suggestions for AWS, GCP, and Azure resources.

Cost Search

Search infrastructure pricing data using semantic search. Find costs for AWS, GCP, and Azure resources. Compare costs and get optimization opportunities.

Infrastructure Budget

Create, manage, and track infrastructure spending budgets. Monitor spending, set alerts, and track budget status.

Architecture & Infrastructure

Design Architecture

Design and initialize DevOps/infrastructure/SRE/platform engineering projects with intelligent context.

Infrastructure Management

Get infrastructure inventory and manage infrastructure lifecycle (create, update, upgrade, backup, restore, monitor, optimize).

Cloud Discovery

Discover existing cloud resources from AWS accounts and generate Terraform import context. Secure cross-account access with dependency resolution, import order, and infrastructure diagrams.

Troubleshooting

Troubleshoot Issue

Diagnose and fix infrastructure/code issues. Analyzes errors, logs, and code to identify root causes and provide fix recommendations.

Reports & Health

Reports

Generate documentation and reports in various formats (markdown, HTML, PDF, DOCX).

Alerts

Manage budget alerts and notification preferences.

Health

Check API health status.

Response Format

All API responses follow a consistent format:

{
  "data": {
    // Response data
  },
  "metadata": {
    "request_id": "req_abc123",
    "timestamp": 1704067200.0,
    "query_time_ms": 234
  }
}

Success Response

{
  "data": {
    // Response data
  },
  "metadata": {
    "request_id": "req_abc123",
    "timestamp": 1704067200.0
  }
}

Error Response

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": {
      "field": "resource_types",
      "reason": "At least one resource type is required"
    }
  },
  "metadata": {
    "request_id": "req_abc123",
    "timestamp": 1704067200.0
  }
}

Rate Limits

Rate limits vary by plan:

Plan	Queries/Month	Index Jobs/Month
Professional	2,000	5
Team	10,000	10
Enterprise	Unlimited	Unlimited

Rate limit information is included in response headers:

X-RateLimit-Limit: Maximum requests allowed
X-RateLimit-Remaining: Remaining requests
X-RateLimit-Reset: Unix timestamp when limit resets

HTTP Status Codes

Code	Description
`200`	Success
`201`	Created
`202`	Accepted (async operation started)
`400`	Bad Request - Invalid parameters
`401`	Unauthorized - Invalid or missing API key
`403`	Forbidden - Insufficient permissions
`404`	Not Found - Resource not found
`429`	Too Many Requests - Rate limit exceeded
`500`	Internal Server Error
`503`	Service Unavailable

Error Codes

Code	Description
`VALIDATION_ERROR`	Request validation failed
`UNAUTHORIZED`	Invalid or missing API key
`QUOTA_EXCEEDED`	Rate limit or quota exceeded
`RESOURCE_NOT_FOUND`	Requested resource not found
`INTERNAL_ERROR`	Internal server error
`SERVICE_UNAVAILABLE`	Service temporarily unavailable

Pagination

Some endpoints support pagination using query parameters:

page: Page number (default: 1)
per_page: Items per page (default: 20, max: 100)

Paginated responses include pagination metadata:

{
  "data": [...],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 150,
    "total_pages": 8
  }
}

SDKs

Official SDKs are available for popular languages:

Python: pip install wistx-sdk
JavaScript/TypeScript: npm install @wistx/sdk
Go: go get github.com/wistx/sdk-go

SDK Documentation

View SDK documentation and examples

OpenAPI Specification

The complete OpenAPI specification is available:

OpenAPI Spec

View the complete OpenAPI specification

Support

Need help? We’re here for you:

Documentation: docs.wistx.ai
Support: support.wistx.ai
Status: status.wistx.ai
Discord Community: discord.gg/ZVGK5Fv3wT - Join for real-time support and discussions
GitHub: github.com/WISTXHQ/wistx-model - Report issues and contribute

Quick Start

Get Your API Key

Make Your First Request

Try the compliance requirements endpoint:

curl --request POST \
  --url https://api.wistx.ai/v1/compliance/requirements \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "resource_types": ["RDS"],
    "standards": ["PCI-DSS"]
  }'

Explore the API

Check out the API endpoints for detailed documentation and examples.

​Base URL

​Authentication

​Getting Your API Key

​API Endpoints

​Compliance & Security

Get Compliance Requirements

​Knowledge & Research

Research Knowledge Base

​Search

Search Codebase

Search Code Examples

Search Packages

Regex Search

Web Search

Read Package File

​Indexing

Index Resources

​Cost & FinOps

Calculate Infrastructure Cost

Cost Search

​Infrastructure Budget

Infrastructure Budget

​Architecture & Infrastructure

Design Architecture

Infrastructure Management

Cloud Discovery

​Troubleshooting

Troubleshoot Issue

​Reports & Health

Reports

Alerts

Health

​Response Format

​Success Response

​Error Response

​Rate Limits

​HTTP Status Codes

​Error Codes

​Pagination

​SDKs

SDK Documentation

​OpenAPI Specification

OpenAPI Spec

​Support

​Quick Start

Base URL

Authentication

Getting Your API Key

API Endpoints

Compliance & Security

Knowledge & Research

Search

Indexing

Cost & FinOps

Infrastructure Budget

Architecture & Infrastructure

Troubleshooting

Reports & Health

Response Format

Success Response

Error Response

Rate Limits

HTTP Status Codes

Error Codes

Pagination

SDKs

OpenAPI Specification

Support

Quick Start