@arbidocs/client 0.4.103 → 0.4.105
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.cts +392 -89
- package/dist/index.d.ts +392 -89
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -27,7 +27,7 @@ interface paths {
|
|
|
27
27
|
* Create Project
|
|
28
28
|
* @description Create a new project on the Free or the Pro plan.
|
|
29
29
|
*
|
|
30
|
-
* Pro is created as 'pending' (awaiting Stripe payment) with NO AI
|
|
30
|
+
* Pro is created as 'pending' (awaiting Stripe payment) with NO AI usage — it
|
|
31
31
|
* only becomes usable once checkout succeeds (refresh_project links the Stripe
|
|
32
32
|
* subscription and grants the paid budget), so a cancelled checkout never leaves
|
|
33
33
|
* a usable project behind. Free projects are usable at once with the free-tier
|
|
@@ -235,7 +235,7 @@ interface paths {
|
|
|
235
235
|
};
|
|
236
236
|
/**
|
|
237
237
|
* Get Project Conversation Usage Endpoint
|
|
238
|
-
* @description AI usage of a project's billing period by conversation (thread / work item), in
|
|
238
|
+
* @description AI usage of a project's billing period by conversation (thread / work item), in £.
|
|
239
239
|
*
|
|
240
240
|
* Each model call is tagged with the conversation it serves; spend that served none is ``unattributed``.
|
|
241
241
|
* Per-step detail of one conversation: ``GET /v1/conversation/{conversation_ext_id}/usage``.
|
|
@@ -353,7 +353,7 @@ interface paths {
|
|
|
353
353
|
patch?: never;
|
|
354
354
|
trace?: never;
|
|
355
355
|
};
|
|
356
|
-
'/v1/user/projects/{project_ext_id}/addons/
|
|
356
|
+
'/v1/user/projects/{project_ext_id}/addons/ai-usage': {
|
|
357
357
|
parameters: {
|
|
358
358
|
query?: never;
|
|
359
359
|
header?: never;
|
|
@@ -363,17 +363,17 @@ interface paths {
|
|
|
363
363
|
get?: never;
|
|
364
364
|
put?: never;
|
|
365
365
|
/**
|
|
366
|
-
* Add Project
|
|
367
|
-
* @description Add one
|
|
366
|
+
* Add Project Ai Block
|
|
367
|
+
* @description Add one AI usage block (+£10 of AI usage a month), charged now for the current period to the saved card.
|
|
368
368
|
*
|
|
369
369
|
* The block stays on the subscription and renews at the full block price each period until reduced.
|
|
370
370
|
*
|
|
371
|
-
* Monthly plans pay the full block price; annual plans pay the discounted monthly
|
|
371
|
+
* Monthly plans pay the full block price (£10 + VAT); annual plans pay the discounted monthly
|
|
372
372
|
* rate for each remaining month. A declined payment grants nothing (402
|
|
373
373
|
* ``PAYMENT_DECLINED``); 3-D Secure returns ``requires_action`` with the hosted
|
|
374
374
|
* invoice to confirm. Refused with 402 ``ADDON_SPEND_CAP`` at the monthly cap.
|
|
375
375
|
*/
|
|
376
|
-
post: operations['
|
|
376
|
+
post: operations['add_project_ai_block'];
|
|
377
377
|
delete?: never;
|
|
378
378
|
options?: never;
|
|
379
379
|
head?: never;
|
|
@@ -395,7 +395,7 @@ interface paths {
|
|
|
395
395
|
*
|
|
396
396
|
* It stays on the subscription and renews each period until reduced.
|
|
397
397
|
*
|
|
398
|
-
* Same outcomes as the
|
|
398
|
+
* Same outcomes as the AI usage block: ``paid``, ``requires_action`` (3-D Secure) or a
|
|
399
399
|
* 402 (``ADDON_SPEND_CAP``, ``PAYMENT_DECLINED``, ...).
|
|
400
400
|
*/
|
|
401
401
|
post: operations['add_project_storage_block'];
|
|
@@ -415,7 +415,7 @@ interface paths {
|
|
|
415
415
|
get?: never;
|
|
416
416
|
/**
|
|
417
417
|
* Update Project Next Period Addons
|
|
418
|
-
* @description Reduce the
|
|
418
|
+
* @description Reduce the AI usage / storage blocks that renew from the next period, or undo a reduction.
|
|
419
419
|
*
|
|
420
420
|
* Send the number of blocks to keep from the next period (null leaves a kind unchanged); the current
|
|
421
421
|
* count undoes a pending reduction. Higher than the current count is refused (409: add blocks instead),
|
|
@@ -460,7 +460,7 @@ interface paths {
|
|
|
460
460
|
get?: never;
|
|
461
461
|
/**
|
|
462
462
|
* Update Project Addon Settings
|
|
463
|
-
* @description Set the monthly add-on budget (0 = no add-ons, null = no limit) and the automatic add-on trigger (min
|
|
463
|
+
* @description Set the monthly add-on budget (0 = no add-ons, null = no limit) and the automatic add-on trigger (min £1).
|
|
464
464
|
*
|
|
465
465
|
* Changes apply to future additions only: blocks already added stay (reduce them
|
|
466
466
|
* from the next period instead), and nothing is refunded.
|
|
@@ -797,11 +797,11 @@ interface paths {
|
|
|
797
797
|
};
|
|
798
798
|
/**
|
|
799
799
|
* Get User Usage Today
|
|
800
|
-
* @description Return today's deployment-wide
|
|
800
|
+
* @description Return today's deployment-wide AI usage (£) for the current user.
|
|
801
801
|
*
|
|
802
802
|
* The same number that the per-user daily cap is enforced against in
|
|
803
803
|
* ``check_ai_access``. Frontend pairs this with the project's
|
|
804
|
-
* ``daily_cap_per_user`` to render
|
|
804
|
+
* ``daily_cap_per_user`` (£) to render an "AI usage today" indicator for non-owners.
|
|
805
805
|
*/
|
|
806
806
|
get: operations['get_user_usage_today'];
|
|
807
807
|
put?: never;
|
|
@@ -927,7 +927,7 @@ interface paths {
|
|
|
927
927
|
};
|
|
928
928
|
/**
|
|
929
929
|
* Get Me
|
|
930
|
-
* @description The signed-in user, with ``can_create_projects`` (derived on every call
|
|
930
|
+
* @description The signed-in user, with ``can_create_projects`` and ``is_deployment_admin`` (derived on every call).
|
|
931
931
|
*/
|
|
932
932
|
get: operations['get_current_user'];
|
|
933
933
|
put?: never;
|
|
@@ -1056,6 +1056,51 @@ interface paths {
|
|
|
1056
1056
|
patch?: never;
|
|
1057
1057
|
trace?: never;
|
|
1058
1058
|
};
|
|
1059
|
+
'/v1/firm/pool': {
|
|
1060
|
+
parameters: {
|
|
1061
|
+
query?: never;
|
|
1062
|
+
header?: never;
|
|
1063
|
+
path?: never;
|
|
1064
|
+
cookie?: never;
|
|
1065
|
+
};
|
|
1066
|
+
/**
|
|
1067
|
+
* Get Firm Pool
|
|
1068
|
+
* @description The firm's AI usage this month in £ (Box): total, used, remaining, automatic add-ons. Members and admins.
|
|
1069
|
+
*
|
|
1070
|
+
* Cached for a minute; never on the AI path.
|
|
1071
|
+
*/
|
|
1072
|
+
get: operations['get_firm_pool'];
|
|
1073
|
+
put?: never;
|
|
1074
|
+
post?: never;
|
|
1075
|
+
delete?: never;
|
|
1076
|
+
options?: never;
|
|
1077
|
+
head?: never;
|
|
1078
|
+
patch?: never;
|
|
1079
|
+
trace?: never;
|
|
1080
|
+
};
|
|
1081
|
+
'/v1/firm/pool/topup': {
|
|
1082
|
+
parameters: {
|
|
1083
|
+
query?: never;
|
|
1084
|
+
header?: never;
|
|
1085
|
+
path?: never;
|
|
1086
|
+
cookie?: never;
|
|
1087
|
+
};
|
|
1088
|
+
get?: never;
|
|
1089
|
+
put?: never;
|
|
1090
|
+
/**
|
|
1091
|
+
* Top Up Firm Pool
|
|
1092
|
+
* @description Add renewing AI usage add-ons (+£10 of AI usage a month each) to the firm's Box subscription. Box admins only.
|
|
1093
|
+
*
|
|
1094
|
+
* Central adds them to the subscription, invoices the prorated amount on its terms and raises the AI budget
|
|
1095
|
+
* before answering. 409 when the deployment has no live Box subscription.
|
|
1096
|
+
*/
|
|
1097
|
+
post: operations['top_up_firm_pool'];
|
|
1098
|
+
delete?: never;
|
|
1099
|
+
options?: never;
|
|
1100
|
+
head?: never;
|
|
1101
|
+
patch?: never;
|
|
1102
|
+
trace?: never;
|
|
1103
|
+
};
|
|
1059
1104
|
'/v1/user/identity': {
|
|
1060
1105
|
parameters: {
|
|
1061
1106
|
query?: never;
|
|
@@ -1739,6 +1784,9 @@ interface paths {
|
|
|
1739
1784
|
/**
|
|
1740
1785
|
* Native Content
|
|
1741
1786
|
* @description The document as DOCX — its current version, or ``version`` (a read-only snapshot).
|
|
1787
|
+
*
|
|
1788
|
+
* Also the active workspace's house template when that is a document of a public workspace (read-only, with the
|
|
1789
|
+
* public workspace's key: no membership there is needed).
|
|
1742
1790
|
*/
|
|
1743
1791
|
get: operations['native_content_v1_editor__document_id__content_get'];
|
|
1744
1792
|
put?: never;
|
|
@@ -2655,7 +2703,7 @@ interface paths {
|
|
|
2655
2703
|
* Get Conversation Usage Endpoint
|
|
2656
2704
|
* @description AI usage of a conversation since it was created: total, by workflow step, run, model and agent.
|
|
2657
2705
|
*
|
|
2658
|
-
* In
|
|
2706
|
+
* In £, like project usage. Every model call is tagged with the conversation it serves and, for a
|
|
2659
2707
|
* work run, the run and workflow step (a stage is a set of steps: sum ``by_step``). Read from the spend
|
|
2660
2708
|
* logs of the project the conversation's workspace bills to; anyone who can read the conversation may.
|
|
2661
2709
|
*/
|
|
@@ -3322,6 +3370,35 @@ interface paths {
|
|
|
3322
3370
|
patch?: never;
|
|
3323
3371
|
trace?: never;
|
|
3324
3372
|
};
|
|
3373
|
+
'/v1/deployment/house-template': {
|
|
3374
|
+
parameters: {
|
|
3375
|
+
query?: never;
|
|
3376
|
+
header?: never;
|
|
3377
|
+
path?: never;
|
|
3378
|
+
cookie?: never;
|
|
3379
|
+
};
|
|
3380
|
+
/**
|
|
3381
|
+
* Get Deployment House Template
|
|
3382
|
+
* @description The deployment's default house template (.dotx/.docx), for any signed-in user; 404 when none is set.
|
|
3383
|
+
*/
|
|
3384
|
+
get: operations['get_deployment_house_template'];
|
|
3385
|
+
/**
|
|
3386
|
+
* Set Deployment House Template
|
|
3387
|
+
* @description Set the deployment's default house template. Deployment admins only.
|
|
3388
|
+
*/
|
|
3389
|
+
put: operations['set_deployment_house_template'];
|
|
3390
|
+
post?: never;
|
|
3391
|
+
/**
|
|
3392
|
+
* Delete Deployment House Template
|
|
3393
|
+
* @description Clear the deployment's default house template (new documents fall back to the built-in one).
|
|
3394
|
+
* Deployment admins only. Clearing when none is set is not an error.
|
|
3395
|
+
*/
|
|
3396
|
+
delete: operations['delete_deployment_house_template'];
|
|
3397
|
+
options?: never;
|
|
3398
|
+
head?: never;
|
|
3399
|
+
patch?: never;
|
|
3400
|
+
trace?: never;
|
|
3401
|
+
};
|
|
3325
3402
|
'/v1/tag/': {
|
|
3326
3403
|
parameters: {
|
|
3327
3404
|
query?: never;
|
|
@@ -6721,7 +6798,7 @@ interface components {
|
|
|
6721
6798
|
*/
|
|
6722
6799
|
status: 'pending' | 'paid';
|
|
6723
6800
|
/** Kind */
|
|
6724
|
-
kind?: ('
|
|
6801
|
+
kind?: ('ai_usage' | 'storage') | null;
|
|
6725
6802
|
/** Amount Pence */
|
|
6726
6803
|
amount_pence?: number | null;
|
|
6727
6804
|
/** Amount Ex Vat Pence */
|
|
@@ -6742,12 +6819,12 @@ interface components {
|
|
|
6742
6819
|
* Kind
|
|
6743
6820
|
* @enum {string}
|
|
6744
6821
|
*/
|
|
6745
|
-
kind: '
|
|
6822
|
+
kind: 'ai_usage' | 'storage';
|
|
6746
6823
|
/**
|
|
6747
|
-
*
|
|
6824
|
+
* Ai Gbp
|
|
6748
6825
|
* @default 0
|
|
6749
6826
|
*/
|
|
6750
|
-
|
|
6827
|
+
ai_gbp: number;
|
|
6751
6828
|
/**
|
|
6752
6829
|
* Storage Gb
|
|
6753
6830
|
* @default 0
|
|
@@ -6785,7 +6862,7 @@ interface components {
|
|
|
6785
6862
|
* Kind
|
|
6786
6863
|
* @enum {string}
|
|
6787
6864
|
*/
|
|
6788
|
-
kind: '
|
|
6865
|
+
kind: 'ai_usage' | 'storage';
|
|
6789
6866
|
now: components['schemas']['TaxQuoteResponse'];
|
|
6790
6867
|
renewal: components['schemas']['TaxQuoteResponse'];
|
|
6791
6868
|
};
|
|
@@ -7048,10 +7125,10 @@ interface components {
|
|
|
7048
7125
|
*/
|
|
7049
7126
|
step_tokens?: number | null;
|
|
7050
7127
|
/**
|
|
7051
|
-
* Step
|
|
7052
|
-
* @description This step's own AI
|
|
7128
|
+
* Step Gbp
|
|
7129
|
+
* @description This step's own AI usage cost in £, priced from cached model pricing — an estimate, not the authoritative LiteLLM cost (which is captured once per call into the turn-level ledger total, not correlated back to a specific step).
|
|
7053
7130
|
*/
|
|
7054
|
-
|
|
7131
|
+
step_gbp?: number | null;
|
|
7055
7132
|
/** @description Token budget context snapshot. Present when retrieval counts change. */
|
|
7056
7133
|
context?: components['schemas']['TokenBudgetContext'] | null;
|
|
7057
7134
|
/**
|
|
@@ -7300,11 +7377,11 @@ interface components {
|
|
|
7300
7377
|
*/
|
|
7301
7378
|
AGENT_MAX_ITERATIONS: number;
|
|
7302
7379
|
/**
|
|
7303
|
-
* Agent Turn
|
|
7304
|
-
* @description Maximum
|
|
7305
|
-
* @default
|
|
7380
|
+
* Agent Turn Budget Gbp
|
|
7381
|
+
* @description Maximum £ of AI usage a turn may spend, shared across the main agent and every deep_research/spawn_coding_agent/sub_agent child it spawns — priced per call using each call's own model, since different stages run different models. Enforced as a meter on the shared run budget alongside tool calls and tokens, so nearing it also nudges the agent to converge (70%), blocks new sub-agent spawns (90%), and offers the pause-and-extend prompt before forcing an answer. Default is half FREE_AI_GBP (£1) — a free account's entire grant, so one turn can't consume it all. 0 = uncapped.
|
|
7382
|
+
* @default 0.5
|
|
7306
7383
|
*/
|
|
7307
|
-
|
|
7384
|
+
AGENT_TURN_BUDGET_GBP: number;
|
|
7308
7385
|
/**
|
|
7309
7386
|
* Agent Max Parallel Tool Calls
|
|
7310
7387
|
* @description Maximum number of tool calls the agent can make in a single iteration. Extra calls beyond this limit are silently dropped.
|
|
@@ -7530,11 +7607,11 @@ interface components {
|
|
|
7530
7607
|
*/
|
|
7531
7608
|
AGENT_MAX_ITERATIONS: number;
|
|
7532
7609
|
/**
|
|
7533
|
-
* Agent Turn
|
|
7534
|
-
* @description Maximum
|
|
7535
|
-
* @default
|
|
7610
|
+
* Agent Turn Budget Gbp
|
|
7611
|
+
* @description Maximum £ of AI usage a turn may spend, shared across the main agent and every deep_research/spawn_coding_agent/sub_agent child it spawns — priced per call using each call's own model, since different stages run different models. Enforced as a meter on the shared run budget alongside tool calls and tokens, so nearing it also nudges the agent to converge (70%), blocks new sub-agent spawns (90%), and offers the pause-and-extend prompt before forcing an answer. Default is half FREE_AI_GBP (£1) — a free account's entire grant, so one turn can't consume it all. 0 = uncapped.
|
|
7612
|
+
* @default 0.5
|
|
7536
7613
|
*/
|
|
7537
|
-
|
|
7614
|
+
AGENT_TURN_BUDGET_GBP: number;
|
|
7538
7615
|
};
|
|
7539
7616
|
/** AllConfigs */
|
|
7540
7617
|
AllConfigs: {
|
|
@@ -7573,7 +7650,7 @@ interface components {
|
|
|
7573
7650
|
* "ENABLE_THINKING": false,
|
|
7574
7651
|
* "AGENT_STRICT_TOOL_CALLS": true,
|
|
7575
7652
|
* "AGENT_MAX_ITERATIONS": 20,
|
|
7576
|
-
* "
|
|
7653
|
+
* "AGENT_TURN_BUDGET_GBP": 0.5,
|
|
7577
7654
|
* "AGENT_MAX_PARALLEL_TOOL_CALLS": 10,
|
|
7578
7655
|
* "AGENT_MAX_TOTAL_TOOL_CALLS": 80,
|
|
7579
7656
|
* "AGENT_MAX_RUN_TOKENS": 1500000,
|
|
@@ -8015,12 +8092,12 @@ interface components {
|
|
|
8015
8092
|
message: string;
|
|
8016
8093
|
/**
|
|
8017
8094
|
* Spend
|
|
8018
|
-
* @description
|
|
8095
|
+
* @description AI usage spent, £ (QUOTA_EXCEEDED)
|
|
8019
8096
|
*/
|
|
8020
8097
|
spend?: number | null;
|
|
8021
8098
|
/**
|
|
8022
8099
|
* Budget
|
|
8023
|
-
* @description
|
|
8100
|
+
* @description AI usage limit, £ (QUOTA_EXCEEDED)
|
|
8024
8101
|
*/
|
|
8025
8102
|
budget?: number | null;
|
|
8026
8103
|
/**
|
|
@@ -8081,10 +8158,10 @@ interface components {
|
|
|
8081
8158
|
*/
|
|
8082
8159
|
step_tokens?: number | null;
|
|
8083
8160
|
/**
|
|
8084
|
-
* Step
|
|
8085
|
-
* @description This item's own AI
|
|
8161
|
+
* Step Gbp
|
|
8162
|
+
* @description This item's own AI usage cost in £, priced from cached model pricing for its usage — not the authoritative LiteLLM cost (that's captured once per call into the turn-level ledger, not correlated back to a specific step). An estimate for relative step-to-step cost while streaming.
|
|
8086
8163
|
*/
|
|
8087
|
-
|
|
8164
|
+
step_gbp?: number | null;
|
|
8088
8165
|
/**
|
|
8089
8166
|
* Total Tokens
|
|
8090
8167
|
* @description Cumulative tokens across the response so far.
|
|
@@ -10405,7 +10482,7 @@ interface components {
|
|
|
10405
10482
|
};
|
|
10406
10483
|
/**
|
|
10407
10484
|
* ConversationUsageResponse
|
|
10408
|
-
* @description AI usage of one conversation (a thread, or a work item / matter), in
|
|
10485
|
+
* @description AI usage of one conversation (a thread, or a work item / matter), in £ like project usage.
|
|
10409
10486
|
*
|
|
10410
10487
|
* Read from the project's LiteLLM spend logs: every model call is tagged with the conversation it
|
|
10411
10488
|
* serves and, for a work run, the run and the workflow step. A breakdown holds only the calls that
|
|
@@ -10902,6 +10979,11 @@ interface components {
|
|
|
10902
10979
|
is_identity_verified: boolean;
|
|
10903
10980
|
/** Can Create Projects */
|
|
10904
10981
|
can_create_projects: boolean;
|
|
10982
|
+
/**
|
|
10983
|
+
* Is Deployment Admin
|
|
10984
|
+
* @default false
|
|
10985
|
+
*/
|
|
10986
|
+
is_deployment_admin: boolean;
|
|
10905
10987
|
};
|
|
10906
10988
|
/**
|
|
10907
10989
|
* DailyUsage
|
|
@@ -12815,6 +12897,85 @@ interface components {
|
|
|
12815
12897
|
*/
|
|
12816
12898
|
limit: number;
|
|
12817
12899
|
};
|
|
12900
|
+
/**
|
|
12901
|
+
* FirmPoolResponse
|
|
12902
|
+
* @description This month's pool. When ``has_pool`` is false the deployment has no Box licence and the rest is unset.
|
|
12903
|
+
*/
|
|
12904
|
+
FirmPoolResponse: {
|
|
12905
|
+
/**
|
|
12906
|
+
* Has Pool
|
|
12907
|
+
* @default false
|
|
12908
|
+
*/
|
|
12909
|
+
has_pool: boolean;
|
|
12910
|
+
/** Month */
|
|
12911
|
+
month?: string | null;
|
|
12912
|
+
/** Resets At */
|
|
12913
|
+
resets_at?: string | null;
|
|
12914
|
+
/** Licence Status */
|
|
12915
|
+
licence_status?: string | null;
|
|
12916
|
+
/** Expires At */
|
|
12917
|
+
expires_at?: string | null;
|
|
12918
|
+
/**
|
|
12919
|
+
* Premium Only
|
|
12920
|
+
* @default false
|
|
12921
|
+
*/
|
|
12922
|
+
premium_only: boolean;
|
|
12923
|
+
/** Box Seats */
|
|
12924
|
+
box_seats?: number | null;
|
|
12925
|
+
/** Plus Seats */
|
|
12926
|
+
plus_seats?: number | null;
|
|
12927
|
+
/** Ai Addons */
|
|
12928
|
+
ai_addons?: number | null;
|
|
12929
|
+
/** Addon Gbp */
|
|
12930
|
+
addon_gbp?: number | null;
|
|
12931
|
+
/** Base Gbp */
|
|
12932
|
+
base_gbp?: number | null;
|
|
12933
|
+
/** Auto Addons */
|
|
12934
|
+
auto_addons?: number | null;
|
|
12935
|
+
/** Auto Addon Gbp */
|
|
12936
|
+
auto_addon_gbp?: number | null;
|
|
12937
|
+
/** Auto Addon Price Pence */
|
|
12938
|
+
auto_addon_price_pence?: number | null;
|
|
12939
|
+
/** Auto Addon Spent Pence */
|
|
12940
|
+
auto_addon_spent_pence?: number | null;
|
|
12941
|
+
/** Auto Addon Limit Pence */
|
|
12942
|
+
auto_addon_limit_pence?: number | null;
|
|
12943
|
+
/** Total Gbp */
|
|
12944
|
+
total_gbp?: number | null;
|
|
12945
|
+
/** Used Gbp */
|
|
12946
|
+
used_gbp?: number | null;
|
|
12947
|
+
/** Remaining Gbp */
|
|
12948
|
+
remaining_gbp?: number | null;
|
|
12949
|
+
/** People This Month */
|
|
12950
|
+
people_this_month?: number | null;
|
|
12951
|
+
/** Report Computed At */
|
|
12952
|
+
report_computed_at?: string | null;
|
|
12953
|
+
/** Subscription Status */
|
|
12954
|
+
subscription_status?: string | null;
|
|
12955
|
+
/** Cancel At Period End */
|
|
12956
|
+
cancel_at_period_end?: boolean | null;
|
|
12957
|
+
/** Period End */
|
|
12958
|
+
period_end?: string | null;
|
|
12959
|
+
/**
|
|
12960
|
+
* Can Top Up
|
|
12961
|
+
* @default false
|
|
12962
|
+
*/
|
|
12963
|
+
can_top_up: boolean;
|
|
12964
|
+
};
|
|
12965
|
+
/** FirmPoolTopUpRequest */
|
|
12966
|
+
FirmPoolTopUpRequest: {
|
|
12967
|
+
/**
|
|
12968
|
+
* Ai Addons
|
|
12969
|
+
* @description Renewing AI usage add-ons (+£10 of AI usage a month each) to add
|
|
12970
|
+
*/
|
|
12971
|
+
ai_addons: number;
|
|
12972
|
+
};
|
|
12973
|
+
/** FirmPoolTopUpResponse */
|
|
12974
|
+
FirmPoolTopUpResponse: {
|
|
12975
|
+
pool: components['schemas']['FirmPoolResponse'];
|
|
12976
|
+
/** Invoice Url */
|
|
12977
|
+
invoice_url?: string | null;
|
|
12978
|
+
};
|
|
12818
12979
|
/**
|
|
12819
12980
|
* FolderRead
|
|
12820
12981
|
* @description A mail folder (Outlook), label (Gmail), or drive folder/site/library.
|
|
@@ -15173,8 +15334,8 @@ interface components {
|
|
|
15173
15334
|
pro_plus_monthly_ex_vat_pence: number;
|
|
15174
15335
|
/** Pro Plus Period Pence */
|
|
15175
15336
|
pro_plus_period_pence: number;
|
|
15176
|
-
/** Pro Plus
|
|
15177
|
-
|
|
15337
|
+
/** Pro Plus Ai Gbp */
|
|
15338
|
+
pro_plus_ai_gbp: number;
|
|
15178
15339
|
/** Pro Plus Storage Gb */
|
|
15179
15340
|
pro_plus_storage_gb: number;
|
|
15180
15341
|
/**
|
|
@@ -15275,7 +15436,7 @@ interface components {
|
|
|
15275
15436
|
};
|
|
15276
15437
|
/**
|
|
15277
15438
|
* ProjectAddonSettingsRequest
|
|
15278
|
-
* @description The monthly add-on budget (the only add-on setting) and the automatic
|
|
15439
|
+
* @description The monthly add-on budget (the only add-on setting) and the automatic AI usage add-on's trigger.
|
|
15279
15440
|
*
|
|
15280
15441
|
* Automatic add-ons are always on within the budget; ``spend_cap_pence`` = 0 turns add-ons off entirely
|
|
15281
15442
|
* (automatic and manual); null = no limit.
|
|
@@ -15284,10 +15445,10 @@ interface components {
|
|
|
15284
15445
|
/** Spend Cap Pence */
|
|
15285
15446
|
spend_cap_pence?: number | null;
|
|
15286
15447
|
/**
|
|
15287
|
-
* Auto Topup Threshold
|
|
15288
|
-
* @default
|
|
15448
|
+
* Auto Topup Threshold Gbp
|
|
15449
|
+
* @default 1
|
|
15289
15450
|
*/
|
|
15290
|
-
|
|
15451
|
+
auto_topup_threshold_gbp: number;
|
|
15291
15452
|
};
|
|
15292
15453
|
/**
|
|
15293
15454
|
* ProjectAddons
|
|
@@ -15306,26 +15467,26 @@ interface components {
|
|
|
15306
15467
|
* @default Pro
|
|
15307
15468
|
*/
|
|
15308
15469
|
plan_name: string;
|
|
15309
|
-
/** Plan
|
|
15310
|
-
|
|
15470
|
+
/** Plan Ai Gbp */
|
|
15471
|
+
plan_ai_gbp: number;
|
|
15311
15472
|
/** Plan Storage Gb */
|
|
15312
15473
|
plan_storage_gb: number;
|
|
15313
|
-
/** Block
|
|
15314
|
-
|
|
15474
|
+
/** Block Ai Gbp */
|
|
15475
|
+
block_ai_gbp: number;
|
|
15315
15476
|
/** Block Storage Gb */
|
|
15316
15477
|
block_storage_gb: number;
|
|
15317
15478
|
/**
|
|
15318
|
-
*
|
|
15479
|
+
* Ai Blocks
|
|
15319
15480
|
* @default 0
|
|
15320
15481
|
*/
|
|
15321
|
-
|
|
15482
|
+
ai_blocks: number;
|
|
15322
15483
|
/**
|
|
15323
15484
|
* Storage Blocks
|
|
15324
15485
|
* @default 0
|
|
15325
15486
|
*/
|
|
15326
15487
|
storage_blocks: number;
|
|
15327
|
-
/**
|
|
15328
|
-
|
|
15488
|
+
/** Ai Blocks Next */
|
|
15489
|
+
ai_blocks_next?: number | null;
|
|
15329
15490
|
/** Storage Blocks Next */
|
|
15330
15491
|
storage_blocks_next?: number | null;
|
|
15331
15492
|
/**
|
|
@@ -15334,15 +15495,15 @@ interface components {
|
|
|
15334
15495
|
*/
|
|
15335
15496
|
storage_blocks_min: number;
|
|
15336
15497
|
/**
|
|
15337
|
-
* Auto Topup Threshold
|
|
15338
|
-
* @default
|
|
15498
|
+
* Auto Topup Threshold Gbp
|
|
15499
|
+
* @default 1
|
|
15339
15500
|
*/
|
|
15340
|
-
|
|
15501
|
+
auto_topup_threshold_gbp: number;
|
|
15341
15502
|
/**
|
|
15342
|
-
* Min Auto Topup Threshold
|
|
15343
|
-
* @default
|
|
15503
|
+
* Min Auto Topup Threshold Gbp
|
|
15504
|
+
* @default 1
|
|
15344
15505
|
*/
|
|
15345
|
-
|
|
15506
|
+
min_auto_topup_threshold_gbp: number;
|
|
15346
15507
|
/** Spend Cap Pence */
|
|
15347
15508
|
spend_cap_pence?: number | null;
|
|
15348
15509
|
/**
|
|
@@ -15352,18 +15513,26 @@ interface components {
|
|
|
15352
15513
|
addon_spend_pence: number;
|
|
15353
15514
|
/** Addon Spend Window End */
|
|
15354
15515
|
addon_spend_window_end?: number | null;
|
|
15355
|
-
/** Block Monthly Pence */
|
|
15356
|
-
|
|
15357
|
-
/** Block Monthly Ex Vat Pence */
|
|
15358
|
-
|
|
15359
|
-
/** Block
|
|
15360
|
-
|
|
15361
|
-
/** Block
|
|
15362
|
-
|
|
15363
|
-
/**
|
|
15364
|
-
|
|
15365
|
-
/**
|
|
15366
|
-
|
|
15516
|
+
/** Ai Block Monthly Pence */
|
|
15517
|
+
ai_block_monthly_pence: number;
|
|
15518
|
+
/** Ai Block Monthly Ex Vat Pence */
|
|
15519
|
+
ai_block_monthly_ex_vat_pence: number;
|
|
15520
|
+
/** Storage Block Monthly Pence */
|
|
15521
|
+
storage_block_monthly_pence: number;
|
|
15522
|
+
/** Storage Block Monthly Ex Vat Pence */
|
|
15523
|
+
storage_block_monthly_ex_vat_pence: number;
|
|
15524
|
+
/** Ai Block Period Pence */
|
|
15525
|
+
ai_block_period_pence: number;
|
|
15526
|
+
/** Ai Block Period Ex Vat Pence */
|
|
15527
|
+
ai_block_period_ex_vat_pence: number;
|
|
15528
|
+
/** Storage Block Period Pence */
|
|
15529
|
+
storage_block_period_pence: number;
|
|
15530
|
+
/** Storage Block Period Ex Vat Pence */
|
|
15531
|
+
storage_block_period_ex_vat_pence: number;
|
|
15532
|
+
/** Ai Block Price Pence */
|
|
15533
|
+
ai_block_price_pence: number;
|
|
15534
|
+
/** Ai Block Price Ex Vat Pence */
|
|
15535
|
+
ai_block_price_ex_vat_pence: number;
|
|
15367
15536
|
/** Storage Block Price Pence */
|
|
15368
15537
|
storage_block_price_pence: number;
|
|
15369
15538
|
/** Storage Block Price Ex Vat Pence */
|
|
@@ -15375,8 +15544,8 @@ interface components {
|
|
|
15375
15544
|
cap_reached: boolean;
|
|
15376
15545
|
/** Period End */
|
|
15377
15546
|
period_end?: number | null;
|
|
15378
|
-
/**
|
|
15379
|
-
|
|
15547
|
+
/** Ai Usage Reset At */
|
|
15548
|
+
ai_usage_reset_at?: number | null;
|
|
15380
15549
|
/** Pending Interval */
|
|
15381
15550
|
pending_interval?: ('month' | 'year') | null;
|
|
15382
15551
|
/** Billing Error */
|
|
@@ -15437,7 +15606,7 @@ interface components {
|
|
|
15437
15606
|
};
|
|
15438
15607
|
/**
|
|
15439
15608
|
* ProjectConversationUsageResponse
|
|
15440
|
-
* @description A project's AI usage by conversation for a billing period, in
|
|
15609
|
+
* @description A project's AI usage by conversation for a billing period, in £ like project usage.
|
|
15441
15610
|
*/
|
|
15442
15611
|
ProjectConversationUsageResponse: {
|
|
15443
15612
|
/** Project Ext Id */
|
|
@@ -15585,8 +15754,8 @@ interface components {
|
|
|
15585
15754
|
* Omit (null) a kind to leave it unchanged. No refund: this period's blocks stay until it ends.
|
|
15586
15755
|
*/
|
|
15587
15756
|
ProjectNextPeriodAddonsRequest: {
|
|
15588
|
-
/**
|
|
15589
|
-
|
|
15757
|
+
/** Ai Blocks */
|
|
15758
|
+
ai_blocks?: number | null;
|
|
15590
15759
|
/** Storage Blocks */
|
|
15591
15760
|
storage_blocks?: number | null;
|
|
15592
15761
|
};
|
|
@@ -15621,7 +15790,7 @@ interface components {
|
|
|
15621
15790
|
*/
|
|
15622
15791
|
ProjectQuotas: {
|
|
15623
15792
|
storage_gb: components['schemas']['QuotaUsage'];
|
|
15624
|
-
|
|
15793
|
+
ai_usage: components['schemas']['QuotaUsage'];
|
|
15625
15794
|
collaborators: components['schemas']['QuotaUsage'];
|
|
15626
15795
|
/** Budget Reset At */
|
|
15627
15796
|
budget_reset_at?: number | null;
|
|
@@ -15877,7 +16046,7 @@ interface components {
|
|
|
15877
16046
|
};
|
|
15878
16047
|
/**
|
|
15879
16048
|
* QuotaUsage
|
|
15880
|
-
* @description Single quota metric: current usage vs limit.
|
|
16049
|
+
* @description Single quota metric: current usage vs limit (AI usage in £, 2 dp).
|
|
15881
16050
|
*/
|
|
15882
16051
|
QuotaUsage: {
|
|
15883
16052
|
/** Used */
|
|
@@ -15891,10 +16060,10 @@ interface components {
|
|
|
15891
16060
|
*/
|
|
15892
16061
|
QuoteAddons: {
|
|
15893
16062
|
/**
|
|
15894
|
-
*
|
|
16063
|
+
* Ai Usage
|
|
15895
16064
|
* @default 0
|
|
15896
16065
|
*/
|
|
15897
|
-
|
|
16066
|
+
ai_usage: number;
|
|
15898
16067
|
/**
|
|
15899
16068
|
* Storage
|
|
15900
16069
|
* @default 0
|
|
@@ -18569,15 +18738,18 @@ interface components {
|
|
|
18569
18738
|
};
|
|
18570
18739
|
/**
|
|
18571
18740
|
* TableView
|
|
18572
|
-
* @description Saved column configuration for the document table.
|
|
18741
|
+
* @description Saved column configuration for a workspace table: the document table, or a database's grid.
|
|
18573
18742
|
*
|
|
18574
18743
|
* Column ID formats:
|
|
18575
18744
|
* - Standard columns: "doc_date", "title", "file_name", "status", "n_pages", "created_at"
|
|
18576
18745
|
* - Tags: tag external ID (e.g., "tag-a1b2c3d4")
|
|
18746
|
+
* - Database columns: the database's column ids
|
|
18577
18747
|
*/
|
|
18578
18748
|
TableView: {
|
|
18579
18749
|
/** Workspace */
|
|
18580
18750
|
workspace: string;
|
|
18751
|
+
/** Table */
|
|
18752
|
+
table?: string | null;
|
|
18581
18753
|
/** Name */
|
|
18582
18754
|
name: string;
|
|
18583
18755
|
/** Columns */
|
|
@@ -19227,15 +19399,15 @@ interface components {
|
|
|
19227
19399
|
*/
|
|
19228
19400
|
total_cost?: number | null;
|
|
19229
19401
|
/**
|
|
19230
|
-
*
|
|
19231
|
-
* @description AI
|
|
19402
|
+
* Spent Gbp
|
|
19403
|
+
* @description £ of AI usage spent so far this turn, priced per LLM call using each call's own model — unlike total_cost above (single-rate, main query LLM only), this is correct across a turn that mixes models (agent LLM, deep_research/spawn_coding_agent child LLMs, evaluator, judge). Updates live as the turn progresses, not just a final total.
|
|
19232
19404
|
*/
|
|
19233
|
-
|
|
19405
|
+
spent_gbp?: number | null;
|
|
19234
19406
|
/**
|
|
19235
|
-
*
|
|
19236
|
-
* @description This turn's shared
|
|
19407
|
+
* Budget Gbp
|
|
19408
|
+
* @description This turn's shared AI usage budget in £ (AGENT_TURN_BUDGET_GBP) — same value across the parent and every child it spawns. Absent when uncapped (budget=0).
|
|
19237
19409
|
*/
|
|
19238
|
-
|
|
19410
|
+
budget_gbp?: number | null;
|
|
19239
19411
|
/**
|
|
19240
19412
|
* Elapsed Seconds
|
|
19241
19413
|
* @description Wall-clock time for the LLM call(s)
|
|
@@ -19844,11 +20016,11 @@ interface components {
|
|
|
19844
20016
|
};
|
|
19845
20017
|
/**
|
|
19846
20018
|
* UserDailyUsageResponse
|
|
19847
|
-
* @description Today's deployment-wide
|
|
20019
|
+
* @description Today's deployment-wide AI usage (£) tagged with the current user.
|
|
19848
20020
|
*/
|
|
19849
20021
|
UserDailyUsageResponse: {
|
|
19850
|
-
/**
|
|
19851
|
-
|
|
20022
|
+
/** Used Gbp */
|
|
20023
|
+
used_gbp: number;
|
|
19852
20024
|
};
|
|
19853
20025
|
/**
|
|
19854
20026
|
* UserInputBody
|
|
@@ -20858,6 +21030,8 @@ interface components {
|
|
|
20858
21030
|
project_subscription?: string | null;
|
|
20859
21031
|
/** Project Owner Ext Id */
|
|
20860
21032
|
project_owner_ext_id?: string | null;
|
|
21033
|
+
/** House Template Ext Id */
|
|
21034
|
+
house_template_ext_id?: string | null;
|
|
20861
21035
|
};
|
|
20862
21036
|
/**
|
|
20863
21037
|
* WorkspaceRole
|
|
@@ -20898,6 +21072,8 @@ interface components {
|
|
|
20898
21072
|
workspace_type?: components['schemas']['WorkspaceType'] | null;
|
|
20899
21073
|
/** Project Ext Id */
|
|
20900
21074
|
project_ext_id?: string | null;
|
|
21075
|
+
/** House Template Ext Id */
|
|
21076
|
+
house_template_ext_id?: string | null;
|
|
20901
21077
|
};
|
|
20902
21078
|
/**
|
|
20903
21079
|
* WorkspaceUserResponse
|
|
@@ -21580,7 +21756,7 @@ interface operations {
|
|
|
21580
21756
|
};
|
|
21581
21757
|
};
|
|
21582
21758
|
};
|
|
21583
|
-
|
|
21759
|
+
add_project_ai_block: {
|
|
21584
21760
|
parameters: {
|
|
21585
21761
|
query?: never;
|
|
21586
21762
|
header?: never;
|
|
@@ -22518,6 +22694,59 @@ interface operations {
|
|
|
22518
22694
|
};
|
|
22519
22695
|
};
|
|
22520
22696
|
};
|
|
22697
|
+
get_firm_pool: {
|
|
22698
|
+
parameters: {
|
|
22699
|
+
query?: never;
|
|
22700
|
+
header?: never;
|
|
22701
|
+
path?: never;
|
|
22702
|
+
cookie?: never;
|
|
22703
|
+
};
|
|
22704
|
+
requestBody?: never;
|
|
22705
|
+
responses: {
|
|
22706
|
+
/** @description Successful Response */
|
|
22707
|
+
200: {
|
|
22708
|
+
headers: {
|
|
22709
|
+
[name: string]: unknown;
|
|
22710
|
+
};
|
|
22711
|
+
content: {
|
|
22712
|
+
'application/json': components['schemas']['FirmPoolResponse'];
|
|
22713
|
+
};
|
|
22714
|
+
};
|
|
22715
|
+
};
|
|
22716
|
+
};
|
|
22717
|
+
top_up_firm_pool: {
|
|
22718
|
+
parameters: {
|
|
22719
|
+
query?: never;
|
|
22720
|
+
header?: never;
|
|
22721
|
+
path?: never;
|
|
22722
|
+
cookie?: never;
|
|
22723
|
+
};
|
|
22724
|
+
requestBody: {
|
|
22725
|
+
content: {
|
|
22726
|
+
'application/json': components['schemas']['FirmPoolTopUpRequest'];
|
|
22727
|
+
};
|
|
22728
|
+
};
|
|
22729
|
+
responses: {
|
|
22730
|
+
/** @description Successful Response */
|
|
22731
|
+
200: {
|
|
22732
|
+
headers: {
|
|
22733
|
+
[name: string]: unknown;
|
|
22734
|
+
};
|
|
22735
|
+
content: {
|
|
22736
|
+
'application/json': components['schemas']['FirmPoolTopUpResponse'];
|
|
22737
|
+
};
|
|
22738
|
+
};
|
|
22739
|
+
/** @description Validation Error */
|
|
22740
|
+
422: {
|
|
22741
|
+
headers: {
|
|
22742
|
+
[name: string]: unknown;
|
|
22743
|
+
};
|
|
22744
|
+
content: {
|
|
22745
|
+
'application/json': components['schemas']['HTTPValidationError'];
|
|
22746
|
+
};
|
|
22747
|
+
};
|
|
22748
|
+
};
|
|
22749
|
+
};
|
|
22521
22750
|
get_identity_verification: {
|
|
22522
22751
|
parameters: {
|
|
22523
22752
|
query?: never;
|
|
@@ -25893,6 +26122,80 @@ interface operations {
|
|
|
25893
26122
|
};
|
|
25894
26123
|
};
|
|
25895
26124
|
};
|
|
26125
|
+
get_deployment_house_template: {
|
|
26126
|
+
parameters: {
|
|
26127
|
+
query?: never;
|
|
26128
|
+
header?: never;
|
|
26129
|
+
path?: never;
|
|
26130
|
+
cookie?: never;
|
|
26131
|
+
};
|
|
26132
|
+
requestBody?: never;
|
|
26133
|
+
responses: {
|
|
26134
|
+
/** @description The house template file */
|
|
26135
|
+
200: {
|
|
26136
|
+
headers: {
|
|
26137
|
+
[name: string]: unknown;
|
|
26138
|
+
};
|
|
26139
|
+
content: {
|
|
26140
|
+
'application/vnd.openxmlformats-officedocument.wordprocessingml.document': string;
|
|
26141
|
+
'application/vnd.openxmlformats-officedocument.wordprocessingml.template': string;
|
|
26142
|
+
};
|
|
26143
|
+
};
|
|
26144
|
+
/** @description No deployment house template is set */
|
|
26145
|
+
404: {
|
|
26146
|
+
headers: {
|
|
26147
|
+
[name: string]: unknown;
|
|
26148
|
+
};
|
|
26149
|
+
content?: never;
|
|
26150
|
+
};
|
|
26151
|
+
};
|
|
26152
|
+
};
|
|
26153
|
+
set_deployment_house_template: {
|
|
26154
|
+
parameters: {
|
|
26155
|
+
query?: never;
|
|
26156
|
+
header?: never;
|
|
26157
|
+
path?: never;
|
|
26158
|
+
cookie?: never;
|
|
26159
|
+
};
|
|
26160
|
+
requestBody: {
|
|
26161
|
+
content: {
|
|
26162
|
+
'multipart/form-data': {
|
|
26163
|
+
/**
|
|
26164
|
+
* Format: binary
|
|
26165
|
+
* @description The .dotx or .docx
|
|
26166
|
+
*/
|
|
26167
|
+
file: string;
|
|
26168
|
+
};
|
|
26169
|
+
};
|
|
26170
|
+
};
|
|
26171
|
+
responses: {
|
|
26172
|
+
/** @description Successful Response */
|
|
26173
|
+
204: {
|
|
26174
|
+
headers: {
|
|
26175
|
+
[name: string]: unknown;
|
|
26176
|
+
};
|
|
26177
|
+
content?: never;
|
|
26178
|
+
};
|
|
26179
|
+
};
|
|
26180
|
+
};
|
|
26181
|
+
delete_deployment_house_template: {
|
|
26182
|
+
parameters: {
|
|
26183
|
+
query?: never;
|
|
26184
|
+
header?: never;
|
|
26185
|
+
path?: never;
|
|
26186
|
+
cookie?: never;
|
|
26187
|
+
};
|
|
26188
|
+
requestBody?: never;
|
|
26189
|
+
responses: {
|
|
26190
|
+
/** @description Successful Response */
|
|
26191
|
+
204: {
|
|
26192
|
+
headers: {
|
|
26193
|
+
[name: string]: unknown;
|
|
26194
|
+
};
|
|
26195
|
+
content?: never;
|
|
26196
|
+
};
|
|
26197
|
+
};
|
|
26198
|
+
};
|
|
25896
26199
|
list_tags: {
|
|
25897
26200
|
parameters: {
|
|
25898
26201
|
query?: {
|