Register a credential reference in a vault
Registers one credential in a vault and returns the stored reference. Supply exactly one of secretValue (encrypted under the organization’s key and stored as ciphertext) or secretRef (material you already stored yourself) for secret-backed kinds. Integration grants carry neither; they reference a connected account that mints short-lived credentials. Secret material is never echoed back on this or any later response. An optional Idempotency-Key makes a retry after an ambiguous transport failure replay the first response instead of registering a second credential.
Authorizations
Headers
Replay-protection key in an organization-wide namespace shared by keyed mutations. It must contain 1 to 256 visible ASCII characters and be sent as exactly one header value. Request identity is the exact HTTP method, escaped path, raw query, and raw body bytes. The same request replays the original successful response; any different request returns 409 idempotency_conflict, and an active matching request returns 409 idempotency_in_progress. Completed receipts are retained for approximately 24 hours, pending claims may be reclaimed after approximately 1 hour, and no deduplication is guaranteed after expiry.
1 - 256^[!-~]+$Path Parameters
Body
- Option 1
- Option 2
env_var only. A service from the platform catalog: the agent calls the service with this credential but never sees the value. Omitted, the value is in the sandbox environment, readable by the agent. Any other value is refused. Requires secretValue. Fixed at create.
anthropic, github_packages_npm, openai, slack, stripe Response
Created
IMAP credentials only: exactly one immutable lowercase mail-server hostname, without a wildcard, scheme, port, or path. Required on create and enforced before authentication.
1 element^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)*$