@axivoy/api 1.26.0 → 1.28.0

package/dist/generated/schema.d.ts

@@ -377,6 +377,94 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/ops/agents.budgets.update": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Set an agent's limits
+         * @description Sets how many runs an agent may start per day, how many tool calls one run may make, and how many AI credits it may use per month. A run that reaches a limit waits for a person.
+         *
+         *     Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.agents.budgets.update"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/ops/agents.disable": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Turn an agent off now
+         * @description Stops one agent in this workspace: no new runs start, a running turn stops at its next step, and approvals it was waiting on are withdrawn. Only a person on the web can turn it back on.
+         *
+         *     Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.agents.disable"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/ops/agents.runs.cancel": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Cancel an agent run
+         * @description Ends one agent run: the step under way is the last one, and approvals it was waiting on are withdrawn. The agent itself stays on.
+         *
+         *     Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.agents.runs.cancel"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/ops/agents.runs.list": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * List an agent's runs
+         * @description One agent's runs, newest first: what each run is about, its status, how many steps it took, the AI credits it used so far, and the last operation it called.
+         *
+         *     Kind: `read`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.agents.runs.list"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/ops/ai.jobs.list": {
         parameters: {
             query?: never;
@@ -20222,6 +20310,585 @@ export interface operations {
             };
         };
     };
+    "ops.agents.budgets.update": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
+                "Idempotency-Key"?: string;
+                /** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
+                "Axivoy-Dry-Run"?: "true" | "false";
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                /**
+                 * @example {
+                 *       "agent_key": "tms_advisor",
+                 *       "max_tool_calls_per_run": 30,
+                 *       "monthly_credit_budget": null
+                 *     }
+                 */
+                "application/json": {
+                    /** @description The agent's key, for example recruiting_desk. */
+                    agent_key: string;
+                    /** @description Runs the agent may start per UTC day; null removes the limit, left out keeps it. */
+                    max_runs_per_day?: number | null;
+                    /** @description Tool calls one run may make; null removes the limit, left out keeps it. */
+                    max_tool_calls_per_run?: number | null;
+                    /** @description AI credits the agent may use per UTC month; null removes the limit, left out keeps it. */
+                    monthly_credit_budget?: number | null;
+                };
+            };
+        };
+        responses: {
+            /** @description The operation ran. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "result": {
+                     *         "message": "Limits saved.",
+                     *         "active_version": 3,
+                     *         "max_runs_per_day": 5,
+                     *         "max_tool_calls_per_run": 30,
+                     *         "monthly_credit_budget": null
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            /** @description What happened, in the operator's words */
+                            message: string;
+                            /** @description The version that now carries the limits */
+                            active_version: number;
+                            /** @description Runs per UTC day; null when unlimited */
+                            max_runs_per_day?: number | null;
+                            /** @description Tool calls per run; null when unlimited */
+                            max_tool_calls_per_run?: number | null;
+                            /** @description AI credits per UTC month; null when unlimited */
+                            monthly_credit_budget?: number | null;
+                        };
+                    };
+                };
+            };
+            202: components["responses"]["Proposal"];
+            /** @description Refused: credits_exhausted. */
+            402: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: idempotency_conflict, stale_state. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: operation_retired. */
+            410: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: invalid_input, domain_rule. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: rate_limited. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+        };
+    };
+    "ops.agents.disable": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
+                "Idempotency-Key"?: string;
+                /** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
+                "Axivoy-Dry-Run"?: "true" | "false";
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                /**
+                 * @example {
+                 *       "agent_key": "fixture_desk",
+                 *       "reason": "Stop"
+                 *     }
+                 */
+                "application/json": {
+                    /** @description The agent's key, for example recruiting_desk. */
+                    agent_key: string;
+                    /** @description Why the agent is being turned off; shown to whoever turns it back on. */
+                    reason: string;
+                };
+            };
+        };
+        responses: {
+            /** @description The operation ran. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "result": {
+                     *         "message": "Agent turned off.",
+                     *         "status": "disabled",
+                     *         "disabled_at": "2026-10-20T19:10:03Z",
+                     *         "held_runs_count": 1,
+                     *         "withdrawn_approvals_count": 0
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            /** @description What happened, in the operator's words */
+                            message: string;
+                            /** @description disabled */
+                            status: string;
+                            /**
+                             * Format: date-time
+                             * @description When the agent was turned off
+                             */
+                            disabled_at: string;
+                            /** @description Open runs put on hold */
+                            held_runs_count: number;
+                            /** @description Approvals the agent was waiting on that were withdrawn */
+                            withdrawn_approvals_count: number;
+                        };
+                    };
+                };
+            };
+            202: components["responses"]["Proposal"];
+            /** @description Refused: credits_exhausted. */
+            402: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: idempotency_conflict, stale_state. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: operation_retired. */
+            410: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: invalid_input, domain_rule. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: rate_limited. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+        };
+    };
+    "ops.agents.runs.cancel": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
+                "Idempotency-Key"?: string;
+                /** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
+                "Axivoy-Dry-Run"?: "true" | "false";
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                /**
+                 * @example {
+                 *       "run_id": 1,
+                 *       "reason": "Wrong file"
+                 *     }
+                 */
+                "application/json": {
+                    /** @description The run to cancel (from agents.runs.list). */
+                    run_id: number;
+                    /** @description Why, for the run timeline and the audit log. */
+                    reason?: string | null;
+                };
+            };
+        };
+        responses: {
+            /** @description The operation ran. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "result": {
+                     *         "message": "Run cancelled.",
+                     *         "status": "completed",
+                     *         "cancelled": true,
+                     *         "withdrawn_approvals_count": 0
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            /** @description What happened, in the operator's words */
+                            message: string;
+                            /** @description The run status after the call */
+                            status: string;
+                            /** @description False when the run had already ended */
+                            cancelled: boolean;
+                            /** @description Approvals the run was waiting on that were withdrawn */
+                            withdrawn_approvals_count: number;
+                        };
+                    };
+                };
+            };
+            202: components["responses"]["Proposal"];
+            /** @description Refused: credits_exhausted. */
+            402: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: idempotency_conflict, stale_state. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: operation_retired. */
+            410: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: invalid_input, domain_rule. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: rate_limited. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+        };
+    };
+    "ops.agents.runs.list": {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
+                "Idempotency-Key"?: string;
+                /** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
+                "Axivoy-Dry-Run"?: "true" | "false";
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                /**
+                 * @example {
+                 *       "agent_key": "fixture_desk"
+                 *     }
+                 */
+                "application/json": {
+                    /** @description The agent's key, for example recruiting_desk. */
+                    agent_key: string;
+                    /**
+                     * @description running, parked (waiting for a person), finished, or cancelled; all when left out.
+                     * @enum {string|null}
+                     */
+                    status?: "running" | "parked" | "finished" | "cancelled" | null;
+                    /** @description Cursor from the previous page's next_cursor. */
+                    cursor?: string | null;
+                    /** @description Rows per page (default 25). */
+                    limit?: number | null;
+                    /**
+                     * Format: date-time
+                     * @description Only rows changed at or after this instant, oldest change first, with deleted rows as tombstones.
+                     */
+                    updated_since?: string | null;
+                };
+            };
+        };
+        responses: {
+            /** @description The operation ran. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "result": {
+                     *         "items": [
+                     *           {
+                     *             "id": 2,
+                     *             "subject": "user:2",
+                     *             "status": "cancelled",
+                     *             "run_status": "completed",
+                     *             "reason": "run_cancelled",
+                     *             "steps": 0,
+                     *             "credits_used": 0,
+                     *             "last_operation_key": null,
+                     *             "started_at": null,
+                     *             "completed_at": null,
+                     *             "delegate": "ai_agent_run:2",
+                     *             "deleted": null
+                     *           },
+                     *           {
+                     *             "id": 1,
+                     *             "subject": "user:1",
+                     *             "status": "running",
+                     *             "run_status": "waiting",
+                     *             "reason": null,
+                     *             "steps": 0,
+                     *             "credits_used": 0,
+                     *             "last_operation_key": null,
+                     *             "started_at": "2026-10-20T19:10:09Z",
+                     *             "completed_at": null,
+                     *             "delegate": "ai_agent_run:1",
+                     *             "deleted": null
+                     *           }
+                     *         ],
+                     *         "next_cursor": null
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            /** @description One page of rows. */
+                            items: {
+                                /** @description The row's id. */
+                                id: number;
+                                /** @description What the run is about, as type:id */
+                                subject?: string | null;
+                                /** @description running, parked, finished or cancelled */
+                                status: string;
+                                /** @description The run's own status: pending, active, waiting, paused, completed or failed */
+                                run_status: string;
+                                /** @description Why a parked run waits or how a finished run ended */
+                                reason?: string | null;
+                                /** @description Steps recorded so far */
+                                steps: number;
+                                /** @description AI credits the run used so far */
+                                credits_used: number;
+                                /** @description The operation or tool the run called last */
+                                last_operation_key?: string | null;
+                                /**
+                                 * Format: date-time
+                                 * @description When the run first thought
+                                 */
+                                started_at?: string | null;
+                                /**
+                                 * Format: date-time
+                                 * @description When the run ended
+                                 */
+                                completed_at?: string | null;
+                                /** @description What audit entries for this run record as the delegate */
+                                delegate: string;
+                                /** @description True on a tombstone (the row was deleted or recycled); other fields are absent. */
+                                deleted?: boolean | null;
+                            }[];
+                            /** @description Pass as cursor for the next page; null on the last page. */
+                            next_cursor?: string | null;
+                        };
+                    };
+                };
+            };
+            202: components["responses"]["Proposal"];
+            /** @description Refused: credits_exhausted. */
+            402: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: not_found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: idempotency_conflict, stale_state. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: operation_retired. */
+            410: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: invalid_input, domain_rule. */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+            /** @description Refused: rate_limited. */
+            429: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OperationError"];
+                };
+            };
+        };
+    };
     "ops.ai.jobs.list": {
         parameters: {
             query?: never;
@@ -26351,7 +27018,7 @@ export interface operations {
                     plan_id: number;
                     /** @description First day of the new version, YYYY-MM-DD */
                     effective_from: string | null;
-                    /** @description Confirms a past date; unlocked pay lines are not recalculated automatically */
+                    /** @description Confirms a past date; unlocked pay lines from that date are recalculated in the background */
                     confirm_past_effective?: boolean | string | number | null;
                 };
             };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axivoy/api",
-  "version": "1.26.0",
+  "version": "1.28.0",
   "description": "Typed client for the Axivoy API: operations, webhooks and errors.",
   "license": "MIT",
   "homepage": "https://app.axivoy.ai/developers",