Skip to main content
Configure a customer-owned Anthropic API key. When BYOM is active, every model call (scoring, DAC chat, agents, recommendations) routes through the customer’s key and bypasses Dacard credit metering. Available on Business and Enterprise.

​
Read current status

curl -X GET https://app.dacard.ai/api/settings/byom \
  -H "Authorization: Bearer $DACARD_API_KEY"
Response: 
{
  "config": {
    "enabled": true,
    "provider": "anthropic",
    "lastValidatedAt": "2026-05-01T12:00:00Z",
    "keyPrefix": "sk-ant-..."
  },
  "planAllows": true
}
If no key is configured, config is null.

​
Save or replace the key

curl -X PUT https://app.dacard.ai/api/settings/byom \
  -H "Authorization: Bearer $DACARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "apiKey": "sk-ant-..." }'
The route validates the key against Anthropic before storing. The full key is encrypted at rest; only the prefix is returned in subsequent reads.
PropertyValue
AuthRequired
Required permissionaccount:manage_integrations
Required planBusiness or Enterprise
IdempotentPUT yes (replaces).

​
Body (PUT)

FieldTypeRequiredNotes
apiKeystringyesAnthropic API key, validated by a synthetic call to the model.

​
Errors

StatusCodeWhen
400Account requiredCaller has no account.
400Invalid Anthropic API keyValidation against Anthropic failed.
401AUTH_REQUIREDNo session.
403FEATURE_GATEDCaller is on Free or Pro.
500INTERNAL_ERROREncryption or DB write failed.
Audit log entries: byom_enabled, byom_disabled, byom_key_replaced.

​
Disabling BYOM

PATCH with { "enabled": false } keeps the key but pauses BYOM routing. DELETE removes the key entirely.