@inferencesh/sdk 0.19.0 → 0.20.1
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/api/tasks.d.ts +15 -3
- package/dist/api/tasks.js +19 -3
- package/dist/types.d.ts +669 -42
- package/dist/types.js +345 -0
- package/package.json +2 -2
package/dist/types.d.ts
CHANGED
|
@@ -481,6 +481,12 @@ export interface CreateAppRequest {
|
|
|
481
481
|
agent_description?: string;
|
|
482
482
|
category?: AppCategory;
|
|
483
483
|
images?: AppImages;
|
|
484
|
+
/**
|
|
485
|
+
* Tags replace the app's tags when given; omitted, a deploy takes them
|
|
486
|
+
* from the version's metadata.tags, and keeps the stored ones if that is
|
|
487
|
+
* empty too.
|
|
488
|
+
*/
|
|
489
|
+
tags?: string[];
|
|
484
490
|
version?: AppVersionInput;
|
|
485
491
|
preserve_current_version?: boolean;
|
|
486
492
|
}
|
|
@@ -1220,11 +1226,33 @@ export interface AppDTO extends BaseModelDTO, PermissionModelDTO {
|
|
|
1220
1226
|
agent_description: string;
|
|
1221
1227
|
category: AppCategory;
|
|
1222
1228
|
images: AppImages;
|
|
1229
|
+
/**
|
|
1230
|
+
* Tags name what the app does and its traits, as lowercase slugs. Known
|
|
1231
|
+
* slugs are the shared.AppTag constants; others are free-form.
|
|
1232
|
+
*/
|
|
1233
|
+
tags: string[];
|
|
1223
1234
|
version_id: string;
|
|
1224
1235
|
version?: AppVersionDTO;
|
|
1225
1236
|
status: AppStatus;
|
|
1226
1237
|
status_message?: string;
|
|
1227
1238
|
status_changed_at?: string;
|
|
1239
|
+
/**
|
|
1240
|
+
* ResolvedFunction is the function the requested ref named, when it named
|
|
1241
|
+
* one: "ns/app:fn" in the ref itself, or a route on the name that pins a
|
|
1242
|
+
* function (a retired dialogue app routed to "ns/new-app:dialogue"). Only
|
|
1243
|
+
* set on a lookup by ref; empty means the caller picks, starting from the
|
|
1244
|
+
* version's default.
|
|
1245
|
+
*/
|
|
1246
|
+
resolved_function?: string;
|
|
1247
|
+
}
|
|
1248
|
+
/**
|
|
1249
|
+
* AppUIRef names the artifact an app version renders as its UI: a page a
|
|
1250
|
+
* host shows beside the task in place of the generic output view. Artifact
|
|
1251
|
+
* is a ref ("ns/name", or "ns/name@version" to pin one) or an artifact id;
|
|
1252
|
+
* an unpinned ref follows the artifact's current version.
|
|
1253
|
+
*/
|
|
1254
|
+
export interface AppUIRef {
|
|
1255
|
+
artifact: string;
|
|
1228
1256
|
}
|
|
1229
1257
|
/**
|
|
1230
1258
|
* AppVersionDTO is the API response for an app version.
|
|
@@ -1233,6 +1261,10 @@ export interface AppVersionDTO extends BaseModelDTO {
|
|
|
1233
1261
|
metadata: {
|
|
1234
1262
|
[key: string]: any;
|
|
1235
1263
|
};
|
|
1264
|
+
/**
|
|
1265
|
+
* UI mirrors metadata.ui so clients need not dig through the map.
|
|
1266
|
+
*/
|
|
1267
|
+
ui?: AppUIRef;
|
|
1236
1268
|
repository: string;
|
|
1237
1269
|
flow_version_id?: string;
|
|
1238
1270
|
flow_version?: FlowVersionDTO;
|
|
@@ -1706,11 +1738,16 @@ export interface BountyProgramDTO extends BaseModelDTO, PermissionModelDTO {
|
|
|
1706
1738
|
max_per_user: number;
|
|
1707
1739
|
max_per_day: number;
|
|
1708
1740
|
proof_type: string;
|
|
1709
|
-
|
|
1741
|
+
/**
|
|
1742
|
+
* ProofForm is the form (namespace/name) a "form" program takes a
|
|
1743
|
+
* submission to as proof; empty for every other proof type.
|
|
1744
|
+
*/
|
|
1745
|
+
proof_form: string;
|
|
1710
1746
|
/**
|
|
1711
1747
|
* RequiresPaymentMethod withholds the reward until the claimant's team has
|
|
1712
|
-
* a saved payment method. The claim
|
|
1713
|
-
* payment_method_required
|
|
1748
|
+
* a saved payment method. The claim is refused with 402
|
|
1749
|
+
* payment_method_required and no claim is recorded, so it can be retried
|
|
1750
|
+
* once a card is on file.
|
|
1714
1751
|
*/
|
|
1715
1752
|
requires_payment_method: boolean;
|
|
1716
1753
|
status: string;
|
|
@@ -1732,7 +1769,10 @@ export interface BountySubmissionDTO extends BaseModelDTO, PermissionModelDTO {
|
|
|
1732
1769
|
source?: string;
|
|
1733
1770
|
}
|
|
1734
1771
|
/**
|
|
1735
|
-
* SubmitBountyRequest is used to claim a bounty reward.
|
|
1772
|
+
* SubmitBountyRequest is used to claim a bounty reward. proof_id names the
|
|
1773
|
+
* proof the program's proof_type asks for: an app (id or namespace/name) for
|
|
1774
|
+
* "app", one of the caller's form submission ids for "form", free text
|
|
1775
|
+
* otherwise.
|
|
1736
1776
|
*/
|
|
1737
1777
|
export interface SubmitBountyRequest {
|
|
1738
1778
|
bounty_id: string;
|
|
@@ -1876,6 +1916,13 @@ export interface ChatMessageDTO extends BaseModelDTO, PermissionModelDTO {
|
|
|
1876
1916
|
export interface PolicyRuleDTO {
|
|
1877
1917
|
id: string;
|
|
1878
1918
|
effect: PolicyEffect;
|
|
1919
|
+
/**
|
|
1920
|
+
* Enforcement: default (decides unless a more specific admin layer has
|
|
1921
|
+
* a rule matching the call), enforced (an admin rule that is final),
|
|
1922
|
+
* evaluate (never decides; the decision feed shows what it would have
|
|
1923
|
+
* done) or disabled (kept, ignored).
|
|
1924
|
+
*/
|
|
1925
|
+
enforcement: PolicyEnforcement;
|
|
1879
1926
|
/**
|
|
1880
1927
|
* Kind: what the rule governs (RemoteExec, Workspace, Harness, Tool,
|
|
1881
1928
|
* and the usage kinds App, Agent, Knowledge, Mcp, Flow).
|
|
@@ -1890,12 +1937,15 @@ export interface PolicyRuleDTO {
|
|
|
1890
1937
|
* Specifier is the kind's pattern: a command (`npm test`, `git push:*`),
|
|
1891
1938
|
* a folder (`~/proj/**`), a harness tool with its pattern
|
|
1892
1939
|
* (`Bash(git status:*)`, `Edit`), or a loop tool's name. Empty is the
|
|
1893
|
-
* whole kind.
|
|
1940
|
+
* whole kind. A usage kind's names a resource by id, or everything a
|
|
1941
|
+
* publisher owns as publisher:<team id>.
|
|
1894
1942
|
*/
|
|
1895
1943
|
specifier: string;
|
|
1896
1944
|
/**
|
|
1897
1945
|
* Label is the rule in words, e.g. "git commit commands on Laptop", the
|
|
1898
|
-
* same words an approval prompt's "always allow" options use.
|
|
1946
|
+
* same words an approval prompt's "always allow" options use. A usage
|
|
1947
|
+
* rule's is the name it was written with ("bytedance/seedance",
|
|
1948
|
+
* "bytedance/*").
|
|
1899
1949
|
*/
|
|
1900
1950
|
label: string;
|
|
1901
1951
|
/**
|
|
@@ -2332,17 +2382,63 @@ export interface EntitlementErrorMeta {
|
|
|
2332
2382
|
limit?: number;
|
|
2333
2383
|
current?: number;
|
|
2334
2384
|
upgrade_available: boolean;
|
|
2385
|
+
requestable: boolean;
|
|
2386
|
+
request_state?: string;
|
|
2335
2387
|
addon_plan_id?: string;
|
|
2336
2388
|
addon_plan_name?: string;
|
|
2337
2389
|
addon_plan_price?: number;
|
|
2338
2390
|
}
|
|
2391
|
+
/**
|
|
2392
|
+
* EntitlementRequestDTO is a team's request for an entitlement, with the
|
|
2393
|
+
* form submission that came with it when there was one, so the admin queue
|
|
2394
|
+
* shows the answers next to the decision.
|
|
2395
|
+
*/
|
|
2396
|
+
export interface EntitlementRequestDTO extends BaseModelDTO, PermissionModelDTO {
|
|
2397
|
+
resource: EntitlementResource;
|
|
2398
|
+
resource_label?: string;
|
|
2399
|
+
requested: any;
|
|
2400
|
+
submission_id?: string;
|
|
2401
|
+
submission?: FormSubmissionDTO;
|
|
2402
|
+
state: EntitlementRequestState;
|
|
2403
|
+
decided_by?: string;
|
|
2404
|
+
decided_at?: string;
|
|
2405
|
+
note?: string;
|
|
2406
|
+
}
|
|
2407
|
+
/**
|
|
2408
|
+
* EntitlementRequested is the shape of a request's "requested" field and of
|
|
2409
|
+
* the grant an acceptance makes: a boolean gate switched on, or a limit.
|
|
2410
|
+
*/
|
|
2411
|
+
export interface EntitlementRequested {
|
|
2412
|
+
type: EntitlementType;
|
|
2413
|
+
enabled?: boolean;
|
|
2414
|
+
limit?: number;
|
|
2415
|
+
}
|
|
2416
|
+
/**
|
|
2417
|
+
* CreateEntitlementRequestRequest asks for a resource on behalf of the
|
|
2418
|
+
* caller's team. requested defaults to a switched-on boolean gate. form
|
|
2419
|
+
* (namespace/name or id) with data submits that form first and attaches
|
|
2420
|
+
* the submission; the form's own policy and validation errors apply.
|
|
2421
|
+
*/
|
|
2422
|
+
export interface CreateEntitlementRequestRequest {
|
|
2423
|
+
resource: EntitlementResource;
|
|
2424
|
+
requested?: any;
|
|
2425
|
+
form?: string;
|
|
2426
|
+
data?: any;
|
|
2427
|
+
}
|
|
2428
|
+
/**
|
|
2429
|
+
* DecideEntitlementRequestRequest is an admin's accept or decline; the note
|
|
2430
|
+
* reaches the requester by email.
|
|
2431
|
+
*/
|
|
2432
|
+
export interface DecideEntitlementRequestRequest {
|
|
2433
|
+
note?: string;
|
|
2434
|
+
}
|
|
2339
2435
|
/**
|
|
2340
2436
|
* ErrorCode is the machine-readable error code of an API error: the last
|
|
2341
2437
|
* segment of the problem+json type URI (https://api.inference.sh/errors/<code>)
|
|
2342
2438
|
* and APIError.Code on the legacy envelope. Clients branch on these, so a
|
|
2343
2439
|
* code is a named const here, where it generates into models and the SDKs.
|
|
2344
2440
|
*/
|
|
2345
|
-
export type ErrorCode = "invalid_request" | "validation_error" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "name_conflict" | "already_exists" | "not_configured" | "method_not_allowed" | "rate_limited" | "internal_error" | "team_role_required" | "blocked_by_usage_policy" | "last_owner" | "account_deactivated" | "account_banned" | "person_required" | "otp_required" | "mcp_auth_expired" | "limit_exceeded" | "feature_not_available" | "entitlement_unavailable" | "payment_required" | "payment_method_required" | "agents_disabled" | "remote_offline" | "remote_timeout" | "harness_not_drivable" | "harness_too_old";
|
|
2441
|
+
export type ErrorCode = "invalid_request" | "validation_error" | "unauthorized" | "forbidden" | "not_found" | "conflict" | "name_conflict" | "already_exists" | "not_configured" | "method_not_allowed" | "rate_limited" | "internal_error" | "team_role_required" | "blocked_by_usage_policy" | "last_owner" | "account_deactivated" | "account_banned" | "person_required" | "otp_required" | "mcp_auth_expired" | "limit_exceeded" | "feature_not_available" | "entitlement_unavailable" | "payment_required" | "payment_method_required" | "form_closed" | "already_submitted" | "already_claimed" | "already_entitled" | "request_open" | "agents_disabled" | "remote_offline" | "remote_timeout" | "harness_not_drivable" | "harness_too_old";
|
|
2346
2442
|
export declare const ErrorCodeInvalidRequest: ErrorCode;
|
|
2347
2443
|
export declare const ErrorCodeValidationError: ErrorCode;
|
|
2348
2444
|
export declare const ErrorCodeUnauthorized: ErrorCode;
|
|
@@ -2402,6 +2498,23 @@ export declare const ErrorCodePaymentRequired: ErrorCode;
|
|
|
2402
2498
|
* PaymentMethodRequiredMeta; clients send the user to BillingPage.
|
|
2403
2499
|
*/
|
|
2404
2500
|
export declare const ErrorCodePaymentMethodRequired: ErrorCode;
|
|
2501
|
+
/**
|
|
2502
|
+
* Form submissions (409): the form is not open, or its submit policy
|
|
2503
|
+
* already holds the caller's submission.
|
|
2504
|
+
*/
|
|
2505
|
+
export declare const ErrorCodeFormClosed: ErrorCode;
|
|
2506
|
+
export declare const ErrorCodeAlreadySubmitted: ErrorCode;
|
|
2507
|
+
/**
|
|
2508
|
+
* Bounty claims (409): the caller already claimed this proof, or as many
|
|
2509
|
+
* times as the program allows.
|
|
2510
|
+
*/
|
|
2511
|
+
export declare const ErrorCodeAlreadyClaimed: ErrorCode;
|
|
2512
|
+
/**
|
|
2513
|
+
* Entitlement requests (409): the team already holds the entitlement, or
|
|
2514
|
+
* already has an open request for it.
|
|
2515
|
+
*/
|
|
2516
|
+
export declare const ErrorCodeAlreadyEntitled: ErrorCode;
|
|
2517
|
+
export declare const ErrorCodeRequestOpen: ErrorCode;
|
|
2405
2518
|
/**
|
|
2406
2519
|
* Remote harness refusals.
|
|
2407
2520
|
*/
|
|
@@ -2457,6 +2570,38 @@ export interface FileDTO extends BaseModelDTO, PermissionModelDTO {
|
|
|
2457
2570
|
rating: ContentRating;
|
|
2458
2571
|
metadata?: FileMetadata;
|
|
2459
2572
|
}
|
|
2573
|
+
/**
|
|
2574
|
+
* TaskFileRole says how a task relates to a file.
|
|
2575
|
+
*/
|
|
2576
|
+
export type TaskFileRole = "input" | "output";
|
|
2577
|
+
export declare const TaskFileRoleInput: TaskFileRole;
|
|
2578
|
+
export declare const TaskFileRoleOutput: TaskFileRole;
|
|
2579
|
+
/**
|
|
2580
|
+
* TaskFileDTO is one file attached to a task, as GET /tasks/{id}/files lists it.
|
|
2581
|
+
*/
|
|
2582
|
+
export interface TaskFileDTO {
|
|
2583
|
+
id: string;
|
|
2584
|
+
created_at: string;
|
|
2585
|
+
role: TaskFileRole;
|
|
2586
|
+
uri: string;
|
|
2587
|
+
filename: string;
|
|
2588
|
+
content_type: string;
|
|
2589
|
+
size: number;
|
|
2590
|
+
}
|
|
2591
|
+
/**
|
|
2592
|
+
* TaskFileSkipped is a file DELETE /tasks/{id}/files left in place.
|
|
2593
|
+
*/
|
|
2594
|
+
export interface TaskFileSkipped {
|
|
2595
|
+
id: string;
|
|
2596
|
+
reason: string;
|
|
2597
|
+
}
|
|
2598
|
+
/**
|
|
2599
|
+
* DeleteTaskFilesResponse reports what DELETE /tasks/{id}/files did.
|
|
2600
|
+
*/
|
|
2601
|
+
export interface DeleteTaskFilesResponse {
|
|
2602
|
+
deleted: string[];
|
|
2603
|
+
skipped: TaskFileSkipped[];
|
|
2604
|
+
}
|
|
2460
2605
|
/**
|
|
2461
2606
|
* FlowNodeData describes a node's data within a flow
|
|
2462
2607
|
*/
|
|
@@ -2739,6 +2884,100 @@ export interface RenameOutputFieldPayload {
|
|
|
2739
2884
|
old_field: string;
|
|
2740
2885
|
new_field: string;
|
|
2741
2886
|
}
|
|
2887
|
+
/**
|
|
2888
|
+
* FormDTO is the API representation of a form: a JSON Schema plus the
|
|
2889
|
+
* settings that say who may submit, and how often.
|
|
2890
|
+
*/
|
|
2891
|
+
export interface FormDTO extends BaseModelDTO, PermissionModelDTO {
|
|
2892
|
+
namespace: string;
|
|
2893
|
+
name: string;
|
|
2894
|
+
title: string;
|
|
2895
|
+
description: string;
|
|
2896
|
+
schema: any;
|
|
2897
|
+
status: FormStatus;
|
|
2898
|
+
submit_policy: FormSubmitPolicy;
|
|
2899
|
+
}
|
|
2900
|
+
/**
|
|
2901
|
+
* FormSubmissionDTO is one set of answers to a form.
|
|
2902
|
+
*/
|
|
2903
|
+
export interface FormSubmissionDTO extends BaseModelDTO, PermissionModelDTO {
|
|
2904
|
+
form_id: string;
|
|
2905
|
+
form_team_id: string;
|
|
2906
|
+
submitter_team_id?: string;
|
|
2907
|
+
data: any;
|
|
2908
|
+
source?: string;
|
|
2909
|
+
agent?: string;
|
|
2910
|
+
context?: string;
|
|
2911
|
+
}
|
|
2912
|
+
/**
|
|
2913
|
+
* CreateFormRequest creates a form in the caller's team namespace. The name
|
|
2914
|
+
* is the immutable slug behind GET /forms/{namespace}/{name}.
|
|
2915
|
+
*/
|
|
2916
|
+
export interface CreateFormRequest {
|
|
2917
|
+
name: string;
|
|
2918
|
+
title: string;
|
|
2919
|
+
description?: string;
|
|
2920
|
+
schema?: any;
|
|
2921
|
+
submit_policy?: FormSubmitPolicy;
|
|
2922
|
+
visibility?: Visibility;
|
|
2923
|
+
}
|
|
2924
|
+
/**
|
|
2925
|
+
* UpdateFormRequest patches a form; nil fields are left as they are.
|
|
2926
|
+
*/
|
|
2927
|
+
export interface UpdateFormRequest {
|
|
2928
|
+
title?: string;
|
|
2929
|
+
description?: string;
|
|
2930
|
+
schema?: any;
|
|
2931
|
+
status?: FormStatus;
|
|
2932
|
+
submit_policy?: FormSubmitPolicy;
|
|
2933
|
+
}
|
|
2934
|
+
/**
|
|
2935
|
+
* SubmitFormRequest is one person's answers to a form. data is validated
|
|
2936
|
+
* against the form's schema.
|
|
2937
|
+
*/
|
|
2938
|
+
export interface SubmitFormRequest {
|
|
2939
|
+
data: any;
|
|
2940
|
+
source?: string;
|
|
2941
|
+
agent?: string;
|
|
2942
|
+
context?: string;
|
|
2943
|
+
}
|
|
2944
|
+
/**
|
|
2945
|
+
* SubmitFormResponse is returned when a submission was recorded.
|
|
2946
|
+
*/
|
|
2947
|
+
export interface SubmitFormResponse {
|
|
2948
|
+
submission: FormSubmissionDTO;
|
|
2949
|
+
}
|
|
2950
|
+
/**
|
|
2951
|
+
* SurveyResponseDTO is the API representation of a survey response.
|
|
2952
|
+
*/
|
|
2953
|
+
export interface SurveyResponseDTO extends BaseModelDTO, PermissionModelDTO {
|
|
2954
|
+
question_id: string;
|
|
2955
|
+
response: string;
|
|
2956
|
+
agent?: string;
|
|
2957
|
+
source?: string;
|
|
2958
|
+
context?: string;
|
|
2959
|
+
}
|
|
2960
|
+
/**
|
|
2961
|
+
* SubmitSurveyResponse is returned when submitting a survey answer.
|
|
2962
|
+
* GrantedAmount and RewardBlockedReason are kept for the CLIs that read
|
|
2963
|
+
* them; the alias records answers only, so they are always 0 and empty.
|
|
2964
|
+
* Bounties are claimed through POST /me/bounty.
|
|
2965
|
+
*/
|
|
2966
|
+
export interface SubmitSurveyResponse {
|
|
2967
|
+
response: SurveyResponseDTO;
|
|
2968
|
+
granted_amount?: number;
|
|
2969
|
+
reward_blocked_reason?: string;
|
|
2970
|
+
}
|
|
2971
|
+
/**
|
|
2972
|
+
* SubmitSurveyRequest is used to submit a single survey answer.
|
|
2973
|
+
*/
|
|
2974
|
+
export interface SubmitSurveyRequest {
|
|
2975
|
+
question_id: string;
|
|
2976
|
+
response: string;
|
|
2977
|
+
agent?: string;
|
|
2978
|
+
source?: string;
|
|
2979
|
+
context?: string;
|
|
2980
|
+
}
|
|
2742
2981
|
/**
|
|
2743
2982
|
* GraphNodeDTO is the API representation of a graph node
|
|
2744
2983
|
*/
|
|
@@ -3151,6 +3390,9 @@ export interface ResourceContent {
|
|
|
3151
3390
|
mimeType?: string;
|
|
3152
3391
|
text?: string;
|
|
3153
3392
|
blob?: string;
|
|
3393
|
+
_meta?: {
|
|
3394
|
+
[key: string]: any;
|
|
3395
|
+
};
|
|
3154
3396
|
}
|
|
3155
3397
|
/**
|
|
3156
3398
|
* ToolCallRequest represents a request to call a tool.
|
|
@@ -3861,37 +4103,6 @@ export interface SubscriptionDTO extends BaseModelDTO {
|
|
|
3861
4103
|
cancel_at_period_end: boolean;
|
|
3862
4104
|
credits_per_period: number;
|
|
3863
4105
|
}
|
|
3864
|
-
/**
|
|
3865
|
-
* SurveyResponseDTO is the API representation of a survey response.
|
|
3866
|
-
*/
|
|
3867
|
-
export interface SurveyResponseDTO extends BaseModelDTO, PermissionModelDTO {
|
|
3868
|
-
question_id: string;
|
|
3869
|
-
response: string;
|
|
3870
|
-
agent?: string;
|
|
3871
|
-
source?: string;
|
|
3872
|
-
context?: string;
|
|
3873
|
-
}
|
|
3874
|
-
/**
|
|
3875
|
-
* SubmitSurveyResponse is returned when submitting a survey answer.
|
|
3876
|
-
* GrantedAmount is the credit reward in microcents (0 if no reward was earned).
|
|
3877
|
-
* RewardBlockedReason is set when the answer was recorded but the reward was
|
|
3878
|
-
* withheld by policy (see RewardBlockedPaymentMethodRequired).
|
|
3879
|
-
*/
|
|
3880
|
-
export interface SubmitSurveyResponse {
|
|
3881
|
-
response: SurveyResponseDTO;
|
|
3882
|
-
granted_amount?: number;
|
|
3883
|
-
reward_blocked_reason?: string;
|
|
3884
|
-
}
|
|
3885
|
-
/**
|
|
3886
|
-
* SubmitSurveyRequest is used to submit a single survey answer.
|
|
3887
|
-
*/
|
|
3888
|
-
export interface SubmitSurveyRequest {
|
|
3889
|
-
question_id: string;
|
|
3890
|
-
response: string;
|
|
3891
|
-
agent?: string;
|
|
3892
|
-
source?: string;
|
|
3893
|
-
context?: string;
|
|
3894
|
-
}
|
|
3895
4106
|
/**
|
|
3896
4107
|
* Hardware/System related types
|
|
3897
4108
|
*/
|
|
@@ -4360,6 +4571,10 @@ export interface UserRelationDTO {
|
|
|
4360
4571
|
created_at: string;
|
|
4361
4572
|
updated_at: string;
|
|
4362
4573
|
role: Role;
|
|
4574
|
+
/**
|
|
4575
|
+
* Name is omitted when empty so older generated copies of this DTO stay assignable.
|
|
4576
|
+
*/
|
|
4577
|
+
name?: string;
|
|
4363
4578
|
avatar_url: string;
|
|
4364
4579
|
}
|
|
4365
4580
|
/**
|
|
@@ -4380,7 +4595,7 @@ export interface UserMetadataDTO {
|
|
|
4380
4595
|
* Alias of shared.A2UISurface so the type generation pipeline picks it up.
|
|
4381
4596
|
*/
|
|
4382
4597
|
export type Widget = A2UISurface;
|
|
4383
|
-
export type A2UIComponentType = "Row" | "Column" | "List" | "Text" | "Image" | "Icon" | "Divider" | "Button" | "TextField" | "CheckBox" | "Slider" | "DateTimeInput" | "ChoicePicker" | "Card" | "Modal" | "Tabs" | "Badge" | "Spacer" | "Chart" | "Form" | "Artifact";
|
|
4598
|
+
export type A2UIComponentType = "Row" | "Column" | "List" | "Text" | "Image" | "Icon" | "Divider" | "Button" | "TextField" | "CheckBox" | "Slider" | "DateTimeInput" | "ChoicePicker" | "Card" | "Modal" | "Tabs" | "Badge" | "Spacer" | "Chart" | "Form" | "Artifact" | "McpApp";
|
|
4384
4599
|
export declare const A2UIRow: A2UIComponentType;
|
|
4385
4600
|
export declare const A2UIColumn: A2UIComponentType;
|
|
4386
4601
|
export declare const A2UIList: A2UIComponentType;
|
|
@@ -4409,6 +4624,12 @@ export declare const A2UIForm: A2UIComponentType;
|
|
|
4409
4624
|
* the viewer. Rendered from the artifact's /render endpoint.
|
|
4410
4625
|
*/
|
|
4411
4626
|
export declare const A2UIArtifact: A2UIComponentType;
|
|
4627
|
+
/**
|
|
4628
|
+
* McpApp embeds a remote MCP server's tool page (MCP Apps, SEP-1865): a
|
|
4629
|
+
* sandboxed HTML document the host feeds the tool's input and result over
|
|
4630
|
+
* postMessage, and whose tools/call requests it proxies to the server.
|
|
4631
|
+
*/
|
|
4632
|
+
export declare const A2UIMcpApp: A2UIComponentType;
|
|
4412
4633
|
/**
|
|
4413
4634
|
* A2UIComponent is the universal component representation.
|
|
4414
4635
|
* Children are string IDs (flat adjacency list), not nested objects.
|
|
@@ -4519,6 +4740,59 @@ export interface A2UIComponent {
|
|
|
4519
4740
|
artifactTitle?: string;
|
|
4520
4741
|
artifactUrl?: string;
|
|
4521
4742
|
artifactFavicon?: string;
|
|
4743
|
+
/**
|
|
4744
|
+
* Extension: McpApp. A remote server's page is named by McpPageHash and
|
|
4745
|
+
* read from GET /mcp-ui-pages/{hash}, so a chat that runs a tool many
|
|
4746
|
+
* times holds one copy of its page, not one per message. McpHtml carries
|
|
4747
|
+
* the page inline instead: an artifact's page, a component written
|
|
4748
|
+
* before pages were stored by hash, or a page that could not be stored.
|
|
4749
|
+
* The server, credential and tool name let the host route the page's
|
|
4750
|
+
* tools/call requests.
|
|
4751
|
+
*/
|
|
4752
|
+
mcpHtml?: string;
|
|
4753
|
+
mcpPageHash?: string;
|
|
4754
|
+
mcpCsp?: MCPUICSP;
|
|
4755
|
+
mcpResourceUri?: string;
|
|
4756
|
+
mcpServerSlug?: string;
|
|
4757
|
+
mcpCredentialId?: string;
|
|
4758
|
+
mcpToolName?: string;
|
|
4759
|
+
mcpToolInput?: {
|
|
4760
|
+
[key: string]: any;
|
|
4761
|
+
};
|
|
4762
|
+
mcpToolResult?: A2UIMcpToolResult;
|
|
4763
|
+
mcpPrefersBorder?: boolean;
|
|
4764
|
+
/**
|
|
4765
|
+
* McpArtifactId is set when the page is one of our artifacts (an app's
|
|
4766
|
+
* own UI) rather than a remote server's: the host then serves the page's
|
|
4767
|
+
* runtime calls through the artifact's data endpoints, not /mcps.
|
|
4768
|
+
*/
|
|
4769
|
+
mcpArtifactId?: string;
|
|
4770
|
+
}
|
|
4771
|
+
/**
|
|
4772
|
+
* MCPUICSP is an MCP Apps resource's _meta.ui.csp: the origins the host must
|
|
4773
|
+
* let the page reach, by directive. Lives here rather than in apitypes
|
|
4774
|
+
* because A2UI components carry it and apitypes imports this package.
|
|
4775
|
+
*/
|
|
4776
|
+
export interface MCPUICSP {
|
|
4777
|
+
connectDomains?: string[];
|
|
4778
|
+
resourceDomains?: string[];
|
|
4779
|
+
frameDomains?: string[];
|
|
4780
|
+
baseUriDomains?: string[];
|
|
4781
|
+
}
|
|
4782
|
+
/**
|
|
4783
|
+
* A2UIMcpToolResult is the tool result in the shape the page expects
|
|
4784
|
+
* (ui/notifications/tool-result carries a CallToolResult): the content blocks
|
|
4785
|
+
* as the server sent them, not the platform's mapped output.
|
|
4786
|
+
*/
|
|
4787
|
+
export interface A2UIMcpToolResult {
|
|
4788
|
+
content: {
|
|
4789
|
+
[key: string]: any;
|
|
4790
|
+
}[];
|
|
4791
|
+
structuredContent?: any;
|
|
4792
|
+
isError?: boolean;
|
|
4793
|
+
_meta?: {
|
|
4794
|
+
[key: string]: any;
|
|
4795
|
+
};
|
|
4522
4796
|
}
|
|
4523
4797
|
export type A2UIBound = string | number | boolean | A2UIBoundValue;
|
|
4524
4798
|
/**
|
|
@@ -4570,7 +4844,7 @@ export declare const ApiKeyScopeUser: ApiKeyScope;
|
|
|
4570
4844
|
* service account, not a person, and outlives the admin who created it.
|
|
4571
4845
|
*/
|
|
4572
4846
|
export declare const ApiKeyScopeWorkspace: ApiKeyScope;
|
|
4573
|
-
export type AppCategory = "image" | "video" | "audio" | "text" | "chat" | "3d" | "other" | "flow";
|
|
4847
|
+
export type AppCategory = "image" | "video" | "audio" | "text" | "chat" | "3d" | "other" | "flow" | "decision";
|
|
4574
4848
|
export declare const AppCategoryImage: AppCategory;
|
|
4575
4849
|
export declare const AppCategoryVideo: AppCategory;
|
|
4576
4850
|
export declare const AppCategoryAudio: AppCategory;
|
|
@@ -4579,6 +4853,273 @@ export declare const AppCategoryChat: AppCategory;
|
|
|
4579
4853
|
export declare const AppCategory3D: AppCategory;
|
|
4580
4854
|
export declare const AppCategoryOther: AppCategory;
|
|
4581
4855
|
export declare const AppCategoryFlow: AppCategory;
|
|
4856
|
+
/**
|
|
4857
|
+
* Decision models: typed questions in, a probability for every answer out, no generation.
|
|
4858
|
+
*/
|
|
4859
|
+
export declare const AppCategoryDecision: AppCategory;
|
|
4860
|
+
/**
|
|
4861
|
+
* AppTag is a known app tag: a lowercase slug naming a task an app performs
|
|
4862
|
+
* (text-to-image) or a trait it has (open-weights). An app's tags are free
|
|
4863
|
+
* strings; the ones listed here are the tags clients present by title and
|
|
4864
|
+
* build pages for. Each has an AppTagTitle constant with the same suffix.
|
|
4865
|
+
*/
|
|
4866
|
+
export type AppTag = "text-to-image" | "image-to-image" | "image-editing" | "image-upscaling" | "background-removal" | "training" | "lora" | "pbr-materials" | "text-to-video" | "image-to-video" | "reference-to-video" | "video-to-video" | "video-upscaling" | "video-extension" | "video-enhancement" | "lip-sync" | "talking-avatar" | "native-audio" | "text-to-speech" | "speech-to-text" | "voice-cloning" | "voice-design" | "music-generation" | "sound-effects" | "realtime" | "reasoning" | "vision" | "coding" | "open-weights" | "classification" | "moderation" | "routing" | "web-search" | "web-scraping" | "deep-research" | "research-papers" | "social-media" | "messaging" | "productivity" | "media-utilities" | "rendering" | "evaluation";
|
|
4867
|
+
/**
|
|
4868
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4869
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4870
|
+
*/
|
|
4871
|
+
export declare const AppTagTextToImage: AppTag;
|
|
4872
|
+
/**
|
|
4873
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4874
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4875
|
+
*/
|
|
4876
|
+
export declare const AppTagImageToImage: AppTag;
|
|
4877
|
+
/**
|
|
4878
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4879
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4880
|
+
*/
|
|
4881
|
+
export declare const AppTagImageEditing: AppTag;
|
|
4882
|
+
/**
|
|
4883
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4884
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4885
|
+
*/
|
|
4886
|
+
export declare const AppTagImageUpscaling: AppTag;
|
|
4887
|
+
/**
|
|
4888
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4889
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4890
|
+
*/
|
|
4891
|
+
export declare const AppTagBackgroundRemoval: AppTag;
|
|
4892
|
+
/**
|
|
4893
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4894
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4895
|
+
*/
|
|
4896
|
+
export declare const AppTagTraining: AppTag;
|
|
4897
|
+
/**
|
|
4898
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4899
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4900
|
+
*/
|
|
4901
|
+
export declare const AppTagLoRA: AppTag;
|
|
4902
|
+
/**
|
|
4903
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4904
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4905
|
+
*/
|
|
4906
|
+
export declare const AppTagPBRMaterials: AppTag;
|
|
4907
|
+
/**
|
|
4908
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4909
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4910
|
+
*/
|
|
4911
|
+
export declare const AppTagTextToVideo: AppTag;
|
|
4912
|
+
/**
|
|
4913
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4914
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4915
|
+
*/
|
|
4916
|
+
export declare const AppTagImageToVideo: AppTag;
|
|
4917
|
+
/**
|
|
4918
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4919
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4920
|
+
*/
|
|
4921
|
+
export declare const AppTagReferenceToVideo: AppTag;
|
|
4922
|
+
/**
|
|
4923
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4924
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4925
|
+
*/
|
|
4926
|
+
export declare const AppTagVideoToVideo: AppTag;
|
|
4927
|
+
/**
|
|
4928
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4929
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4930
|
+
*/
|
|
4931
|
+
export declare const AppTagVideoUpscaling: AppTag;
|
|
4932
|
+
/**
|
|
4933
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4934
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4935
|
+
*/
|
|
4936
|
+
export declare const AppTagVideoExtension: AppTag;
|
|
4937
|
+
/**
|
|
4938
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4939
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4940
|
+
*/
|
|
4941
|
+
export declare const AppTagVideoEnhancement: AppTag;
|
|
4942
|
+
/**
|
|
4943
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4944
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4945
|
+
*/
|
|
4946
|
+
export declare const AppTagLipSync: AppTag;
|
|
4947
|
+
/**
|
|
4948
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4949
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4950
|
+
*/
|
|
4951
|
+
export declare const AppTagTalkingAvatar: AppTag;
|
|
4952
|
+
/**
|
|
4953
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4954
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4955
|
+
*/
|
|
4956
|
+
export declare const AppTagNativeAudio: AppTag;
|
|
4957
|
+
/**
|
|
4958
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4959
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4960
|
+
*/
|
|
4961
|
+
export declare const AppTagTextToSpeech: AppTag;
|
|
4962
|
+
/**
|
|
4963
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4964
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4965
|
+
*/
|
|
4966
|
+
export declare const AppTagSpeechToText: AppTag;
|
|
4967
|
+
/**
|
|
4968
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4969
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4970
|
+
*/
|
|
4971
|
+
export declare const AppTagVoiceCloning: AppTag;
|
|
4972
|
+
/**
|
|
4973
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4974
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4975
|
+
*/
|
|
4976
|
+
export declare const AppTagVoiceDesign: AppTag;
|
|
4977
|
+
/**
|
|
4978
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4979
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4980
|
+
*/
|
|
4981
|
+
export declare const AppTagMusicGeneration: AppTag;
|
|
4982
|
+
/**
|
|
4983
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4984
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4985
|
+
*/
|
|
4986
|
+
export declare const AppTagSoundEffects: AppTag;
|
|
4987
|
+
/**
|
|
4988
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4989
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4990
|
+
*/
|
|
4991
|
+
export declare const AppTagRealtime: AppTag;
|
|
4992
|
+
/**
|
|
4993
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4994
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
4995
|
+
*/
|
|
4996
|
+
export declare const AppTagReasoning: AppTag;
|
|
4997
|
+
/**
|
|
4998
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
4999
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5000
|
+
*/
|
|
5001
|
+
export declare const AppTagVision: AppTag;
|
|
5002
|
+
/**
|
|
5003
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
5004
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5005
|
+
*/
|
|
5006
|
+
export declare const AppTagCoding: AppTag;
|
|
5007
|
+
/**
|
|
5008
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
5009
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5010
|
+
*/
|
|
5011
|
+
export declare const AppTagOpenWeights: AppTag;
|
|
5012
|
+
/**
|
|
5013
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
5014
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5015
|
+
*/
|
|
5016
|
+
export declare const AppTagClassification: AppTag;
|
|
5017
|
+
/**
|
|
5018
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
5019
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5020
|
+
*/
|
|
5021
|
+
export declare const AppTagModeration: AppTag;
|
|
5022
|
+
/**
|
|
5023
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
5024
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5025
|
+
*/
|
|
5026
|
+
export declare const AppTagRouting: AppTag;
|
|
5027
|
+
/**
|
|
5028
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
5029
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5030
|
+
*/
|
|
5031
|
+
export declare const AppTagWebSearch: AppTag;
|
|
5032
|
+
/**
|
|
5033
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
5034
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5035
|
+
*/
|
|
5036
|
+
export declare const AppTagWebScraping: AppTag;
|
|
5037
|
+
/**
|
|
5038
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
5039
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5040
|
+
*/
|
|
5041
|
+
export declare const AppTagDeepResearch: AppTag;
|
|
5042
|
+
/**
|
|
5043
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
5044
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5045
|
+
*/
|
|
5046
|
+
export declare const AppTagResearchPapers: AppTag;
|
|
5047
|
+
/**
|
|
5048
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
5049
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5050
|
+
*/
|
|
5051
|
+
export declare const AppTagSocialMedia: AppTag;
|
|
5052
|
+
/**
|
|
5053
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
5054
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5055
|
+
*/
|
|
5056
|
+
export declare const AppTagMessaging: AppTag;
|
|
5057
|
+
/**
|
|
5058
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
5059
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5060
|
+
*/
|
|
5061
|
+
export declare const AppTagProductivity: AppTag;
|
|
5062
|
+
/**
|
|
5063
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
5064
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5065
|
+
*/
|
|
5066
|
+
export declare const AppTagMediaUtilities: AppTag;
|
|
5067
|
+
/**
|
|
5068
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
5069
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5070
|
+
*/
|
|
5071
|
+
export declare const AppTagRendering: AppTag;
|
|
5072
|
+
/**
|
|
5073
|
+
* The list holds tags that at least three public apps carry, so each one
|
|
5074
|
+
* leads somewhere. A tag on fewer apps stays a plain tag until it does.
|
|
5075
|
+
*/
|
|
5076
|
+
export declare const AppTagEvaluation: AppTag;
|
|
5077
|
+
/**
|
|
5078
|
+
* AppTagTitle is the display title of a known AppTag.
|
|
5079
|
+
*/
|
|
5080
|
+
export type AppTagTitle = "Text to Image" | "Image to Image" | "Image Editing" | "Image Upscaling" | "Background Removal" | "Model Training" | "LoRA" | "PBR Materials" | "Text to Video" | "Image to Video" | "Reference to Video" | "Video to Video" | "Video Upscaling" | "Video Extension" | "Video Enhancement" | "Lip Sync" | "Talking Avatar" | "Native Audio" | "Text to Speech" | "Speech to Text" | "Voice Cloning" | "Voice Design" | "Music Generation" | "Sound Effects" | "Realtime" | "Reasoning" | "Vision" | "Coding" | "Open Weights" | "Classification" | "Moderation" | "Routing" | "Web Search" | "Web Scraping" | "Deep Research" | "Research Papers" | "Social Media" | "Messaging" | "Productivity" | "Media Utilities" | "Rendering" | "Evaluation";
|
|
5081
|
+
export declare const AppTagTitleTextToImage: AppTagTitle;
|
|
5082
|
+
export declare const AppTagTitleImageToImage: AppTagTitle;
|
|
5083
|
+
export declare const AppTagTitleImageEditing: AppTagTitle;
|
|
5084
|
+
export declare const AppTagTitleImageUpscaling: AppTagTitle;
|
|
5085
|
+
export declare const AppTagTitleBackgroundRemoval: AppTagTitle;
|
|
5086
|
+
export declare const AppTagTitleTraining: AppTagTitle;
|
|
5087
|
+
export declare const AppTagTitleLoRA: AppTagTitle;
|
|
5088
|
+
export declare const AppTagTitlePBRMaterials: AppTagTitle;
|
|
5089
|
+
export declare const AppTagTitleTextToVideo: AppTagTitle;
|
|
5090
|
+
export declare const AppTagTitleImageToVideo: AppTagTitle;
|
|
5091
|
+
export declare const AppTagTitleReferenceToVideo: AppTagTitle;
|
|
5092
|
+
export declare const AppTagTitleVideoToVideo: AppTagTitle;
|
|
5093
|
+
export declare const AppTagTitleVideoUpscaling: AppTagTitle;
|
|
5094
|
+
export declare const AppTagTitleVideoExtension: AppTagTitle;
|
|
5095
|
+
export declare const AppTagTitleVideoEnhancement: AppTagTitle;
|
|
5096
|
+
export declare const AppTagTitleLipSync: AppTagTitle;
|
|
5097
|
+
export declare const AppTagTitleTalkingAvatar: AppTagTitle;
|
|
5098
|
+
export declare const AppTagTitleNativeAudio: AppTagTitle;
|
|
5099
|
+
export declare const AppTagTitleTextToSpeech: AppTagTitle;
|
|
5100
|
+
export declare const AppTagTitleSpeechToText: AppTagTitle;
|
|
5101
|
+
export declare const AppTagTitleVoiceCloning: AppTagTitle;
|
|
5102
|
+
export declare const AppTagTitleVoiceDesign: AppTagTitle;
|
|
5103
|
+
export declare const AppTagTitleMusicGeneration: AppTagTitle;
|
|
5104
|
+
export declare const AppTagTitleSoundEffects: AppTagTitle;
|
|
5105
|
+
export declare const AppTagTitleRealtime: AppTagTitle;
|
|
5106
|
+
export declare const AppTagTitleReasoning: AppTagTitle;
|
|
5107
|
+
export declare const AppTagTitleVision: AppTagTitle;
|
|
5108
|
+
export declare const AppTagTitleCoding: AppTagTitle;
|
|
5109
|
+
export declare const AppTagTitleOpenWeights: AppTagTitle;
|
|
5110
|
+
export declare const AppTagTitleClassification: AppTagTitle;
|
|
5111
|
+
export declare const AppTagTitleModeration: AppTagTitle;
|
|
5112
|
+
export declare const AppTagTitleRouting: AppTagTitle;
|
|
5113
|
+
export declare const AppTagTitleWebSearch: AppTagTitle;
|
|
5114
|
+
export declare const AppTagTitleWebScraping: AppTagTitle;
|
|
5115
|
+
export declare const AppTagTitleDeepResearch: AppTagTitle;
|
|
5116
|
+
export declare const AppTagTitleResearchPapers: AppTagTitle;
|
|
5117
|
+
export declare const AppTagTitleSocialMedia: AppTagTitle;
|
|
5118
|
+
export declare const AppTagTitleMessaging: AppTagTitle;
|
|
5119
|
+
export declare const AppTagTitleProductivity: AppTagTitle;
|
|
5120
|
+
export declare const AppTagTitleMediaUtilities: AppTagTitle;
|
|
5121
|
+
export declare const AppTagTitleRendering: AppTagTitle;
|
|
5122
|
+
export declare const AppTagTitleEvaluation: AppTagTitle;
|
|
4582
5123
|
export type AppStatus = "active" | "maintenance" | "deprecated" | "retired";
|
|
4583
5124
|
export declare const AppStatusActive: AppStatus;
|
|
4584
5125
|
export declare const AppStatusMaintenance: AppStatus;
|
|
@@ -4651,6 +5192,16 @@ export declare const EntitlementScopeMember: EntitlementScope;
|
|
|
4651
5192
|
export type EnforcementMode = "block" | "warn";
|
|
4652
5193
|
export declare const EnforcementBlock: EnforcementMode;
|
|
4653
5194
|
export declare const EnforcementWarn: EnforcementMode;
|
|
5195
|
+
/**
|
|
5196
|
+
* EntitlementRequestState is where a team's request for an entitlement
|
|
5197
|
+
* stands. A team holds at most one open request per resource; an admin
|
|
5198
|
+
* accepts (which grants) or declines it, or the team withdraws it.
|
|
5199
|
+
*/
|
|
5200
|
+
export type EntitlementRequestState = "open" | "accepted" | "declined" | "withdrawn";
|
|
5201
|
+
export declare const EntitlementRequestOpen: EntitlementRequestState;
|
|
5202
|
+
export declare const EntitlementRequestAccepted: EntitlementRequestState;
|
|
5203
|
+
export declare const EntitlementRequestDeclined: EntitlementRequestState;
|
|
5204
|
+
export declare const EntitlementRequestWithdrawn: EntitlementRequestState;
|
|
4654
5205
|
export type ChatStatus = "busy" | "idle" | "awaiting_input" | "completed";
|
|
4655
5206
|
export declare const ChatStatusBusy: ChatStatus;
|
|
4656
5207
|
export declare const ChatStatusIdle: ChatStatus;
|
|
@@ -4772,6 +5323,23 @@ export interface ChannelContext {
|
|
|
4772
5323
|
channel_type?: ChannelType;
|
|
4773
5324
|
channel_metadata?: any;
|
|
4774
5325
|
}
|
|
5326
|
+
/**
|
|
5327
|
+
* DescriptionLimit is the most characters a resource's description may have.
|
|
5328
|
+
*/
|
|
5329
|
+
export type DescriptionLimit = number;
|
|
5330
|
+
/**
|
|
5331
|
+
* DescriptionLimitListing bounds the description of an app, agent, flow,
|
|
5332
|
+
* MCP server or knowledge entry. A description is shown in listings and
|
|
5333
|
+
* handed to agents as a suggestion, so it is a sentence or two; anything
|
|
5334
|
+
* longer belongs in the resource itself.
|
|
5335
|
+
*/
|
|
5336
|
+
export declare const DescriptionLimitListing: DescriptionLimit;
|
|
5337
|
+
/**
|
|
5338
|
+
* DescriptionLimitSkill bounds a skill's description. It is the skill's
|
|
5339
|
+
* SKILL.md frontmatter, so it follows the Agent Skills specification
|
|
5340
|
+
* (https://agentskills.io/specification) rather than the listing limit.
|
|
5341
|
+
*/
|
|
5342
|
+
export declare const DescriptionLimitSkill: DescriptionLimit;
|
|
4775
5343
|
/**
|
|
4776
5344
|
* EngineStatus represents the status of an engine.
|
|
4777
5345
|
*/
|
|
@@ -4872,6 +5440,31 @@ export interface OutputFieldMapping {
|
|
|
4872
5440
|
export type OutputMappings = {
|
|
4873
5441
|
[key: string]: OutputFieldMapping;
|
|
4874
5442
|
};
|
|
5443
|
+
/**
|
|
5444
|
+
* FormStatus is a form's lifecycle. Only an open form takes submissions.
|
|
5445
|
+
*/
|
|
5446
|
+
export type FormStatus = "draft" | "open" | "closed";
|
|
5447
|
+
export declare const FormStatusDraft: FormStatus;
|
|
5448
|
+
export declare const FormStatusOpen: FormStatus;
|
|
5449
|
+
export declare const FormStatusClosed: FormStatus;
|
|
5450
|
+
/**
|
|
5451
|
+
* FormSubmitPolicy says how many submissions a form takes from one source.
|
|
5452
|
+
*/
|
|
5453
|
+
export type FormSubmitPolicy = "once_per_user" | "once_per_team" | "many";
|
|
5454
|
+
/**
|
|
5455
|
+
* FormSubmitOncePerUser: one submission per person, whichever team they
|
|
5456
|
+
* selected when they answered.
|
|
5457
|
+
*/
|
|
5458
|
+
export declare const FormSubmitOncePerUser: FormSubmitPolicy;
|
|
5459
|
+
/**
|
|
5460
|
+
* FormSubmitOncePerTeam: one submission per team; the submitter's
|
|
5461
|
+
* selected team counts.
|
|
5462
|
+
*/
|
|
5463
|
+
export declare const FormSubmitOncePerTeam: FormSubmitPolicy;
|
|
5464
|
+
/**
|
|
5465
|
+
* FormSubmitMany: no limit.
|
|
5466
|
+
*/
|
|
5467
|
+
export declare const FormSubmitMany: FormSubmitPolicy;
|
|
4875
5468
|
/**
|
|
4876
5469
|
* GateCondition defines a simple boolean condition for gate nodes.
|
|
4877
5470
|
*/
|
|
@@ -5310,7 +5903,7 @@ export declare const DeviceTokenKindSession: DeviceTokenKind;
|
|
|
5310
5903
|
* TODO: retire once CLIs older than the session-token release are gone.
|
|
5311
5904
|
*/
|
|
5312
5905
|
export declare const DeviceTokenKindAPIKey: DeviceTokenKind;
|
|
5313
|
-
export type EntitlementResource = "api_keys" | "connectors" | "knowledge_bases" | "storage_mb" | "concurrency" | "rate_per_min" | "seats" | "triggers" | "retention_days" | "private_apps" | "task_executions" | "feature:byok" | "feature:seedance" | "feature:marketplace_publish" | "feature:scopes" | "feature:webhooks" | "feature:team_billing" | "feature:auto_recharge" | "feature:invoices" | "feature:publish_apps";
|
|
5906
|
+
export type EntitlementResource = "api_keys" | "connectors" | "knowledge_bases" | "storage_mb" | "concurrency" | "rate_per_min" | "seats" | "triggers" | "retention_days" | "private_apps" | "task_executions" | "feature:byok" | "feature:seedance" | "feature:marketplace_publish" | "feature:forms" | "feature:scopes" | "feature:webhooks" | "feature:team_billing" | "feature:auto_recharge" | "feature:invoices" | "feature:publish_apps";
|
|
5314
5907
|
/**
|
|
5315
5908
|
* Capacity limits — scale with tier
|
|
5316
5909
|
*/
|
|
@@ -5337,6 +5930,10 @@ export declare const ResourceFeatureSeedance: EntitlementResource;
|
|
|
5337
5930
|
* Granted per team: the marketplace takes submissions by invitation.
|
|
5338
5931
|
*/
|
|
5339
5932
|
export declare const ResourceFeatureMarketplacePublish: EntitlementResource;
|
|
5933
|
+
/**
|
|
5934
|
+
* Granted per team: creating forms is by invitation for now.
|
|
5935
|
+
*/
|
|
5936
|
+
export declare const ResourceFeatureForms: EntitlementResource;
|
|
5340
5937
|
/**
|
|
5341
5938
|
* Legacy feature gates — kept for DB compatibility, no longer gated
|
|
5342
5939
|
*/
|
|
@@ -5474,7 +6071,7 @@ export declare const NotificationPriorityCritical: NotificationPriority;
|
|
|
5474
6071
|
/**
|
|
5475
6072
|
* NotificationType represents the type/category of notification
|
|
5476
6073
|
*/
|
|
5477
|
-
export type NotificationType = "low_balance" | "auto_recharge" | "payment_success" | "payment_failed" | "usage_summary" | "spending_limit" | "invoice" | "credit_note" | "subscription_created" | "subscription_credit" | "subscription_canceled" | "subscription_payment_failed" | "subscription_trial_ending" | "welcome" | "welcome_agents" | "welcome_apps" | "welcome_flows" | "welcome_sdk" | "password_reset" | "email_verify" | "security_alert" | "task_complete" | "task_failed" | "data_export" | "system_alert" | "maintenance" | "tos_update" | "service_notice" | "team_invite";
|
|
6074
|
+
export type NotificationType = "low_balance" | "auto_recharge" | "payment_success" | "payment_failed" | "usage_summary" | "spending_limit" | "invoice" | "credit_note" | "subscription_created" | "subscription_credit" | "subscription_canceled" | "subscription_payment_failed" | "subscription_trial_ending" | "welcome" | "welcome_agents" | "welcome_apps" | "welcome_flows" | "welcome_sdk" | "password_reset" | "email_verify" | "security_alert" | "task_complete" | "task_failed" | "data_export" | "system_alert" | "maintenance" | "tos_update" | "service_notice" | "team_invite" | "entitlement_request";
|
|
5478
6075
|
/**
|
|
5479
6076
|
* Billing notifications
|
|
5480
6077
|
*/
|
|
@@ -5522,6 +6119,10 @@ export declare const NotificationTypeServiceNotice: NotificationType;
|
|
|
5522
6119
|
* Team notifications
|
|
5523
6120
|
*/
|
|
5524
6121
|
export declare const NotificationTypeTeamInvite: NotificationType;
|
|
6122
|
+
/**
|
|
6123
|
+
* An admin decided the team's entitlement request
|
|
6124
|
+
*/
|
|
6125
|
+
export declare const NotificationTypeEntitlementRequest: NotificationType;
|
|
5525
6126
|
/**
|
|
5526
6127
|
* NotificationStatus represents the status of a notification
|
|
5527
6128
|
*/
|
|
@@ -5540,6 +6141,32 @@ export type PolicyEffect = "allow" | "ask" | "deny";
|
|
|
5540
6141
|
export declare const PolicyEffectAllow: PolicyEffect;
|
|
5541
6142
|
export declare const PolicyEffectAsk: PolicyEffect;
|
|
5542
6143
|
export declare const PolicyEffectDeny: PolicyEffect;
|
|
6144
|
+
/**
|
|
6145
|
+
* PolicyEnforcement is how a rule takes part in decisions.
|
|
6146
|
+
*/
|
|
6147
|
+
export type PolicyEnforcement = "default" | "enforced" | "evaluate" | "disabled";
|
|
6148
|
+
/**
|
|
6149
|
+
* PolicyEnforcementDefault: the rule decides in its layer, and a more
|
|
6150
|
+
* specific admin layer with a rule matching the same call overrides it.
|
|
6151
|
+
*/
|
|
6152
|
+
export declare const PolicyEnforcementDefault: PolicyEnforcement;
|
|
6153
|
+
/**
|
|
6154
|
+
* PolicyEnforcementEnforced: an admin (governance) rule that is final.
|
|
6155
|
+
* It is checked before every other layer, and no lower admin layer can
|
|
6156
|
+
* override it; narrow-only layers can still only narrow. Only admin
|
|
6157
|
+
* layers may hold one.
|
|
6158
|
+
*/
|
|
6159
|
+
export declare const PolicyEnforcementEnforced: PolicyEnforcement;
|
|
6160
|
+
/**
|
|
6161
|
+
* PolicyEnforcementEvaluate: the rule never decides. When it would have
|
|
6162
|
+
* changed a decision, the decision feed records what it would have done,
|
|
6163
|
+
* so a rule can be tried before it is switched on.
|
|
6164
|
+
*/
|
|
6165
|
+
export declare const PolicyEnforcementEvaluate: PolicyEnforcement;
|
|
6166
|
+
/**
|
|
6167
|
+
* PolicyEnforcementDisabled: the rule is kept and ignored.
|
|
6168
|
+
*/
|
|
6169
|
+
export declare const PolicyEnforcementDisabled: PolicyEnforcement;
|
|
5543
6170
|
/**
|
|
5544
6171
|
* PolicyKind names what a rule governs; each kind has one matcher.
|
|
5545
6172
|
*/
|