API Documentation

Welcome to the SignalDeck Artificial Judgement API. Our RESTful API lets you integrate deterministic, auditable decision pipelines into your regulated workflows.

Authentication

SignalDeck AI uses API keys to authenticate requests. Include your API key in the Authorization header using Bearer token format.

curl -X GET "https://api.signaldeck.ai/v1/health" \
  -H "Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json"

Getting Your API Key

1. Log in to your Dashboard
2. Navigate to API Keys
3. Click "Create New Key" and copy your key

Rate Limits

API rate limits depend on your subscription plan. Rate limit headers are included in every response.

Plan Limits

Error Handling

SignalDeck AI uses standard HTTP status codes and returns JSON error responses.

{
  "status": "error",
  "code": "VALIDATION_ERROR",
  "message": "The request payload is invalid",
  "errors": {
    "pipeline_id": ["Pipeline ID is required"],
    "input_data": ["Input data must be an object"]
  },
  "request_id": "req_abc123xyz"
}

POST Decision

Run a decision through any SignalDeck AI pipeline. This is the main endpoint for all AI-powered predictions.

URL Parameters

Request Body

{
  "input_data": {
    "transaction_amount": 5000,
    "merchant_category": "electronics",
    "is_international": true,
    "customer_age_days": 30
  }
}

Response

{
  "status": "success",
  "data": {
    "pipeline_id": "fraud_probe",
    "pillar": "bank",
    "decision": "B_INVESTIGATE",
    "confidence": 0.87,
    "probabilities": {
      "A_FAST_TRACK": 0.08,
      "B_INVESTIGATE": 0.87,
      "C_BLOCK": 0.05
    },
    "explanation": {
      "top_factors": [
        {"feature": "is_international", "impact": 0.35},
        {"feature": "transaction_amount", "impact": 0.28}
      ]
    },
    "processing_time_ms": 125
  },
  "request_id": "req_xyz789abc"
}

GET List Decisions

Retrieve your past decisions with optional filtering and pagination.

Query Parameters

{
  "status": "success",
  "data": {
    "decisions": [
      {
        "id": 12345,
        "pipeline_id": "fraud_probe",
        "pillar": "bank",
        "decision": "B_INVESTIGATE",
        "confidence": 0.87,
        "created_at": "2026-01-24T10:30:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "per_page": 20,
      "total": 156
    }
  }
}

GET Health Check

Check the API status and availability.

{
  "status": "healthy",
  "version": "2.0.0",
  "timestamp": "2026-01-24T10:30:00Z"
}

POST Feedback

Submit feedback on decisions to help improve model accuracy through online learning.

{
  "decision_id": 12345,
  "actual_outcome": "FRAUD",
  "feedback_type": "correction",
  "notes": "Transaction was confirmed as fraudulent"
}

Available Pillars

SignalDeck AI offers 6 industry-specific pillars with 78 specialized pipelines.

Changelog