API referenceAdmin APISecurity & dataInference hookGet the hook

Get the inference hook

⚠️
Preview — this feature is being built; the design below is the spec.
GET https://app.syntic.ai/v1/organizations/inference_hook

Return the hook’s configuration and the last 24 hours of verdict counts.

For how this fits into a full workflow, see Inference hooks.

Headers

HeaderRequiredValue
AuthorizationYesBearer <admin key>: an Admin API key (sk_admin_...). Inference keys are refused with 403 admin_key_required. See Admin API keys.
syntic-betaYes, while in previewadmin-2026-11-01. Without it the call fails with 400 beta_required. See Versioning.

Response

200 OK, Content-Type: application/json

{
  "type": "inference_hook",
  "url": "https://ai-gateway.example.com/syntic-hook",
  "timeout_ms": 1500,
  "failure_mode": "closed",
  "stages": [
    "request"
  ],
  "status": "enabled",
  "secret_hint": "…7c2e",
  "updated_at": "2026-11-01T10:00:00Z",
  "stats_24h": {
    "calls": 120440,
    "allowed": 120102,
    "denied": 311,
    "timeouts": 27,
    "p95_ms": 210
  }
}
FieldTypeDescription
failure_modestringclosed blocks the request when the hook times out or errors; open lets it through and logs it.
stats_24hobjectCalls, verdicts, timeouts and 95th-percentile hook latency.

Examples

curl -sS "https://app.syntic.ai/v1/organizations/inference_hook" \
  -H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
  -H "syntic-beta: admin-2026-11-01"

Errors

Errors use the error envelope and carry a request_id. Codes specific to this operation:

StatustypecodeWhen
400invalid_request_errorbeta_requiredThe syntic-beta header is missing.
404not_found_errorinference_hook_not_setNo hook is configured.
401authentication_errorinvalid_api_keyThe admin key is missing, unknown, revoked or expired.
403permission_erroradmin_key_requiredAn inference key was used.
429rate_limit_errorrate_limitedToo many requests; wait for Retry-After. See Rate-limit headers.
Was this page helpful?