POST
/api/agent-network/settingsBootstrap Agent Network settings
Creates the per-account Agent Network settings row and allocates the account's endpoint. Exactly one of proxy_address (labeled endpoint under that cluster; the server allocates the label) and endpoint (self-addressed dedicated endpoint, claimed verbatim) must be provided. The endpoint and proxy address are immutable once assigned. Returns 409 when the account already has a settings row.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
Settings bootstrap request
access_log_retention_daysintegeroptional
Days to retain full access-log rows; older rows are swept. 0 or less means keep indefinitely. Defaults to 30.
enable_log_collectionbooleanoptional
Whether per-request access-log entries are collected for this account's agent-network traffic. Defaults to true.
enable_prompt_collectionbooleanoptional
Master switch for request/response prompt capture. Defaults to false.
endpointstringoptional
Hostname to claim as the account's self-addressed (dedicated) endpoint. Mutually exclusive with `proxy_address`. Rejected when another account already holds it.
proxy_addressstringoptional
Cluster address to allocate a labeled endpoint beneath. Mutually exclusive with `endpoint`.
redact_piibooleanoptional
Whether captured prompts have PII redacted. Defaults to false.
200The freshly bootstrapped Agent Network settings
access_log_retention_daysintegeroptional
Days to retain full access-log rows; older rows are swept. 0 or less means keep indefinitely. Usage records are retained independently.
created_atstringoptional
Timestamp when the settings row was created. Absent until the account is bootstrapped.
dedicatedbooleanrequired
Whether the account's gateway is served by a proxy dedicated to it (endpoint equals proxy_address).
enable_log_collectionbooleanrequired
Whether per-request access-log entries are collected for this account's agent-network traffic.
enable_prompt_collectionbooleanrequired
Master switch for request/response prompt capture. Capture runs only when this is on AND a policy guardrail also enables it.
endpointstringrequired
Bare hostname agents call for this account. Empty until the account is bootstrapped.
proxy_addressstringrequired
Declared cluster address of the proxy serving this account's gateway. Equal to `endpoint` when a dedicated proxy serves the account; otherwise the endpoint's immediate parent (a shared cluster the endpoint hangs one label beneath). Empty until the account is bootstrapped.
redact_piibooleanrequired
Whether captured prompts have PII redacted. Effective redaction is the OR of this and any policy guardrail's redact setting.
updated_atstringoptional
Timestamp when the settings row was last updated. Absent until the account is bootstrapped.
400Bad Request
401Requires authentication
403Forbidden
409Conflict
messagestringoptional
A human-readable error message.
422Validation failed
500Internal Server Error
Error handling
A 400 is returned: Bad Request. A 401 is returned: Requires authentication. A 403 is returned: Forbidden. A 409 is returned: Conflict. A 422 is returned: Validation failed. A 500 is returned: Internal Server Error.