# List approvals Lists the caller's approvals, newest first. Defaults to `pending`; pass `status` to include decided or expired ones instead, or `all` for every status. `GET /v1/users/{userId}/approvals` ## Authentication Both headers are required. - Header: `X-Api-Key: YOUR_API_KEY` - Header: `Authorization: Bearer YOUR_USER_TOKEN` ## Path parameters ```json [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "userId", "required": true, "description": "The user in the path; must equal the token's own account." } ] ``` ## Query parameters ```json [ { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "cursor", "required": false, "description": "Where the previous page ended; omit for the first page" }, { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false, "description": "How many rows to answer, at most 100" }, { "schema": { "default": "pending", "type": "string", "enum": [ "pending", "approved", "denied", "expired", "all" ] }, "in": "query", "name": "status", "required": false, "description": "Which approvals to include: `pending` (the default, since it is the only status a caller can act on), `approved`, `denied`, `expired`, or `all`." } ] ``` ## Request example Illustrative request. Replace the host, credentials and resource IDs with your own. If a request file is shown, create it from the schema above. Review the requested action before sending it. ```sh curl --request GET 'https://api.example.test/v1/users/YOUR_USER_ID/approvals' \ --header 'X-Api-Key: YOUR_API_KEY' \ --header 'Authorization: Bearer YOUR_USER_TOKEN' ``` ## Responses ### 200 A page of the caller's approvals. ```json { "description": "A page of the caller's approvals.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Approval" }, "description": "This page's rows." }, "nextCursor": { "description": "The cursor for the next page; null once there are no more rows.", "type": [ "string", "null" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "How many rows the list holds in all." } }, "required": [ "data", "nextCursor", "total" ] } } } } ``` ### 400 The request could not be read as this operation expects. - `invalid_input` — the body or query failed validation; `issues` names each field - `invalid_cursor` — the `cursor` is not one this list minted ```json { "description": "The request could not be read as this operation expects.\n\n- `invalid_input` — the body or query failed validation; `issues` names each field\n- `invalid_cursor` — the `cursor` is not one this list minted", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } ``` ### 401 A credential is missing, invalid or expired. - `partner_key_required` — no `X-Api-Key` header was sent - `partner_key_invalid` — the `X-Api-Key` is unknown or revoked - `credential_expired` — the user token has expired; obtain a fresh one ```json { "description": "A credential is missing, invalid or expired.\n\n- `partner_key_required` — no `X-Api-Key` header was sent\n- `partner_key_invalid` — the `X-Api-Key` is unknown or revoked\n- `credential_expired` — the user token has expired; obtain a fresh one", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } ``` ### 403 The credentials are valid but may not do this. - `subject_mismatch` — the `{userId}` in the path is not the token's user - `account_disabled` — an operator disabled the account - `origin_rejected` — a browser `Origin` other than the configured web origin ```json { "description": "The credentials are valid but may not do this.\n\n- `subject_mismatch` — the `{userId}` in the path is not the token's user\n- `account_disabled` — an operator disabled the account\n- `origin_rejected` — a browser `Origin` other than the configured web origin", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } ``` ### 404 The resource is missing, belongs to someone else, or its id is malformed: all three answer alike. ```json { "description": "The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } ``` ### 412 The identity is verified but has no account yet. - `account_not_provisioned` — the identity is verified but has no account yet; call `users.ensure` first ```json { "description": "The identity is verified but has no account yet.\n\n- `account_not_provisioned` — the identity is verified but has no account yet; call `users.ensure` first", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } ``` ### 429 A limiter refused the request; honour `Retry-After`. - `rate_limited` — the per-key or per-user limit is spent; honour `Retry-After` ```json { "description": "A limiter refused the request; honour `Retry-After`.\n\n- `rate_limited` — the per-key or per-user limit is spent; honour `Retry-After`", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } ``` ### 500 A fault on our side; quote `requestId` when reporting it. - `internal` — a fault on our side; quote `requestId` when reporting it ```json { "description": "A fault on our side; quote `requestId` when reporting it.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } ``` ### 503 The replica is draining or a dependency did not answer; `retryable` says whether to try again. - `internal` — a fault on our side; quote `requestId` when reporting it ```json { "description": "The replica is draining or a dependency did not answer; `retryable` says whether to try again.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } ``` ## Complete OpenAPI definition The exact operation and all referenced components, including recursive schemas. ```json { "operation": { "operationId": "approvals.list", "summary": "List approvals", "tags": [ "approvals" ], "description": "Lists the caller's approvals, newest first. Defaults to `pending`; pass `status` to include decided or expired ones instead, or `all` for every status.", "parameters": [ { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "cursor", "required": false, "description": "Where the previous page ended; omit for the first page" }, { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false, "description": "How many rows to answer, at most 100" }, { "schema": { "default": "pending", "type": "string", "enum": [ "pending", "approved", "denied", "expired", "all" ] }, "in": "query", "name": "status", "required": false, "description": "Which approvals to include: `pending` (the default, since it is the only status a caller can act on), `approved`, `denied`, `expired`, or `all`." }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "userId", "required": true, "description": "The user in the path; must equal the token's own account." } ], "security": [ { "apiKey": [], "userToken": [] } ], "responses": { "200": { "description": "A page of the caller's approvals.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Approval" }, "description": "This page's rows." }, "nextCursor": { "description": "The cursor for the next page; null once there are no more rows.", "type": [ "string", "null" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "description": "How many rows the list holds in all." } }, "required": [ "data", "nextCursor", "total" ] } } } }, "400": { "$ref": "#/components/responses/InvalidInput" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "412": { "$ref": "#/components/responses/AccountNotProvisioned" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "500": { "$ref": "#/components/responses/Internal" }, "503": { "$ref": "#/components/responses/Unavailable" } } }, "components": { "schemas": { "Approval": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The approval's id." }, "tool": { "type": "string", "description": "The name of the tool call parked for a decision." }, "fingerprint": { "type": "string", "description": "Fingerprint binding this decision to the exact reviewed action." }, "input": { "description": "The exact public tool input retained for review.", "$ref": "#/components/schemas/JsonValue" }, "contract": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "near_intents_transfer", "description": "Which contract template this is." }, "actions": { "minItems": 1, "maxItems": 16, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "swap", "description": "Exchange one asset for another; custody never leaves the agent wallet." }, "input": { "anyOf": [ { "type": "object", "properties": { "pinned": { "type": "object", "properties": { "tokenId": { "type": "string", "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$", "description": "The token's NEP-141 identifier." }, "decimals": { "type": "integer", "minimum": 0, "maximum": 38, "description": "How many decimal places the token's smallest unit represents." } }, "required": [ "tokenId", "decimals" ], "description": "The exact token this asset is pinned to." } }, "required": [ "pinned" ] }, { "type": "object", "properties": { "any": { "type": "boolean", "const": true, "description": "Any token the agent wallet holds; the executor picks one at execution." } }, "required": [ "any" ] } ], "description": "The asset this action spends: pinned to one token, or any token the agent wallet holds." }, "quantity": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_input_tokens", "description": "Spend an exact amount of the input token." }, "amountRaw": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})$", "description": "The exact input amount, in the input token's smallest unit." } }, "required": [ "kind", "amountRaw" ], "description": "Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw \"5000000\". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_input_value_usd", "description": "Spend a USD-denominated value of the input token." }, "value": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$", "description": "The USD value to spend, as a decimal string." } }, "required": [ "kind", "value" ], "description": "Spend a USD-denominated value of the input token: \"$5 worth of USDC\" means value \"5\". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_output_tokens", "description": "Receive an exact amount of the output token." }, "amountRaw": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})$", "description": "The exact output amount, in the output token's smallest unit." } }, "required": [ "kind", "amountRaw" ], "description": "Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "all_of_input", "description": "Spend everything the agent wallet holds of the input asset." } }, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "fraction_of_input", "description": "Spend a fraction of the input asset." }, "bps": { "type": "string", "pattern": "^(0|[1-9]\\d{0,4})$", "description": "The fraction to spend, in basis points of the input asset." } }, "required": [ "kind", "bps" ] } ], "description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it." }, "output": { "anyOf": [ { "type": "object", "properties": { "pinned": { "type": "object", "properties": { "tokenId": { "type": "string", "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$", "description": "The token's NEP-141 identifier." }, "decimals": { "type": "integer", "minimum": 0, "maximum": 38, "description": "How many decimal places the token's smallest unit represents." } }, "required": [ "tokenId", "decimals" ], "description": "The exact token this asset is pinned to." } }, "required": [ "pinned" ] }, { "type": "object", "properties": { "any": { "type": "boolean", "const": true, "description": "Any token the agent wallet holds; the executor picks one at execution." } }, "required": [ "any" ] } ], "description": "The asset this action produces: pinned to one token, or left open." } }, "required": [ "kind", "input", "quantity", "output" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "withdraw_to_owner", "description": "Return an asset to the account that owns the agent wallet." }, "input": { "anyOf": [ { "type": "object", "properties": { "pinned": { "type": "object", "properties": { "tokenId": { "type": "string", "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$", "description": "The token's NEP-141 identifier." }, "decimals": { "type": "integer", "minimum": 0, "maximum": 38, "description": "How many decimal places the token's smallest unit represents." } }, "required": [ "tokenId", "decimals" ], "description": "The exact token this asset is pinned to." } }, "required": [ "pinned" ] }, { "type": "object", "properties": { "any": { "type": "boolean", "const": true, "description": "Any token the agent wallet holds; the executor picks one at execution." } }, "required": [ "any" ] } ], "description": "The asset this action spends: pinned to one token, or any token the agent wallet holds." }, "quantity": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_input_tokens", "description": "Spend an exact amount of the input token." }, "amountRaw": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})$", "description": "The exact input amount, in the input token's smallest unit." } }, "required": [ "kind", "amountRaw" ], "description": "Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw \"5000000\". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_input_value_usd", "description": "Spend a USD-denominated value of the input token." }, "value": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$", "description": "The USD value to spend, as a decimal string." } }, "required": [ "kind", "value" ], "description": "Spend a USD-denominated value of the input token: \"$5 worth of USDC\" means value \"5\". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_output_tokens", "description": "Receive an exact amount of the output token." }, "amountRaw": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})$", "description": "The exact output amount, in the output token's smallest unit." } }, "required": [ "kind", "amountRaw" ], "description": "Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "all_of_input", "description": "Spend everything the agent wallet holds of the input asset." } }, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "fraction_of_input", "description": "Spend a fraction of the input asset." }, "bps": { "type": "string", "pattern": "^(0|[1-9]\\d{0,4})$", "description": "The fraction to spend, in basis points of the input asset." } }, "required": [ "kind", "bps" ] } ], "description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it." }, "output": { "anyOf": [ { "type": "object", "properties": { "pinned": { "type": "object", "properties": { "tokenId": { "type": "string", "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$", "description": "The token's NEP-141 identifier." }, "decimals": { "type": "integer", "minimum": 0, "maximum": 38, "description": "How many decimal places the token's smallest unit represents." } }, "required": [ "tokenId", "decimals" ], "description": "The exact token this asset is pinned to." } }, "required": [ "pinned" ] }, { "type": "object", "properties": { "any": { "type": "boolean", "const": true, "description": "Any token the agent wallet holds; the executor picks one at execution." } }, "required": [ "any" ] } ], "description": "The asset this action produces: pinned to one token, or left open." } }, "required": [ "kind", "input", "quantity", "output" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "send", "description": "Pay a pinned destination outside the agent wallet." }, "input": { "anyOf": [ { "type": "object", "properties": { "pinned": { "type": "object", "properties": { "tokenId": { "type": "string", "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$", "description": "The token's NEP-141 identifier." }, "decimals": { "type": "integer", "minimum": 0, "maximum": 38, "description": "How many decimal places the token's smallest unit represents." } }, "required": [ "tokenId", "decimals" ], "description": "The exact token this asset is pinned to." } }, "required": [ "pinned" ] }, { "type": "object", "properties": { "any": { "type": "boolean", "const": true, "description": "Any token the agent wallet holds; the executor picks one at execution." } }, "required": [ "any" ] } ], "description": "The asset this action spends: pinned to one token, or any token the agent wallet holds." }, "quantity": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_input_tokens", "description": "Spend an exact amount of the input token." }, "amountRaw": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})$", "description": "The exact input amount, in the input token's smallest unit." } }, "required": [ "kind", "amountRaw" ], "description": "Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw \"5000000\". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_input_value_usd", "description": "Spend a USD-denominated value of the input token." }, "value": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$", "description": "The USD value to spend, as a decimal string." } }, "required": [ "kind", "value" ], "description": "Spend a USD-denominated value of the input token: \"$5 worth of USDC\" means value \"5\". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_output_tokens", "description": "Receive an exact amount of the output token." }, "amountRaw": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})$", "description": "The exact output amount, in the output token's smallest unit." } }, "required": [ "kind", "amountRaw" ], "description": "Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "all_of_input", "description": "Spend everything the agent wallet holds of the input asset." } }, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "fraction_of_input", "description": "Spend a fraction of the input asset." }, "bps": { "type": "string", "pattern": "^(0|[1-9]\\d{0,4})$", "description": "The fraction to spend, in basis points of the input asset." } }, "required": [ "kind", "bps" ] } ], "description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it." }, "output": { "anyOf": [ { "type": "object", "properties": { "pinned": { "type": "object", "properties": { "tokenId": { "type": "string", "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$", "description": "The token's NEP-141 identifier." }, "decimals": { "type": "integer", "minimum": 0, "maximum": 38, "description": "How many decimal places the token's smallest unit represents." } }, "required": [ "tokenId", "decimals" ], "description": "The exact token this asset is pinned to." } }, "required": [ "pinned" ] }, { "type": "object", "properties": { "any": { "type": "boolean", "const": true, "description": "Any token the agent wallet holds; the executor picks one at execution." } }, "required": [ "any" ] } ], "description": "The asset this action produces: pinned to one token, or left open." }, "recipient": { "type": "object", "properties": { "chain": { "type": "string", "minLength": 1, "maxLength": 32, "description": "Which chain the destination address is on." }, "address": { "type": "string", "pattern": "^[\\x21-\\x7e]{1,128}$", "description": "The destination address on that chain." } }, "required": [ "chain", "address" ], "description": "The pinned destination this action pays." } }, "required": [ "kind", "input", "quantity", "output", "recipient" ] } ] }, "description": "The actions this contract authorizes, executed in order." }, "validUntil": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "When this contract's authority expires." }, "maxExecutions": { "type": "integer", "minimum": 1, "maximum": 10000, "description": "How many times this contract may be executed before it is exhausted." }, "bounds": { "type": "object", "properties": { "maxValueLossBps": { "type": "string", "pattern": "^(0|[1-9]\\d{0,4})$", "description": "The most value an execution may give up to price movement and fees together, in basis points." }, "maxSignatureLifetimeSeconds": { "type": "integer", "minimum": 1, "maximum": 259500, "description": "Explicit maximum lifetime of each released transfer signature, in seconds. 1Click confidential swaps require up to 259500 seconds (72 hours 5 minutes). This does not extend the short execution window or approval validity." } }, "required": [ "maxValueLossBps", "maxSignatureLifetimeSeconds" ], "description": "The value-loss and signature-lifetime limits every execution must respect." } }, "required": [ "type", "actions", "validUntil", "maxExecutions", "bounds" ] } ] }, { "type": "null" } ], "description": "The exact financial terms this decision authorizes, or null for an ordinary tool." }, "summary": { "type": "string", "description": "A short human-readable summary of what approving this would do." }, "status": { "type": "string", "enum": [ "pending", "approved", "denied", "expired" ], "description": "The parked decision's state: `pending` while it awaits a decision and has not expired, `approved` or `denied` once the caller decided, or `expired` when no decision arrived before `expiresAt`." }, "reason": { "description": "Why it was decided, if the decider gave one.", "type": [ "string", "null" ] }, "requestedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "When the tool call was parked." }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "When the parked decision lapses if nobody decides it." }, "decidedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When it was approved or denied; null until then." }, "consumedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When the approval was spent to authorize its call, immediately before that call ran; null until then, and always null when denied. The call itself can still fail after this is set — this is not proof the call succeeded, or even that it finished." }, "conversationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The conversation's id." }, "runId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "The stable public run that opened this decision; null for older unlinked history." }, "operationId": { "type": "null", "description": "Absent for a run-owned approval; the financial operation may link to this approval separately." } }, "required": [ "id", "tool", "fingerprint", "input", "contract", "summary", "status", "reason", "requestedAt", "expiresAt", "decidedAt", "consumedAt", "conversationId", "runId", "operationId" ] }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The approval's id." }, "tool": { "type": "string", "description": "The name of the tool call parked for a decision." }, "fingerprint": { "type": "string", "description": "Fingerprint binding this decision to the exact reviewed action." }, "input": { "description": "The exact public tool input retained for review.", "$ref": "#/components/schemas/JsonValue" }, "contract": { "anyOf": [ { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "near_intents_transfer", "description": "Which contract template this is." }, "actions": { "minItems": 1, "maxItems": 16, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "swap", "description": "Exchange one asset for another; custody never leaves the agent wallet." }, "input": { "anyOf": [ { "type": "object", "properties": { "pinned": { "type": "object", "properties": { "tokenId": { "type": "string", "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$", "description": "The token's NEP-141 identifier." }, "decimals": { "type": "integer", "minimum": 0, "maximum": 38, "description": "How many decimal places the token's smallest unit represents." } }, "required": [ "tokenId", "decimals" ], "description": "The exact token this asset is pinned to." } }, "required": [ "pinned" ] }, { "type": "object", "properties": { "any": { "type": "boolean", "const": true, "description": "Any token the agent wallet holds; the executor picks one at execution." } }, "required": [ "any" ] } ], "description": "The asset this action spends: pinned to one token, or any token the agent wallet holds." }, "quantity": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_input_tokens", "description": "Spend an exact amount of the input token." }, "amountRaw": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})$", "description": "The exact input amount, in the input token's smallest unit." } }, "required": [ "kind", "amountRaw" ], "description": "Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw \"5000000\". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_input_value_usd", "description": "Spend a USD-denominated value of the input token." }, "value": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$", "description": "The USD value to spend, as a decimal string." } }, "required": [ "kind", "value" ], "description": "Spend a USD-denominated value of the input token: \"$5 worth of USDC\" means value \"5\". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_output_tokens", "description": "Receive an exact amount of the output token." }, "amountRaw": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})$", "description": "The exact output amount, in the output token's smallest unit." } }, "required": [ "kind", "amountRaw" ], "description": "Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "all_of_input", "description": "Spend everything the agent wallet holds of the input asset." } }, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "fraction_of_input", "description": "Spend a fraction of the input asset." }, "bps": { "type": "string", "pattern": "^(0|[1-9]\\d{0,4})$", "description": "The fraction to spend, in basis points of the input asset." } }, "required": [ "kind", "bps" ] } ], "description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it." }, "output": { "anyOf": [ { "type": "object", "properties": { "pinned": { "type": "object", "properties": { "tokenId": { "type": "string", "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$", "description": "The token's NEP-141 identifier." }, "decimals": { "type": "integer", "minimum": 0, "maximum": 38, "description": "How many decimal places the token's smallest unit represents." } }, "required": [ "tokenId", "decimals" ], "description": "The exact token this asset is pinned to." } }, "required": [ "pinned" ] }, { "type": "object", "properties": { "any": { "type": "boolean", "const": true, "description": "Any token the agent wallet holds; the executor picks one at execution." } }, "required": [ "any" ] } ], "description": "The asset this action produces: pinned to one token, or left open." } }, "required": [ "kind", "input", "quantity", "output" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "withdraw_to_owner", "description": "Return an asset to the account that owns the agent wallet." }, "input": { "anyOf": [ { "type": "object", "properties": { "pinned": { "type": "object", "properties": { "tokenId": { "type": "string", "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$", "description": "The token's NEP-141 identifier." }, "decimals": { "type": "integer", "minimum": 0, "maximum": 38, "description": "How many decimal places the token's smallest unit represents." } }, "required": [ "tokenId", "decimals" ], "description": "The exact token this asset is pinned to." } }, "required": [ "pinned" ] }, { "type": "object", "properties": { "any": { "type": "boolean", "const": true, "description": "Any token the agent wallet holds; the executor picks one at execution." } }, "required": [ "any" ] } ], "description": "The asset this action spends: pinned to one token, or any token the agent wallet holds." }, "quantity": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_input_tokens", "description": "Spend an exact amount of the input token." }, "amountRaw": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})$", "description": "The exact input amount, in the input token's smallest unit." } }, "required": [ "kind", "amountRaw" ], "description": "Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw \"5000000\". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_input_value_usd", "description": "Spend a USD-denominated value of the input token." }, "value": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$", "description": "The USD value to spend, as a decimal string." } }, "required": [ "kind", "value" ], "description": "Spend a USD-denominated value of the input token: \"$5 worth of USDC\" means value \"5\". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_output_tokens", "description": "Receive an exact amount of the output token." }, "amountRaw": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})$", "description": "The exact output amount, in the output token's smallest unit." } }, "required": [ "kind", "amountRaw" ], "description": "Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "all_of_input", "description": "Spend everything the agent wallet holds of the input asset." } }, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "fraction_of_input", "description": "Spend a fraction of the input asset." }, "bps": { "type": "string", "pattern": "^(0|[1-9]\\d{0,4})$", "description": "The fraction to spend, in basis points of the input asset." } }, "required": [ "kind", "bps" ] } ], "description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it." }, "output": { "anyOf": [ { "type": "object", "properties": { "pinned": { "type": "object", "properties": { "tokenId": { "type": "string", "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$", "description": "The token's NEP-141 identifier." }, "decimals": { "type": "integer", "minimum": 0, "maximum": 38, "description": "How many decimal places the token's smallest unit represents." } }, "required": [ "tokenId", "decimals" ], "description": "The exact token this asset is pinned to." } }, "required": [ "pinned" ] }, { "type": "object", "properties": { "any": { "type": "boolean", "const": true, "description": "Any token the agent wallet holds; the executor picks one at execution." } }, "required": [ "any" ] } ], "description": "The asset this action produces: pinned to one token, or left open." } }, "required": [ "kind", "input", "quantity", "output" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "send", "description": "Pay a pinned destination outside the agent wallet." }, "input": { "anyOf": [ { "type": "object", "properties": { "pinned": { "type": "object", "properties": { "tokenId": { "type": "string", "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$", "description": "The token's NEP-141 identifier." }, "decimals": { "type": "integer", "minimum": 0, "maximum": 38, "description": "How many decimal places the token's smallest unit represents." } }, "required": [ "tokenId", "decimals" ], "description": "The exact token this asset is pinned to." } }, "required": [ "pinned" ] }, { "type": "object", "properties": { "any": { "type": "boolean", "const": true, "description": "Any token the agent wallet holds; the executor picks one at execution." } }, "required": [ "any" ] } ], "description": "The asset this action spends: pinned to one token, or any token the agent wallet holds." }, "quantity": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_input_tokens", "description": "Spend an exact amount of the input token." }, "amountRaw": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})$", "description": "The exact input amount, in the input token's smallest unit." } }, "required": [ "kind", "amountRaw" ], "description": "Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw \"5000000\". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_input_value_usd", "description": "Spend a USD-denominated value of the input token." }, "value": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$", "description": "The USD value to spend, as a decimal string." } }, "required": [ "kind", "value" ], "description": "Spend a USD-denominated value of the input token: \"$5 worth of USDC\" means value \"5\". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "exact_output_tokens", "description": "Receive an exact amount of the output token." }, "amountRaw": { "type": "string", "pattern": "^(0|[1-9]\\d{0,38})$", "description": "The exact output amount, in the output token's smallest unit." } }, "required": [ "kind", "amountRaw" ], "description": "Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash." }, { "type": "object", "properties": { "kind": { "type": "string", "const": "all_of_input", "description": "Spend everything the agent wallet holds of the input asset." } }, "required": [ "kind" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "fraction_of_input", "description": "Spend a fraction of the input asset." }, "bps": { "type": "string", "pattern": "^(0|[1-9]\\d{0,4})$", "description": "The fraction to spend, in basis points of the input asset." } }, "required": [ "kind", "bps" ] } ], "description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it." }, "output": { "anyOf": [ { "type": "object", "properties": { "pinned": { "type": "object", "properties": { "tokenId": { "type": "string", "pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$", "description": "The token's NEP-141 identifier." }, "decimals": { "type": "integer", "minimum": 0, "maximum": 38, "description": "How many decimal places the token's smallest unit represents." } }, "required": [ "tokenId", "decimals" ], "description": "The exact token this asset is pinned to." } }, "required": [ "pinned" ] }, { "type": "object", "properties": { "any": { "type": "boolean", "const": true, "description": "Any token the agent wallet holds; the executor picks one at execution." } }, "required": [ "any" ] } ], "description": "The asset this action produces: pinned to one token, or left open." }, "recipient": { "type": "object", "properties": { "chain": { "type": "string", "minLength": 1, "maxLength": 32, "description": "Which chain the destination address is on." }, "address": { "type": "string", "pattern": "^[\\x21-\\x7e]{1,128}$", "description": "The destination address on that chain." } }, "required": [ "chain", "address" ], "description": "The pinned destination this action pays." } }, "required": [ "kind", "input", "quantity", "output", "recipient" ] } ] }, "description": "The actions this contract authorizes, executed in order." }, "validUntil": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "When this contract's authority expires." }, "maxExecutions": { "type": "integer", "minimum": 1, "maximum": 10000, "description": "How many times this contract may be executed before it is exhausted." }, "bounds": { "type": "object", "properties": { "maxValueLossBps": { "type": "string", "pattern": "^(0|[1-9]\\d{0,4})$", "description": "The most value an execution may give up to price movement and fees together, in basis points." }, "maxSignatureLifetimeSeconds": { "type": "integer", "minimum": 1, "maximum": 259500, "description": "Explicit maximum lifetime of each released transfer signature, in seconds. 1Click confidential swaps require up to 259500 seconds (72 hours 5 minutes). This does not extend the short execution window or approval validity." } }, "required": [ "maxValueLossBps", "maxSignatureLifetimeSeconds" ], "description": "The value-loss and signature-lifetime limits every execution must respect." } }, "required": [ "type", "actions", "validUntil", "maxExecutions", "bounds" ] } ] }, { "type": "null" } ], "description": "The exact financial terms this decision authorizes, or null for an ordinary tool." }, "summary": { "type": "string", "description": "A short human-readable summary of what approving this would do." }, "status": { "type": "string", "enum": [ "pending", "approved", "denied", "expired" ], "description": "The parked decision's state: `pending` while it awaits a decision and has not expired, `approved` or `denied` once the caller decided, or `expired` when no decision arrived before `expiresAt`." }, "reason": { "description": "Why it was decided, if the decider gave one.", "type": [ "string", "null" ] }, "requestedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "When the tool call was parked." }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$", "description": "When the parked decision lapses if nobody decides it." }, "decidedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When it was approved or denied; null until then." }, "consumedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ], "description": "When the approval was spent to authorize its call, immediately before that call ran; null until then, and always null when denied. The call itself can still fail after this is set — this is not proof the call succeeded, or even that it finished." }, "conversationId": { "type": "null", "description": "Always null: a direct financial review belongs to its operation, not a conversation." }, "runId": { "type": "null", "description": "Always null: a direct financial review has no agent run." }, "operationId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The direct financial operation this review authorizes." } }, "required": [ "id", "tool", "fingerprint", "input", "contract", "summary", "status", "reason", "requestedAt", "expiresAt", "decidedAt", "consumedAt", "conversationId", "runId", "operationId" ] } ], "description": "An exact user-owned decision, its review terms and durable consent state." }, "JsonValue": { "description": "Any JSON value: a string, number, boolean, null, array or object.", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" }, { "type": "array", "items": { "$ref": "#/components/schemas/JsonValue" } }, { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "$ref": "#/components/schemas/JsonValue" } } ] }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "description": "The kind of problem as a URN, `urn:fin:error:`; stable, compare against it" }, "title": { "type": "string", "description": "The kind's human title, for logs; never parse it" }, "status": { "type": "integer", "minimum": 400, "maximum": 599, "description": "The HTTP status, repeated in the body" }, "reason": { "description": "The machine-readable why. One of:\n\n- `run_active` (409) — a run already holds this conversation\n- `budget_exhausted` (409) — the user's spend headroom is gone, or an operator froze it\n- `approval_not_pending` (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation\n- `execution_capacity` (409) — no execution capacity is free right now; `retryable` says whether to try again\n- `execution_unavailable` (409) — the execution engine could not take the work\n- `stop_pending` (409) — a stop is already in progress and its cleanup is not yet confirmed\n- `automation_changed` (409) — the `revision` sent is stale; reload the automation\n- `automation_held` (409) — an operator holds the automation; it fires again when released\n- `automation_invalid` (409) — the automation's definition cannot run as written\n- `automation_completed` (409) — the automation has finished for good and cannot fire again\n- `automation_limit` (409) — the user already has as many automations as the deployment allows\n- `profile_unknown_tool` (409) — the run profile names a tool this deployment does not have\n- `deployment_paused` (409) — an operator paused a deployment control; nothing was admitted or fired\n- `run_not_active` (409) — the run named in the path is not the conversation's live run\n- `withdrawal_changed` (409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progress\n- `credential_expired` (401) — the user token has expired; obtain a fresh one\n- `account_disabled` (403) — an operator disabled the account\n- `account_not_provisioned` (412) — the identity is verified but has no account yet; call `users.ensure` first\n- `provider_unavailable` (503) — an external provider the call depends on did not answer\n- `engine_unavailable` (503) — the execution engine did not answer\n- `invalid_input` (400) — the body or query failed validation; `issues` names each field\n- `internal` (500) — a fault on our side; quote `requestId` when reporting it\n- `partner_key_required` (401) — no `X-Api-Key` header was sent\n- `partner_key_invalid` (401) — the `X-Api-Key` is unknown or revoked\n- `subject_mismatch` (403) — the `{userId}` in the path is not the token's user\n- `origin_rejected` (403) — a browser `Origin` other than the configured web origin\n- `permission_required` (403) — the operator credential lacks the scope this call needs\n- `rate_limited` (429) — the per-key or per-user limit is spent; honour `Retry-After`\n- `stream_capacity` (429) — no stream socket is free on this replica or for this user; honour `Retry-After`\n- `invalid_cursor` (400) — the `cursor` is not one this list minted", "type": "string", "enum": [ "run_active", "budget_exhausted", "approval_not_pending", "execution_capacity", "execution_unavailable", "stop_pending", "automation_changed", "automation_held", "automation_invalid", "automation_completed", "automation_limit", "profile_unknown_tool", "deployment_paused", "run_not_active", "withdrawal_changed", "credential_expired", "account_disabled", "account_not_provisioned", "provider_unavailable", "engine_unavailable", "invalid_input", "internal", "partner_key_required", "partner_key_invalid", "subject_mismatch", "origin_rejected", "permission_required", "rate_limited", "stream_capacity", "invalid_cursor" ] }, "requestId": { "type": "string", "description": "The id Fin used for this request; quote it when reporting a problem" }, "retryable": { "type": "boolean", "description": "Whether repeating the same request later can succeed without changing it" }, "detail": { "description": "Only on `invalid_input`: which part of the request failed validation", "type": "string" }, "issues": { "description": "Only on `invalid_input`: one entry per failing field", "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "description": "The JSON pointer of the failing field; empty for the root object" }, "message": { "type": "string", "description": "Why the field failed" } }, "required": [ "path", "message" ] } } }, "required": [ "type", "title", "status", "requestId", "retryable" ], "description": "RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack." } }, "responses": { "InvalidInput": { "description": "The request could not be read as this operation expects.\n\n- `invalid_input` — the body or query failed validation; `issues` names each field\n- `invalid_cursor` — the `cursor` is not one this list minted", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "Unauthorized": { "description": "A credential is missing, invalid or expired.\n\n- `partner_key_required` — no `X-Api-Key` header was sent\n- `partner_key_invalid` — the `X-Api-Key` is unknown or revoked\n- `credential_expired` — the user token has expired; obtain a fresh one", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "Forbidden": { "description": "The credentials are valid but may not do this.\n\n- `subject_mismatch` — the `{userId}` in the path is not the token's user\n- `account_disabled` — an operator disabled the account\n- `origin_rejected` — a browser `Origin` other than the configured web origin", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "NotFound": { "description": "The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "AccountNotProvisioned": { "description": "The identity is verified but has no account yet.\n\n- `account_not_provisioned` — the identity is verified but has no account yet; call `users.ensure` first", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "TooManyRequests": { "description": "A limiter refused the request; honour `Retry-After`.\n\n- `rate_limited` — the per-key or per-user limit is spent; honour `Retry-After`", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "Internal": { "description": "A fault on our side; quote `requestId` when reporting it.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "Unavailable": { "description": "The replica is draining or a dependency did not answer; `retryable` says whether to try again.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" }, "userToken": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } } ```