Request
- Base URL: https://api.useanima.sh/v1
- URL: https://api.useanima.sh/v1/provisioning-requests
- Auth: one of:
- HTTP bearer
- API key in header X-API-Key
Request body
Resource being requested: VAULT (encrypted secret storage for this agent) or PHONE_NUMBER (a provisioned number, Starter+ only).
Why the agent needs this, shown verbatim to the owner. Required — an unexplained ask is not a decidable one.
Response
OK
Unique provisioning request identifier
Agent the resource would belong to
Agent display name, so the owner knows who is asking
Resource being requested: VAULT (encrypted secret storage for this agent), PHONE_NUMBER (a provisioned number, Starter+ only), or GENERIC (a master-gated operation the agent tried to perform; approving grants permission rather than provisioning anything).
The agent's stated justification
Lifecycle status: PENDING (awaiting the owner), APPROVED (resource provisioned), DECLINED (owner refused — soft, the agent may ask again), EXPIRED (7-day TTL elapsed unanswered), CANCELLED (withdrawn by the agent).
When an unanswered request stops being actionable
When the owner decided; null while PENDING
The owner's note, typically the reason for a decline — surfaced so a second attempt can address the objection instead of repeating the first
Id of what approval created (vault identity or phone identity); null unless APPROVED
When the agent asked
Whether the owner was successfully emailed. False means the request is still live and visible in the console — the notification failed, not the request.
Changes
No recorded changes to this operation across all 1 revision of this API.