What it does
One spending agreement of this API key by its mandateId, with what is used and left in all and today (UTC). Free, <300 ms.
- Access class
read· Reads only; changes nothing and costs nothing.- Cost
- Free.
- Project
- Not tied to one project.
A key holds only the access classes its owner gave it, set in Account → API keys → the key's Access: a new key holds read and write, and spend needs a monthly credit cap. tools/list shows only the tools a key holds, and a call to any other is refused with INSUFFICIENT_SCOPE. A key made before access classes existed keeps what it could do then (read, write, spend and live) until its owner sets its access; produce is given, never inherited.
Price
Free. This tool never spends credits.
Arguments
mandateIdstring · required- The agreement's id, from list_mandates.
dryRunboolean · optional- true: answer what this call WOULD do — the route its engines would take under the project's policy, its price in every mode, whether it writes — and run nothing: nothing is written, nothing is charged.
Unknown arguments are refused by name rather than ignored, so a misspelling never runs quietly.
Answer
The fields this tool's answer declares. They arrive as structuredContent, and as the same JSON in the first text block for clients that read text.
mandateId- The agreement — send it as mandateId (with an idempotencyKey) on a paid tool.
status- active | expired | revoked.
projectIds- The projects it covers.
upTo- Credits it allows in all.
perJobMax- The most one run may cost under it.
perDayMax- The most it allows in one UTC day.
tiers- draft and/or final — the tiers it covers.
jurisdictions- The jurisdiction classes its engines must sit in (US, EU, UK, IL, CN), or null: the project's engine policy alone.
humanFor- What stays a person's own press however much is left: final (final-tier work), likeness, external_share, cap_raise, over_per_job.
signedAt- When a person signed it.
expiresAt- When it ends (at most 30 days after signing).
narrowedAt- When a person last narrowed it, if ever.
used- Credits spent or held under it.
remaining- upTo − used.
today- Credits spent or held under it today (UTC).
todayRemaining- perDayMax − today.
note- A sentence for the agent about what the answer means or what to do next.
Behaviour hints
The hints the tool declares to clients, so an agent can decide what needs a person's approval.
- Read-onlyYes
- DestructiveNo
- IdempotentYes
- Reaches outside PREVIZNo
Call it
The JSON-RPC message, then the same call over HTTPS. Placeholders are in capitals.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "get_mandate",
"arguments": {
"mandateId": "YOUR_MANDATE_ID"
}
}
}curl -s https://mcp.aimpreviz.com \
-H "Authorization: Bearer $PVZ_KEY" \
-H "Content-Type: application/json" \
-H "Accept: application/json, text/event-stream" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"get_mandate","arguments":{"mandateId":"YOUR_MANDATE_ID"}}}'From an agent client you never write this by hand: connect it once (Claude Code, Cursor, TypeScript or Python) and ask for what you want.
When it fails
What the door answers instead, and what to do next. A refusal never charges.
- A call from a web page on an origin that is not allowed
- HTTP 403, JSON-RPC error -32003, before the body or the key is read. Call the door from a server, a terminal or a desktop client.
- A body that is not one JSON-RPC 2.0 message, or a batch
- HTTP 400, JSON-RPC error -32700 (unparseable) or -32600 (invalid or a batch), before the key is read. Send one message per POST with "jsonrpc": "2.0", a method and a string or number id.
- No key, a malformed key or a revoked key
- HTTP 401 with a WWW-Authenticate challenge, before any method runs, the handshake included. Stop and ask your person for a key; retrying will not help.
- An MCP-Protocol-Version header naming a version this door does not speak
- HTTP 400, JSON-RPC error -32600, naming the versions it supports. A request with no such header is accepted. Send the protocolVersion that initialize returned, or leave the header off.
- An unknown method
- JSON-RPC error -32601, "Unknown method" with the method's name. Use initialize, ping, tools/list or tools/call.
- An unknown tool
- JSON-RPC error -32602, "Unknown tool", naming tools/list. Call tools/list for the tools this door offers.
- Arguments that do not match the tool's input schema
- Protocol 2025-06-18: JSON-RPC error -32602 with the issues. Protocol 2025-11-25: a tool answer with isError set, naming each issue. Fix the named arguments. Unknown arguments are named, never ignored; confirm sent as the text "true" is refused, never coerced.
- A tool whose access class the key does not hold
- A tool answer with isError set, beginning INSUFFICIENT_SCOPE, naming the class the tool needs and the classes the key holds. Nothing ran and nothing was charged. Ask the key's owner to add it in Account → API keys → the key's Access; spend needs the key's monthly cap first.
- A refusal only a person can lift: the person's credits ran out (INSUFFICIENT_CREDITS), a monthly cap is missing or reached, a key lacks an access class, a freeze, or a spending agreement that was revoked, expired or does not cover the call
- The refusal carries actionUrl and actionLabel: the exact PREVIZ page for the person to press on, behind their own sign-in. For an agreement to sign again, the page opens with the old agreement's numbers suggested. A run answered by a job handle (a queued job, a long render) carries the same two fields on its job: get_job, list_jobs and the job's event. Nothing ran and nothing was charged. Hand the person actionUrl as it is. After they act, send the same call again with the same quoteToken or idempotencyKey. Two cases take a new idempotencyKey instead: a key whose first call already ran under an earlier agreement, and a queued job that has ended.
- A spend sent with your own idempotencyKey by an API key that has neither a monthly credit cap nor a signed spending agreement covering the call
- A tool answer with isError set, beginning CAP_REQUIRED, with actionUrl (the key's cap) and agreementUrl (the signing page). It is answered before anything is written, so the idempotencyKey is not used up. Nothing ran and nothing was charged. Hand the person either page. Once they have set a cap or signed an agreement, send the same call again with the same idempotencyKey.
- A webhook endpoint whose URL is not https on port 443, carries a user name, or resolves to a private address; or a call for an endpoint this key did not subscribe
- A tool answer with isError set, beginning URL_REFUSED (subscribe_webhook; nothing was subscribed), WEBHOOK_NOT_FOUND, WEBHOOK_INVALID (an unknown event kind) or WEBHOOK_LIMIT (ten endpoints per key). Give a public https URL that answers 2xx itself (a redirect is never followed), name kinds or families from the subscribe_webhook reference, and read list_webhooks for this key's endpoints.
- A replay that cannot be made exactly: a job whose request is no longer kept, a tool that changed shape, a policy that now leaves it no engine, or stale work that changed since its quote
- A tool answer with isError set, beginning REPLAY_UNAVAILABLE and saying which. Nothing ran and nothing was charged; PREVIZ never runs it on a different engine or from a guess. For replay_stale, call it again for a new plan and quote. For replay_job, call the tool yourself with the arguments you want.
- A tool that a rule for agents says is never run: the organisation's rule, or the person's own
- A tool answer with isError set, beginning GOVERNANCE_DENIED, naming whose rule it is. The call is refused before its arguments are read: nothing was priced, run or charged. get_governance lists every rule that binds this credential. An owner or admin changes the organisation's rule in PREVIZ; a person changes their own in their account.
- resume_chain on a chain that cannot carry on: cancelled, ended, past its quote, or stopped on a step that was charged or has used its attempts
- A tool answer with isError set, beginning CHAIN_STATE (or CHAIN_NOT_FOUND for a chain this credential did not start). Nothing ran and nothing was charged. replay_job on the chain's jobId quotes the same chain afresh; get_job reads what the chain already made.