Get the effective runtime configuration (GET /api/v1/agent/config)

Only sk_live_ keys are accepted.

Authentication

Send one of these headers (either is accepted):

x-agentid-api-key: <API key>: AgentID API key of the AI system, for example x-agentid-api-key: sk_live_....
Authorization: Bearer <API key>: The same API key passed as Authorization: Bearer sk_live_....

Parameters

query parameters

system_idstring<uuid>: Optional check. If it does not match the API key's system, the endpoint returns 436.

Example request

curl -X GET "https://app.getagentid.com/api/v1/agent/config" \
  -H "x-agentid-api-key: $AGENTID_API_KEY"

const response = await fetch("https://app.getagentid.com/api/v1/agent/config", {
  method: "GET",
  headers: {
    "x-agentid-api-key": process.env.AGENTID_API_KEY!,
  },
});

if (!response.ok) throw new Error(`AgentID request failed: ${response.status}`);
const data = await response.json();

import os
import requests

response = requests.get(
    "https://app.getagentid.com/api/v1/agent/config",
    headers={"x-agentid-api-key": os.environ["AGENTID_API_KEY"]},
    timeout=10,
)
response.raise_for_status()
data = response.json()

Responses

200Effective runtime configuration.

›Response schemaAgentConfigResponse

system_idstring<uuid>required
sourcestringrequired: Value: remote
shadow_modebooleanrequired
strict_security_modebooleanrequired
failure_modestringrequired: Shadow Mode always resolves to fail_open.
One of: fail_open, fail_close
block_pii_leakagebooleanrequired
enable_sdk_pii_maskingbooleanrequired
allow_client_deanonymizationbooleanrequired
versioninteger | string | null
updated_atstring<date-time> | null<date-time>
policy_revisionstring: Changes whenever the effective configuration changes.
block_on_heuristicboolean
block_on_injectionboolean
block_on_jailbreakboolean
block_secret_leakageboolean
enable_sdk_secret_maskingboolean
block_code_executionboolean
block_toxicityboolean
block_db_accessboolean
inject_transparency_metadataboolean
transparency_metadata_enabledboolean
require_bidirectional_auditboolean
block_piiboolean: Legacy alias of block_pii_leakage.
block_codeboolean: Legacy alias of block_code_execution.
block_toxicboolean: Legacy alias of block_toxicity.
block_dbboolean: Legacy alias of block_db_access.

Additional properties are accepted.

{
  "system_id": "cf84f936-95bc-45a4-bf98-9a1a16bf29c9",
  "version": 3,
  "updated_at": "2026-10-01T11:49:55.662Z",
  "policy_revision": "p1:4f9a0c2e7b1d4a6f8e3c5b7d9a1f2e4c",
  "source": "remote",
  "shadow_mode": false,
  "strict_security_mode": true,
  "failure_mode": "fail_close",
  "block_on_heuristic": true,
  "block_on_injection": true,
  "block_on_jailbreak": true,
  "block_pii_leakage": false,
  "enable_sdk_pii_masking": true,
  "block_secret_leakage": false,
  "enable_sdk_secret_masking": true,
  "allow_client_deanonymization": true,
  "block_code_execution": false,
  "block_toxicity": true,
  "block_db_access": false,
  "inject_transparency_metadata": false,
  "transparency_metadata_enabled": false,
  "require_bidirectional_audit": false,
  "block_pii": false,
  "block_code": false,
  "block_toxic": true,
  "block_db": false
}

401Missing, invalid or revoked API key, or a `system_id` that does not match the key.

›Response schemaSimpleErrorResponse

errorstringrequired
reasonstring
detailsany: Validation details or a short diagnostic.

Additional properties are accepted.

{
  "error": "Unauthorized"
}

436The API key is valid, but the requested `system_id` does not match it or the system could not be found.

›Response schemaSimpleErrorResponse

errorstringrequired
reasonstring
detailsany: Validation details or a short diagnostic.

Additional properties are accepted.

{
  "error": "Config unreachable",
  "reason": "system_id_mismatch"
}

500Internal processing failure.

›Response schemaSimpleErrorResponse

errorstringrequired
reasonstring
detailsany: Validation details or a short diagnostic.

Additional properties are accepted.

{
  "error": "Internal server error"
}

503A dependency is temporarily unavailable. Retry with backoff.

›Response schemaSimpleErrorResponse

errorstringrequired
reasonstring
detailsany: Validation details or a short diagnostic.

Additional properties are accepted.

{
  "error": "Database dependency unavailable.",
  "reason": "system_failure_db_unavailable"
}