@axivoy/api 1.28.0 → 1.30.0

package/dist/generated/schema.d.ts

@@ -421,6 +421,72 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/ops/agents.get": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Get an AI agent
+         * @description One AI agent: whether it is on, who turned it off and why, its limits and usage, what it may do, its versions, and what its latest rehearsals would have done.
+         *
+         *     Kind: `read`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.agents.get"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/ops/agents.list": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * List AI agents
+         * @description The workspace's AI agents: whether each is on, who turned it off and why, holds Axivoy placed, its limits, and runs, refusals and AI credits used so far.
+         *
+         *     Kind: `read`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.agents.list"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/ops/agents.rehearse": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Try an agent without changing anything
+         * @description Runs one turn of an agent version on a real record without changing or sending anything, or on practice data in the sandbox, and records what it would have done on the run timeline.
+         *
+         *     Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
+         */
+        post: operations["ops.agents.rehearse"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/ops/agents.runs.cancel": {
         parameters: {
             query?: never;
@@ -20574,6 +20640,633 @@ export interface operations {
             };
         };
     };
+    "ops.agents.get": {
+        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;
+                };
+            };
+        };
+        responses: {
+            /** @description The operation ran. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "result": {
+                     *         "key": "fixture_desk",
+                     *         "name": "Fixture desk",
+                     *         "origin": "axivoy",
+                     *         "owner_name": null,
+                     *         "status": "on",
+                     *         "disabled_at": null,
+                     *         "disabled_cause": null,
+                     *         "disabled_reason": null,
+                     *         "disabled_by": null,
+                     *         "platform_holds": [],
+                     *         "limit_reached": null,
+                     *         "active_version": 1,
+                     *         "max_runs_per_day": null,
+                     *         "max_tool_calls_per_run": null,
+                     *         "monthly_credit_budget": null,
+                     *         "runs_today": 0,
+                     *         "credits_used_this_month": 0,
+                     *         "credits_last_hour": 0,
+                     *         "refusals_last_hour": 0,
+                     *         "open_runs": 0,
+                     *         "rehearsals_running": 0,
+                     *         "last_run_at": null,
+                     *         "subscription_count": 0,
+                     *         "operations": [],
+                     *         "versions": [
+                     *           {
+                     *             "version": 1,
+                     *             "live": true,
+                     *             "created_at": "2026-10-20T20:56:41Z",
+                     *             "created_by": null,
+                     *             "max_runs_per_day": null,
+                     *             "max_tool_calls_per_run": null,
+                     *             "monthly_credit_budget": null
+                     *           }
+                     *         ],
+                     *         "rehearsals": []
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            /** @description The agent's key, for example recruiting_desk */
+                            key: string;
+                            /** @description The agent's name */
+                            name: string;
+                            /** @description axivoy (made by Axivoy) or tenant (built in this workspace) */
+                            origin: string;
+                            /** @description Who owns the agent; null for Axivoy's agents */
+                            owner_name?: string | null;
+                            /** @description on, off, auto_paused, paused_by_axivoy or at_limit */
+                            status: string;
+                            /**
+                             * Format: date-time
+                             * @description When it was turned off
+                             */
+                            disabled_at?: string | null;
+                            /** @description person or circuit_breaker */
+                            disabled_cause?: string | null;
+                            /** @description Why it was turned off, in the words of whoever did it */
+                            disabled_reason?: string | null;
+                            /** @description Who turned it off; null when the breaker did */
+                            disabled_by?: string | null;
+                            /** @description Holds Axivoy placed on the agent */
+                            platform_holds: {
+                                /** @description pause_tenant, pause_definition or pin_version */
+                                kind: string;
+                                /** @description The pinned version, for pin_version */
+                                version?: number | null;
+                                /**
+                                 * Format: date-time
+                                 * @description When Axivoy placed it
+                                 */
+                                since?: string | null;
+                            }[];
+                            /** @description max_runs_per_day or monthly_credit_budget when one is used up */
+                            limit_reached?: string | null;
+                            /** @description The live version */
+                            active_version?: number | null;
+                            /** @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;
+                            /** @description Runs started this UTC day */
+                            runs_today: number;
+                            /** @description AI credits used this UTC month */
+                            credits_used_this_month: number;
+                            /** @description AI credits used in the last hour */
+                            credits_last_hour: number;
+                            /** @description Tool calls that failed or were refused in the last hour */
+                            refusals_last_hour: number;
+                            /** @description Runs not finished yet */
+                            open_runs: number;
+                            /** @description Rehearsals not finished yet */
+                            rehearsals_running: number;
+                            /**
+                             * Format: date-time
+                             * @description When the latest run started
+                             */
+                            last_run_at?: string | null;
+                            /** @description Event subscriptions on the live version */
+                            subscription_count: number;
+                            /** @description What the live version may do */
+                            operations: {
+                                /** @description The tool key */
+                                key: string;
+                                /** @description The operation the tool runs, when it runs one */
+                                operation?: string | null;
+                                /** @description off, propose or auto, as the version sets it */
+                                configured_authority: string;
+                                /** @description What it may actually do, capped by the ceiling for the agent's origin */
+                                effective_authority: string;
+                            }[];
+                            /** @description Newest first, up to 20 */
+                            versions: {
+                                /** @description Version number */
+                                version: number;
+                                /** @description Whether this is the live version */
+                                live: boolean;
+                                /**
+                                 * Format: date-time
+                                 * @description When it was made
+                                 */
+                                created_at?: string | null;
+                                /** @description Who made it; null when Axivoy did */
+                                created_by?: string | null;
+                                /** @description Runs per UTC day */
+                                max_runs_per_day?: number | null;
+                                /** @description Tool calls per run */
+                                max_tool_calls_per_run?: number | null;
+                                /** @description AI credits per UTC month */
+                                monthly_credit_budget?: number | null;
+                            }[];
+                            /** @description Latest five rehearsals, newest first */
+                            rehearsals: {
+                                /** @description The rehearsal run */
+                                run_id: number;
+                                /** @description dry_run or sandbox */
+                                mode: string;
+                                /** @description The version it tried */
+                                version?: number | null;
+                                /** @description running or finished */
+                                status: string;
+                                /** @description Where it stopped: waiting:{on}, done, a pause reason or limit:{limit} */
+                                stopped_on?: string | null;
+                                /**
+                                 * Format: date-time
+                                 * @description When it started
+                                 */
+                                started_at?: string | null;
+                                /** @description Steps recorded */
+                                steps: number;
+                                /** @description AI credits it used */
+                                credits: number;
+                                /** @description What it would have done, in order */
+                                actions: {
+                                    /** @description The tool it would have called */
+                                    tool: string;
+                                    /** @description The tool's name */
+                                    label: string;
+                                    /** @description do, ask_first or refused */
+                                    would: string;
+                                    /** @description The first text the call carried, shortened */
+                                    detail?: 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.agents.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 {} */
+                "application/json": {
+                    /** @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": 1,
+                     *             "key": "fixture_desk",
+                     *             "name": "Fixture desk",
+                     *             "origin": "axivoy",
+                     *             "owner_name": null,
+                     *             "status": "off",
+                     *             "disabled_at": "2026-10-20T20:56:40Z",
+                     *             "disabled_cause": "person",
+                     *             "disabled_reason": "Too chatty",
+                     *             "disabled_by": "Dayne Huel",
+                     *             "platform_holds": [],
+                     *             "limit_reached": null,
+                     *             "active_version": 1,
+                     *             "max_runs_per_day": null,
+                     *             "max_tool_calls_per_run": null,
+                     *             "monthly_credit_budget": null,
+                     *             "runs_today": 1,
+                     *             "credits_used_this_month": 0,
+                     *             "credits_last_hour": 0,
+                     *             "refusals_last_hour": 0,
+                     *             "open_runs": 1,
+                     *             "rehearsals_running": 0,
+                     *             "last_run_at": "2026-10-20T20:56:40Z",
+                     *             "deleted": null
+                     *           }
+                     *         ],
+                     *         "next_cursor": null
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            /** @description One page of rows. */
+                            items: {
+                                /** @description The row's id. */
+                                id: number;
+                                /** @description The agent's key, for example recruiting_desk */
+                                key: string;
+                                /** @description The agent's name */
+                                name: string;
+                                /** @description axivoy (made by Axivoy) or tenant (built in this workspace) */
+                                origin: string;
+                                /** @description Who owns the agent; null for Axivoy's agents */
+                                owner_name?: string | null;
+                                /** @description on, off, auto_paused, paused_by_axivoy or at_limit */
+                                status: string;
+                                /**
+                                 * Format: date-time
+                                 * @description When it was turned off
+                                 */
+                                disabled_at?: string | null;
+                                /** @description person or circuit_breaker */
+                                disabled_cause?: string | null;
+                                /** @description Why it was turned off, in the words of whoever did it */
+                                disabled_reason?: string | null;
+                                /** @description Who turned it off; null when the breaker did */
+                                disabled_by?: string | null;
+                                /** @description Holds Axivoy placed on the agent */
+                                platform_holds: {
+                                    /** @description pause_tenant, pause_definition or pin_version */
+                                    kind: string;
+                                    /** @description The pinned version, for pin_version */
+                                    version?: number | null;
+                                    /**
+                                     * Format: date-time
+                                     * @description When Axivoy placed it
+                                     */
+                                    since?: string | null;
+                                }[];
+                                /** @description max_runs_per_day or monthly_credit_budget when one is used up */
+                                limit_reached?: string | null;
+                                /** @description The live version */
+                                active_version?: number | null;
+                                /** @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;
+                                /** @description Runs started this UTC day */
+                                runs_today: number;
+                                /** @description AI credits used this UTC month */
+                                credits_used_this_month: number;
+                                /** @description AI credits used in the last hour */
+                                credits_last_hour: number;
+                                /** @description Tool calls that failed or were refused in the last hour */
+                                refusals_last_hour: number;
+                                /** @description Runs not finished yet */
+                                open_runs: number;
+                                /** @description Rehearsals not finished yet */
+                                rehearsals_running: number;
+                                /**
+                                 * Format: date-time
+                                 * @description When the latest run started
+                                 */
+                                last_run_at?: string | null;
+                                /** @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.agents.rehearse": {
+        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": "fake_desk",
+                 *       "mode": "dry_run",
+                 *       "subject": {
+                 *         "id": 1
+                 *       }
+                 *     }
+                 */
+                "application/json": {
+                    /** @description The agent's key, for example recruiting_desk. */
+                    agent_key: string;
+                    /** @description The version to try; the live version when left out. */
+                    version?: number;
+                    /**
+                     * @description dry_run: real records, nothing changed or sent. sandbox: practice data in the workspace's sandbox.
+                     * @enum {string}
+                     */
+                    mode: "dry_run" | "sandbox";
+                    /** @description The record to try it on. Dry run: the record of the agent's latest run when left out. Sandbox: the newest practice record. */
+                    subject?: {
+                        /** @description The record type the agent works on; checked against the agent. */
+                        type?: string;
+                        /** @description The record id. */
+                        id: number;
+                    };
+                    /** @description Dry run only: a recorded event (its id from events.list) to replay as the trigger; its record becomes the subject. */
+                    event_id?: string;
+                    /** @description Sandbox only: one of the agent's scenario keys. Seeds that scenario's practice record and wakes the agent with its event, so the same situation can be tried on any version. */
+                    scenario?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description The operation ran. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /**
+                     * @example {
+                     *       "result": {
+                     *         "message": "Trying it without changing anything. The result shows here when it stops.",
+                     *         "task_id": "a171294f-f44f-49d9-a87b-6912387bf1e0",
+                     *         "run_id": 1,
+                     *         "status": "running"
+                     *       }
+                     *     }
+                     */
+                    "application/json": {
+                        result: {
+                            /** @description What happened, in the operator's words */
+                            message: string;
+                            /** @description Poll tasks.get; operation.task.completed fires when the rehearsal stops */
+                            task_id: string;
+                            /** @description The rehearsal run; its timeline shows what the agent would have done */
+                            run_id: number;
+                            /** @description running */
+                            status: string;
+                        };
+                    };
+                };
+            };
+            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;

package/package.json

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