post/vault/credential-requests

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/vault/credential-requests
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

type'login' | 'secure_note' | 'card' | 'identity' | 'oauth_token' | 'api_key' | 'certificate' required

Type of credential the human is asked to provide

namestring required

Display name for the credential to be created

reasonstring required

Human-readable explanation of why the credential is needed, shown to the owner

ttlSecondsinteger

Request TTL in seconds (60-3600, default 900 = 15 minutes)

notifyOwnerboolean

The MCP layer sets this true ONLY on the no-elicitation fallback path; the api emails the fillUrl to the org owner iff true.

Response

OK

requestIdstring required

Unique credential request identifier

fillUrlstring required

Token-gated URL where the human submits the secret (fallback / URL-mode path)

status'PENDING' | 'FULFILLED' | 'EXPIRED' | 'DECLINED' | 'CANCELLED' required

Current request status

expiresAtstring date-time required

When the request expires and the fill URL stops working

emailSentboolean required

Whether the fill URL was emailed to the agent owner (false if no humanEmail is set)

credentialIdstring nullable

Resolved vault credential ID when the inline path fulfills synchronously; null otherwise

Changes

No recorded changes to this operation across all 1 revision of this API.