Skip to main content

SDK Overview

Silent Witness provides official SDKs in multiple languages to make integrating with our API simple and efficient.

Available SDKs​

We provide official SDKs in Go and TypeScript for high-performance, type-safe integration with the Silent Witness API.

Why Use Our SDKs?​

Our official SDKs provide the best developer experience for integrating with the Silent Witness API:

Performance​

  • Fast & Reliable: Optimized for high-performance applications
  • Low Latency: Efficient data transfer with minimal overhead
  • Scalable: Built to handle high-volume API requests

Type Safety​

  • Strong Typing: Compile-time type checking and validation
  • Auto-completion: Full IDE support with intelligent suggestions
  • Schema Validation: Automatic request/response validation

Developer Experience​

  • Native Integration: Feels natural in your programming language
  • Comprehensive Documentation: Built-in docs and examples
  • Error Handling: Structured, predictable error responses

Getting Started​

  1. Get Your API Key - Contact support to obtain your API key
  2. Install the SDK - Install the Go or TypeScript SDK using your package manager
  3. Follow the Quickstart - See the quickstart guide to make your first API call
  4. Explore the API Reference - Browse the complete API reference for all available endpoints

API Key Authentication​

All SDK requests require authentication using your API key:

# Add to request metadata/headers
x-api-key: your-api-key-here
info

Keep your API keys secure and never commit them to version control.

Rate Limiting​

All API requests are subject to rate limiting:

  • Default Limit: 1,000 requests per hour per API key
  • Rate Limit Headers: SDKs automatically handle rate limit headers
  • Backoff Strategy: Implement exponential backoff for rate limit errors

Error Handling​

The API uses standard error codes for consistent error reporting:

Error TypeDescription
SuccessRequest completed successfully
Authentication ErrorInvalid or missing API key
Rate Limit ErrorToo many requests, retry after delay
Validation ErrorInvalid request parameters
Server ErrorInternal server error

Each SDK provides idiomatic error handling patterns for your programming language.

Next Steps​

  • Quick Start - Get started with your first API call
  • API Reference - Explore the complete API documentation
  • Support - Contact support for help and feature requests