API 参考
网关调用
通过受治理的网关调用模型——以及围绕一次调用的操作:是否需要模型、首次调用可用的模型、恢复被暂挂的调用、申请例外、依据核查,以及您自有保险库的回执。
路由摘要和字段名称均以英文撰写,本页与文件中都是如此。
/api/v1/chat
POST /api/v1/chat/completions
The governed gateway, OpenAI-compatible
认证
API 密钥
密钥作用域
inference:write请求头
X-Azoth-Usecase · X-Azoth-Decision-Ref · X-Azoth-Subject-Zone · X-Azoth-End-User · X-Azoth-Challenge-Passed · X-Azoth-On-Behalf-Of · X-Azoth-Locale · X-Azoth-Alternative · X-Azoth-Refusal-Ref · Idempotency-Key请求体
model (必填) · messages (必填) · temperature · max_tokens · stream · azoth_use_cache · azoth_task · azoth_cache_policy · azoth_agent_id · azoth_workflow_id · azoth_compute_os · azoth_sources应答
200 · 202 human_review_required · 400 validation_failed, invalid_decision_ref, invalid_on_behalf_of, invalid_alternative, alternative_not_offered, alternative_mismatch, invalid_refusal_ref, human_identity_required, idempotency_key_invalid · 401 api_key_missing, api_key_invalid · 402 budget_exceeded, ai_ops_limit_exceeded, sealed_decisions_limit_reached, trial_exhausted · 403 api_key_scope_denied, policy_blocked, usecase_unresolved, usecase_not_approved, usecase_prohibited, usecase_archived, usecase_divergence, mandate_suspended, mandate_expired, kill_switch_active, jurisdiction_blocked, sovereignty_blocked, secnumcloud_blocked, egress_blocked, data_exfiltration_blocked, redaction_failed, human_review_not_resumable, on_behalf_of_not_allowed, ungrounded_answer · 409 idempotency_key_in_progress, idempotency_replay_unavailable · 422 provider_not_connected, provider_key_rejected, provider_permission_denied, provider_model_not_found, provider_payment_required, provider_request_too_large, provider_request_rejected, provider_not_supported, onboarding_no_provider, trial_unavailable, trial_limits_exceeded, idempotency_key_reused · 428 exhaustion_challenge_required · 429 exhaustion_slow, exhaustion_blocked, tenant_concurrency_limit, loop_detected · 500 internal_error · 502 provider_failure, provider_rate_limited · 503 governance_error, kill_switch_unavailable, budget_unavailable, identity_unavailable, service_unavailablePOST /api/v1/chat
The governed gateway with an explicit provider, fallbacks and streaming
认证
API 密钥
密钥作用域
inference:write请求头
X-Azoth-Usecase · X-Azoth-Decision-Ref · X-Azoth-Subject-Zone · X-Azoth-End-User · X-Azoth-Challenge-Passed · X-Azoth-On-Behalf-Of · X-Azoth-Locale · X-Azoth-Alternative · X-Azoth-Refusal-Ref · Idempotency-Key请求体
provider (必填) · model (必填) · messages (必填) · temperature · maxTokens · stream · useCache · task · cachePolicy · agentId · workflowId · fallbackProviders · azureEndpoint · azureDeployment · ollamaBaseUrl · onApprovalRequired · azoth_sources应答
200 · 202 human_review_required · 400 validation_failed, invalid_decision_ref, invalid_on_behalf_of, invalid_alternative, alternative_not_offered, alternative_mismatch, invalid_refusal_ref, human_identity_required, idempotency_key_invalid · 401 api_key_missing, api_key_invalid · 402 budget_exceeded, ai_ops_limit_exceeded, sealed_decisions_limit_reached · 403 api_key_scope_denied, policy_blocked, usecase_unresolved, usecase_not_approved, usecase_prohibited, usecase_archived, usecase_divergence, mandate_suspended, mandate_expired, kill_switch_active, jurisdiction_blocked, sovereignty_blocked, secnumcloud_blocked, egress_blocked, ollama_endpoint_missing, ollama_endpoint_not_declared, data_exfiltration_blocked, redaction_failed, human_review_not_resumable, on_behalf_of_not_allowed, ungrounded_answer · 409 idempotency_key_in_progress, idempotency_replay_unavailable · 422 endpoint_url_not_allowed, azure_endpoint_not_allowed, azure_config_required, invalid_azure_deployment, provider_not_connected, provider_key_rejected, provider_permission_denied, provider_model_not_found, provider_payment_required, provider_request_too_large, provider_request_rejected, idempotency_key_reused · 428 exhaustion_challenge_required · 429 exhaustion_slow, exhaustion_blocked, tenant_concurrency_limit, loop_detected · 500 internal_error · 502 provider_failure, provider_rate_limited · 503 governance_error, kill_switch_unavailable, budget_unavailable, identity_unavailable, service_unavailable/api/v1/infer
POST /api/v1/infer/resume
Run a held call once a reviewer approved it
认证
API 密钥
密钥作用域
inference:write参数
approval_request_id请求体
approval_request_id (必填)应答
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 402 budget_exceeded, ai_ops_limit_exceeded, sealed_decisions_limit_reached · 403 api_key_scope_denied, not_requester, rejected, policy_blocked, usecase_not_approved, usecase_prohibited, usecase_archived, mandate_suspended, mandate_expired, kill_switch_active, jurisdiction_blocked, sovereignty_blocked, egress_blocked · 404 not_found · 409 pending, already_executed · 410 approval_expired · 422 provider_not_supported, provider_not_connected, provider_key_rejected, provider_permission_denied, provider_model_not_found, provider_payment_required, provider_request_too_large, provider_request_rejected · 429 · 500 internal_error · 502 provider_failure, provider_rate_limited · 503 governance_error, kill_switch_unavailable, provider_key_storage_unavailable, service_unavailablePOST /api/v1/infer/preflight
Score whether a request needs a model call at all
认证
API 密钥
密钥作用域
advisory:read模块
在部署运行
FEATURE_IAE 时提供。请求体
connectorId · request应答
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 413 validation_failed · 429 · 500 internal_error · 501 feature_disabled/api/v1/models
GET /api/v1/models/defaults
Which model a first call can use, per provider
认证
API 密钥
密钥作用域
advisory:read应答
200 · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error/api/v1/exceptions
POST /api/v1/exceptions
Ask the rule's owner for a time-limited exception to a refusal
认证
API 密钥
密钥作用域
inference:write模块
在部署运行
FEATURE_HELPFUL_REFUSALS 时提供。请求体
refusal_ref (必填) · justification (必填) · duration_days · requester_label应答
200 · 201 · 400 validation_failed, invalid_refusal_ref, not_exceptionable, no_identity, duration_exceeds_ceiling, incident_containment · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 404 rule_not_found · 409 capability_off · 429 · 500 internal_error · 501 feature_disabled · 503 service_unavailableGET /api/v1/exceptions/{id}
Where an exception this key asked for stands
认证
API 密钥
密钥作用域
inference:write模块
在部署运行
FEATURE_HELPFUL_REFUSALS 时提供。参数
id (必填)应答
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 404 not_found · 500 internal_error · 501 feature_disabled · 503 service_unavailable/api/v1/grounding
POST /api/v1/grounding/release
Fetch a high-stakes answer the grounding check held, once approved
认证
API 密钥
密钥作用域
inference:write模块
在部署运行
FEATURE_GROUNDING_CHECK 时提供。请求体
approval_request_id (必填)应答
200 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 rejected, api_key_scope_denied · 404 not_found · 409 pending, already_released · 410 approval_expired · 429 · 500 internal_error · 501 feature_disabled · 503 service_unavailablePOST /api/v1/grounding/receipts
Seal the receipt of a grounding check run on your side
认证
API 密钥
密钥作用域
inference:write模块
在部署运行
FEATURE_GROUNDING_CHECK 时提供。请求体
traceId (必填) · claims (必填) · supported (必填) · judgeVersion (必填) · claimsVersion (必填) · sourcesHash (必填) · sourceCount (必填) · latencyMs · usecaseId应答
202 · 400 validation_failed · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed, plan_required · 404 usecase_not_found · 409 capability_off · 429 · 500 internal_error · 501 feature_disabled · 503 service_unavailable/api/v1/vault
POST /api/v1/vault/receipts
Seal the receipt of a call kept in your own vault
认证
API 密钥
密钥作用域
inference:write模块
在部署运行
FEATURE_CLIENT_VAULT 时提供。请求头
X-Azoth-Decision-Ref请求体
traceId (必填) · plaintextHash (必填) · ciphertextHash (必填) · keyId应答
202 · 400 validation_failed, invalid_decision_ref · 401 api_key_missing, api_key_invalid · 403 api_key_scope_denied, api_key_role_denied, ip_not_allowed · 429 · 500 internal_error · 501 feature_disabled