Skip to main content

API Reference

Deductive AI provides a comprehensive REST API for programmatic access to all platform features.

Authentication

API Keys

All API requests require authentication using an API key:

Getting Your API Key

  1. Sign in to Deductive AI
  2. Navigate to Settings > API Keys
  3. Click Create API Key
  4. Copy and store your API key securely
Note: API keys are only shown once. Store them securely.

Key Types

  • Admin Keys - Full access to all resources
  • Assistant Keys - Limited access for assistant API only

Base URL

All API requests should be made to:

Rate Limits

  • Standard: 100 requests per minute
  • Enterprise: 1000 requests per minute
Rate limit headers are included in all responses:

Endpoints

Query

Submit a natural language query to Deductive AI. Endpoint: POST /query Request Body:
Response:

Integrations

List Integrations

Endpoint: GET /integrations Response:

Create Integration

Endpoint: POST /integrations Request Body:

Incidents

List Incidents

Endpoint: GET /incidents Query Parameters:
  • status - Filter by status (open, resolved, investigating)
  • severity - Filter by severity (low, medium, high, critical)
  • start_time - Filter incidents after this time
  • end_time - Filter incidents before this time

Get Incident

Endpoint: GET /incidents/{id} Response:

Error Handling

All errors follow a consistent format:

Error Codes

  • INVALID_REQUEST - Request validation failed
  • UNAUTHORIZED - Authentication required
  • FORBIDDEN - Insufficient permissions
  • NOT_FOUND - Resource not found
  • RATE_LIMIT_EXCEEDED - Too many requests
  • INTERNAL_ERROR - Server error

SDKs

Python

JavaScript

Webhooks

Subscribe to events for real-time updates: Endpoint: POST /webhooks Request Body:

Next Steps