@workos/openapi-spec 0.71.0 → 0.72.0
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/open-api-spec.yaml +1700 -12
- package/dist/services.mjs +65 -0
- package/dist/types.d.ts +1786 -309
- package/package.json +2 -2
package/dist/types.d.ts
CHANGED
|
@@ -4,6 +4,78 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
+
"/agents/blueprints": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* List agent blueprints
|
|
16
|
+
* @description Lists the agent blueprints in the current environment.
|
|
17
|
+
*/
|
|
18
|
+
get: operations["AgentBlueprintsController_list"];
|
|
19
|
+
put?: never;
|
|
20
|
+
/**
|
|
21
|
+
* Create an agent blueprint
|
|
22
|
+
* @description Creates an agent blueprint: the template describing what an agent may do (its permission ceiling), who may invoke it, and the lifetimes of its sessions.
|
|
23
|
+
*/
|
|
24
|
+
post: operations["AgentBlueprintsController_create"];
|
|
25
|
+
delete?: never;
|
|
26
|
+
options?: never;
|
|
27
|
+
head?: never;
|
|
28
|
+
patch?: never;
|
|
29
|
+
trace?: never;
|
|
30
|
+
};
|
|
31
|
+
"/agents/blueprints/{agent_blueprint_id}": {
|
|
32
|
+
parameters: {
|
|
33
|
+
query?: never;
|
|
34
|
+
header?: never;
|
|
35
|
+
path?: never;
|
|
36
|
+
cookie?: never;
|
|
37
|
+
};
|
|
38
|
+
/**
|
|
39
|
+
* Get an agent blueprint
|
|
40
|
+
* @description Retrieves an agent blueprint by ID.
|
|
41
|
+
*/
|
|
42
|
+
get: operations["AgentBlueprintsController_get"];
|
|
43
|
+
put?: never;
|
|
44
|
+
post?: never;
|
|
45
|
+
/**
|
|
46
|
+
* Delete an agent blueprint
|
|
47
|
+
* @description Deletes an agent blueprint along with its configuration, instances, and sessions.
|
|
48
|
+
*/
|
|
49
|
+
delete: operations["AgentBlueprintsController_delete"];
|
|
50
|
+
options?: never;
|
|
51
|
+
head?: never;
|
|
52
|
+
/**
|
|
53
|
+
* Update an agent blueprint
|
|
54
|
+
* @description Updates an agent blueprint. Omitted fields are left unchanged; provided lists replace the existing configuration.
|
|
55
|
+
*/
|
|
56
|
+
patch: operations["AgentBlueprintsController_update"];
|
|
57
|
+
trace?: never;
|
|
58
|
+
};
|
|
59
|
+
"/agents/blueprints/{agent_blueprint_id}/tokens": {
|
|
60
|
+
parameters: {
|
|
61
|
+
query?: never;
|
|
62
|
+
header?: never;
|
|
63
|
+
path?: never;
|
|
64
|
+
cookie?: never;
|
|
65
|
+
};
|
|
66
|
+
get?: never;
|
|
67
|
+
put?: never;
|
|
68
|
+
/**
|
|
69
|
+
* Mint an agent token
|
|
70
|
+
* @description Mint an agent access token (and backing session) from an agent blueprint. The session can be user-delegated (exchanging a user access token), autonomous (the agent acting as itself in an organization), agent-delegated (the agent exchanging its own access token for a new session on the same instance), or a refresh of a previously issued refresh token.
|
|
71
|
+
*/
|
|
72
|
+
post: operations["AgentBlueprintsTokenController_mintToken"];
|
|
73
|
+
delete?: never;
|
|
74
|
+
options?: never;
|
|
75
|
+
head?: never;
|
|
76
|
+
patch?: never;
|
|
77
|
+
trace?: never;
|
|
78
|
+
};
|
|
7
79
|
"/agents/claims/attempts": {
|
|
8
80
|
parameters: {
|
|
9
81
|
query?: never;
|
|
@@ -44,6 +116,50 @@ export interface paths {
|
|
|
44
116
|
patch?: never;
|
|
45
117
|
trace?: never;
|
|
46
118
|
};
|
|
119
|
+
"/agents/instances": {
|
|
120
|
+
parameters: {
|
|
121
|
+
query?: never;
|
|
122
|
+
header?: never;
|
|
123
|
+
path?: never;
|
|
124
|
+
cookie?: never;
|
|
125
|
+
};
|
|
126
|
+
/**
|
|
127
|
+
* List agent instances
|
|
128
|
+
* @description Lists the agent instances in the current environment. Instances are created implicitly when tokens are minted.
|
|
129
|
+
*/
|
|
130
|
+
get: operations["AgentInstancesController_list"];
|
|
131
|
+
put?: never;
|
|
132
|
+
post?: never;
|
|
133
|
+
delete?: never;
|
|
134
|
+
options?: never;
|
|
135
|
+
head?: never;
|
|
136
|
+
patch?: never;
|
|
137
|
+
trace?: never;
|
|
138
|
+
};
|
|
139
|
+
"/agents/instances/{agent_instance_id}": {
|
|
140
|
+
parameters: {
|
|
141
|
+
query?: never;
|
|
142
|
+
header?: never;
|
|
143
|
+
path?: never;
|
|
144
|
+
cookie?: never;
|
|
145
|
+
};
|
|
146
|
+
/**
|
|
147
|
+
* Get an agent instance
|
|
148
|
+
* @description Retrieves an agent instance by ID.
|
|
149
|
+
*/
|
|
150
|
+
get: operations["AgentInstancesController_get"];
|
|
151
|
+
put?: never;
|
|
152
|
+
post?: never;
|
|
153
|
+
/**
|
|
154
|
+
* Delete an agent instance
|
|
155
|
+
* @description Deletes an agent instance along with its sessions, invalidating their refresh tokens.
|
|
156
|
+
*/
|
|
157
|
+
delete: operations["AgentInstancesController_delete"];
|
|
158
|
+
options?: never;
|
|
159
|
+
head?: never;
|
|
160
|
+
patch?: never;
|
|
161
|
+
trace?: never;
|
|
162
|
+
};
|
|
47
163
|
"/agents/registrations/{id}": {
|
|
48
164
|
parameters: {
|
|
49
165
|
query?: never;
|
|
@@ -64,6 +180,66 @@ export interface paths {
|
|
|
64
180
|
patch?: never;
|
|
65
181
|
trace?: never;
|
|
66
182
|
};
|
|
183
|
+
"/agents/sessions": {
|
|
184
|
+
parameters: {
|
|
185
|
+
query?: never;
|
|
186
|
+
header?: never;
|
|
187
|
+
path?: never;
|
|
188
|
+
cookie?: never;
|
|
189
|
+
};
|
|
190
|
+
/**
|
|
191
|
+
* List agent instance sessions
|
|
192
|
+
* @description Lists the agent instance sessions in the current environment. Sessions are created when tokens are minted.
|
|
193
|
+
*/
|
|
194
|
+
get: operations["AgentInstanceSessionsController_list"];
|
|
195
|
+
put?: never;
|
|
196
|
+
post?: never;
|
|
197
|
+
delete?: never;
|
|
198
|
+
options?: never;
|
|
199
|
+
head?: never;
|
|
200
|
+
patch?: never;
|
|
201
|
+
trace?: never;
|
|
202
|
+
};
|
|
203
|
+
"/agents/sessions/{agent_instance_session_id}": {
|
|
204
|
+
parameters: {
|
|
205
|
+
query?: never;
|
|
206
|
+
header?: never;
|
|
207
|
+
path?: never;
|
|
208
|
+
cookie?: never;
|
|
209
|
+
};
|
|
210
|
+
/**
|
|
211
|
+
* Get an agent instance session
|
|
212
|
+
* @description Retrieves an agent instance session by ID.
|
|
213
|
+
*/
|
|
214
|
+
get: operations["AgentInstanceSessionsController_get"];
|
|
215
|
+
put?: never;
|
|
216
|
+
post?: never;
|
|
217
|
+
delete?: never;
|
|
218
|
+
options?: never;
|
|
219
|
+
head?: never;
|
|
220
|
+
patch?: never;
|
|
221
|
+
trace?: never;
|
|
222
|
+
};
|
|
223
|
+
"/agents/sessions/{agent_instance_session_id}/revoke": {
|
|
224
|
+
parameters: {
|
|
225
|
+
query?: never;
|
|
226
|
+
header?: never;
|
|
227
|
+
path?: never;
|
|
228
|
+
cookie?: never;
|
|
229
|
+
};
|
|
230
|
+
get?: never;
|
|
231
|
+
put?: never;
|
|
232
|
+
/**
|
|
233
|
+
* Revoke an agent instance session
|
|
234
|
+
* @description Revokes an agent instance session, invalidating its refresh token and every access token minted under it. Revocation is idempotent: revoking an already-revoked session keeps the original `revoked_at`, and revoking an already-expired session returns the session with `status: expired` and a null `revoked_at`.
|
|
235
|
+
*/
|
|
236
|
+
post: operations["AgentInstanceSessionsController_revoke"];
|
|
237
|
+
delete?: never;
|
|
238
|
+
options?: never;
|
|
239
|
+
head?: never;
|
|
240
|
+
patch?: never;
|
|
241
|
+
trace?: never;
|
|
242
|
+
};
|
|
67
243
|
"/api_keys/validations": {
|
|
68
244
|
parameters: {
|
|
69
245
|
query?: never;
|
|
@@ -3733,6 +3909,11 @@ export interface components {
|
|
|
3733
3909
|
/** @description Array of [User Consent Options](/reference/workos-connect/standalone/user-consent-options) to store with the session. */
|
|
3734
3910
|
user_consent_options?: components["schemas"]["UserConsentOption"][];
|
|
3735
3911
|
};
|
|
3912
|
+
/**
|
|
3913
|
+
* @example desc
|
|
3914
|
+
* @enum {string}
|
|
3915
|
+
*/
|
|
3916
|
+
PaginationOrder: "normal" | "desc" | "asc";
|
|
3736
3917
|
ValidateApiKeyDto: {
|
|
3737
3918
|
/**
|
|
3738
3919
|
* @description The value for an API key.
|
|
@@ -3748,11 +3929,6 @@ export interface components {
|
|
|
3748
3929
|
*/
|
|
3749
3930
|
expires_at?: string | null;
|
|
3750
3931
|
};
|
|
3751
|
-
/**
|
|
3752
|
-
* @example desc
|
|
3753
|
-
* @enum {string}
|
|
3754
|
-
*/
|
|
3755
|
-
PaginationOrder: "normal" | "desc" | "asc";
|
|
3756
3932
|
RedirectUriDto: {
|
|
3757
3933
|
/**
|
|
3758
3934
|
* @description The redirect URI.
|
|
@@ -6299,157 +6475,368 @@ export interface components {
|
|
|
6299
6475
|
name: string;
|
|
6300
6476
|
}[];
|
|
6301
6477
|
};
|
|
6302
|
-
|
|
6478
|
+
AgentBlueprint: {
|
|
6303
6479
|
/**
|
|
6304
|
-
* @description Distinguishes the
|
|
6480
|
+
* @description Distinguishes the agent blueprint object.
|
|
6305
6481
|
* @constant
|
|
6306
6482
|
*/
|
|
6307
|
-
object: "
|
|
6483
|
+
object: "agent_blueprint";
|
|
6308
6484
|
/**
|
|
6309
|
-
* @description Unique identifier of the
|
|
6310
|
-
* @example
|
|
6485
|
+
* @description Unique identifier of the agent blueprint.
|
|
6486
|
+
* @example agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
6311
6487
|
*/
|
|
6312
6488
|
id: string;
|
|
6313
6489
|
/**
|
|
6314
|
-
* @description
|
|
6315
|
-
* @example
|
|
6316
|
-
* "type": "organization",
|
|
6317
|
-
* "id": "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6318
|
-
* }
|
|
6490
|
+
* @description Human-readable name of the agent blueprint.
|
|
6491
|
+
* @example Prospecting Agent
|
|
6319
6492
|
*/
|
|
6320
|
-
|
|
6493
|
+
name: string;
|
|
6494
|
+
/**
|
|
6495
|
+
* @description Human-readable description of the agent blueprint.
|
|
6496
|
+
* @example Finds and qualifies sales prospects.
|
|
6497
|
+
*/
|
|
6498
|
+
description: string | null;
|
|
6499
|
+
/**
|
|
6500
|
+
* @description Permission slugs forming the ceiling on what sessions minted from this blueprint may do.
|
|
6501
|
+
* @example [
|
|
6502
|
+
* "crm:read",
|
|
6503
|
+
* "email:send"
|
|
6504
|
+
* ]
|
|
6505
|
+
*/
|
|
6506
|
+
permissions: string[];
|
|
6507
|
+
/** @description Who may mint sessions from this blueprint. */
|
|
6508
|
+
invocable_by: {
|
|
6321
6509
|
/**
|
|
6322
|
-
* @description
|
|
6323
|
-
* @example
|
|
6324
|
-
*
|
|
6510
|
+
* @description Role slugs whose members may mint user-delegated sessions from this blueprint.
|
|
6511
|
+
* @example [
|
|
6512
|
+
* "manager"
|
|
6513
|
+
* ]
|
|
6325
6514
|
*/
|
|
6326
|
-
|
|
6515
|
+
role_slugs: string[];
|
|
6327
6516
|
/**
|
|
6328
|
-
* @description
|
|
6329
|
-
* @example
|
|
6517
|
+
* @description Organizations in which sessions may be minted from this blueprint, enforced on user-delegated, autonomous, and agent-delegated mints.
|
|
6518
|
+
* @example [
|
|
6519
|
+
* "org_01EHWNCE74X7JSDV0X3SZ3KJNY"
|
|
6520
|
+
* ]
|
|
6330
6521
|
*/
|
|
6331
|
-
|
|
6332
|
-
}
|
|
6522
|
+
organization_ids: string[];
|
|
6523
|
+
};
|
|
6524
|
+
/** @description Token and session lifetimes for sessions minted from this blueprint. */
|
|
6525
|
+
session_settings: {
|
|
6333
6526
|
/**
|
|
6334
|
-
* @description
|
|
6335
|
-
* @example
|
|
6336
|
-
* @constant
|
|
6527
|
+
* @description Maximum lifetime of a session in seconds; refreshes never extend a session past this.
|
|
6528
|
+
* @example 3600
|
|
6337
6529
|
*/
|
|
6338
|
-
|
|
6530
|
+
max_age_seconds: number;
|
|
6339
6531
|
/**
|
|
6340
|
-
* @description
|
|
6341
|
-
* @example
|
|
6532
|
+
* @description Lifetime of each minted access token in seconds.
|
|
6533
|
+
* @example 300
|
|
6342
6534
|
*/
|
|
6343
|
-
|
|
6535
|
+
access_token_ttl_seconds: number;
|
|
6344
6536
|
/**
|
|
6345
|
-
* @description
|
|
6346
|
-
* @example
|
|
6537
|
+
* @description Lifetime of each rotated refresh token in seconds.
|
|
6538
|
+
* @example 3600
|
|
6347
6539
|
*/
|
|
6348
|
-
|
|
6540
|
+
refresh_token_ttl_seconds: number;
|
|
6349
6541
|
};
|
|
6350
|
-
/**
|
|
6351
|
-
* @description A descriptive name for the API Key.
|
|
6352
|
-
* @example Production API Key
|
|
6353
|
-
*/
|
|
6354
|
-
name: string;
|
|
6355
|
-
/**
|
|
6356
|
-
* @description An obfuscated representation of the API Key value.
|
|
6357
|
-
* @example sk_...3456
|
|
6358
|
-
*/
|
|
6359
|
-
obfuscated_value: string;
|
|
6360
|
-
/**
|
|
6361
|
-
* Format: date-time
|
|
6362
|
-
* @description Timestamp of when the API Key was last used.
|
|
6363
|
-
* @example null
|
|
6364
|
-
*/
|
|
6365
|
-
last_used_at: string | null;
|
|
6366
|
-
/**
|
|
6367
|
-
* Format: date-time
|
|
6368
|
-
* @description Timestamp when the API Key expires. Null means the key does not expire.
|
|
6369
|
-
* @example null
|
|
6370
|
-
*/
|
|
6371
|
-
expires_at: string | null;
|
|
6372
|
-
/**
|
|
6373
|
-
* @description The permission slugs assigned to the API Key.
|
|
6374
|
-
* @example [
|
|
6375
|
-
* "posts:read",
|
|
6376
|
-
* "posts:write"
|
|
6377
|
-
* ]
|
|
6378
|
-
*/
|
|
6379
|
-
permissions: string[];
|
|
6380
6542
|
/**
|
|
6381
6543
|
* Format: date-time
|
|
6382
|
-
* @description
|
|
6544
|
+
* @description Timestamp when the agent blueprint was created.
|
|
6383
6545
|
* @example 2026-01-15T12:00:00.000Z
|
|
6384
6546
|
*/
|
|
6385
6547
|
created_at: string;
|
|
6386
6548
|
/**
|
|
6387
6549
|
* Format: date-time
|
|
6388
|
-
* @description
|
|
6550
|
+
* @description Timestamp when the agent blueprint was last updated.
|
|
6389
6551
|
* @example 2026-01-15T12:00:00.000Z
|
|
6390
6552
|
*/
|
|
6391
6553
|
updated_at: string;
|
|
6392
6554
|
};
|
|
6393
|
-
|
|
6394
|
-
api_key: components["schemas"]["ApiKey"] | null;
|
|
6395
|
-
/**
|
|
6396
|
-
* @description The ID of the agent registration this API Key was issued for. Present only when the API Key is assigned to an agent registration.
|
|
6397
|
-
* @example agent_reg_01EHZNVPK3SFK441A1RGBFSHRT
|
|
6398
|
-
*/
|
|
6399
|
-
agent_registration_id?: string;
|
|
6400
|
-
};
|
|
6401
|
-
ConnectApplication: {
|
|
6555
|
+
AgentInstance: {
|
|
6402
6556
|
/**
|
|
6403
|
-
* @description Distinguishes the
|
|
6404
|
-
* @example connect_application
|
|
6557
|
+
* @description Distinguishes the agent instance object.
|
|
6405
6558
|
* @constant
|
|
6406
6559
|
*/
|
|
6407
|
-
object: "
|
|
6560
|
+
object: "agent_instance";
|
|
6408
6561
|
/**
|
|
6409
|
-
* @description
|
|
6410
|
-
* @example
|
|
6562
|
+
* @description Unique identifier of the agent instance.
|
|
6563
|
+
* @example agent_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
6411
6564
|
*/
|
|
6412
6565
|
id: string;
|
|
6413
6566
|
/**
|
|
6414
|
-
* @description The
|
|
6415
|
-
* @example
|
|
6567
|
+
* @description The blueprint this instance was minted from.
|
|
6568
|
+
* @example agent_blueprint_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
6416
6569
|
*/
|
|
6417
|
-
|
|
6570
|
+
agent_blueprint_id: string;
|
|
6418
6571
|
/**
|
|
6419
|
-
* @description
|
|
6420
|
-
* @example
|
|
6572
|
+
* @description The organization the instance acts within.
|
|
6573
|
+
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
6421
6574
|
*/
|
|
6422
|
-
|
|
6575
|
+
organization_id: string;
|
|
6423
6576
|
/**
|
|
6424
|
-
* @description The
|
|
6425
|
-
* @example
|
|
6577
|
+
* @description The organization membership of the delegating user; `null` for autonomous instances.
|
|
6578
|
+
* @example om_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
6426
6579
|
*/
|
|
6427
|
-
|
|
6580
|
+
organization_membership_id: string | null;
|
|
6428
6581
|
/**
|
|
6429
|
-
* @description
|
|
6430
|
-
* @
|
|
6431
|
-
* "openid",
|
|
6432
|
-
* "profile",
|
|
6433
|
-
* "email"
|
|
6434
|
-
* ]
|
|
6582
|
+
* @description Whether the instance acts on behalf of a specific user (`delegated`) or as itself (`autonomous`).
|
|
6583
|
+
* @enum {string}
|
|
6435
6584
|
*/
|
|
6436
|
-
|
|
6585
|
+
type: "delegated" | "autonomous";
|
|
6437
6586
|
/**
|
|
6438
6587
|
* Format: date-time
|
|
6439
|
-
* @description
|
|
6588
|
+
* @description Timestamp when the agent instance was created.
|
|
6440
6589
|
* @example 2026-01-15T12:00:00.000Z
|
|
6441
6590
|
*/
|
|
6442
6591
|
created_at: string;
|
|
6443
6592
|
/**
|
|
6444
6593
|
* Format: date-time
|
|
6445
|
-
* @description
|
|
6594
|
+
* @description Timestamp when the agent instance was last updated.
|
|
6446
6595
|
* @example 2026-01-15T12:00:00.000Z
|
|
6447
6596
|
*/
|
|
6448
6597
|
updated_at: string;
|
|
6449
|
-
}
|
|
6598
|
+
};
|
|
6599
|
+
AgentToken: {
|
|
6450
6600
|
/**
|
|
6451
|
-
* @description The
|
|
6452
|
-
* @
|
|
6601
|
+
* @description The agent access token (a JWT) carrying the effective permissions.
|
|
6602
|
+
* @example eyJhbGciOiJSUzI1NiIsImtpZCI6...
|
|
6603
|
+
*/
|
|
6604
|
+
access_token: string;
|
|
6605
|
+
/**
|
|
6606
|
+
* @description Always `Bearer`.
|
|
6607
|
+
* @constant
|
|
6608
|
+
*/
|
|
6609
|
+
token_type: "Bearer";
|
|
6610
|
+
/**
|
|
6611
|
+
* @description Number of seconds until the access token expires.
|
|
6612
|
+
* @example 300
|
|
6613
|
+
*/
|
|
6614
|
+
expires_in: number;
|
|
6615
|
+
/**
|
|
6616
|
+
* @description Single-use refresh token for rotating the access token within the session lifetime.
|
|
6617
|
+
* @example njGkA8Wyht0GBEGGA0Zh1Q3wZzL2...
|
|
6618
|
+
*/
|
|
6619
|
+
refresh_token: string;
|
|
6620
|
+
/**
|
|
6621
|
+
* @description The agent instance the session belongs to.
|
|
6622
|
+
* @example agent_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
6623
|
+
*/
|
|
6624
|
+
agent_instance_id: string;
|
|
6625
|
+
/**
|
|
6626
|
+
* @description Whether this mint created the agent instance: `true` only for the mint that inserted the row, `false` when an existing instance was reused (including when a concurrent mint inserted it first).
|
|
6627
|
+
* @example false
|
|
6628
|
+
*/
|
|
6629
|
+
new_instance: boolean;
|
|
6630
|
+
/**
|
|
6631
|
+
* @description The backing agent instance session.
|
|
6632
|
+
* @example agent_session_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
6633
|
+
*/
|
|
6634
|
+
agent_instance_session_id: string;
|
|
6635
|
+
/**
|
|
6636
|
+
* @description The effective permission slugs carried by the token.
|
|
6637
|
+
* @example [
|
|
6638
|
+
* "crm:read"
|
|
6639
|
+
* ]
|
|
6640
|
+
*/
|
|
6641
|
+
permissions: string[];
|
|
6642
|
+
};
|
|
6643
|
+
AgentInstanceSession: {
|
|
6644
|
+
/**
|
|
6645
|
+
* @description Distinguishes the agent instance session object.
|
|
6646
|
+
* @constant
|
|
6647
|
+
*/
|
|
6648
|
+
object: "agent_instance_session";
|
|
6649
|
+
/**
|
|
6650
|
+
* @description Unique identifier of the agent instance session.
|
|
6651
|
+
* @example agent_session_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
6652
|
+
*/
|
|
6653
|
+
id: string;
|
|
6654
|
+
/**
|
|
6655
|
+
* @description The agent instance the session belongs to.
|
|
6656
|
+
* @example agent_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
6657
|
+
*/
|
|
6658
|
+
agent_instance_id: string;
|
|
6659
|
+
/**
|
|
6660
|
+
* @description Derived from `revoked_at` and `expires_at` at read time; a revoked session stays `revoked` even after it expires.
|
|
6661
|
+
* @enum {string}
|
|
6662
|
+
*/
|
|
6663
|
+
status: "active" | "revoked" | "expired";
|
|
6664
|
+
/**
|
|
6665
|
+
* Format: date-time
|
|
6666
|
+
* @description Timestamp when the session expires.
|
|
6667
|
+
* @example 2026-01-15T13:00:00.000Z
|
|
6668
|
+
*/
|
|
6669
|
+
expires_at: string;
|
|
6670
|
+
/**
|
|
6671
|
+
* Format: date-time
|
|
6672
|
+
* @description Timestamp when the session was revoked; `null` if it has not been revoked.
|
|
6673
|
+
* @example null
|
|
6674
|
+
*/
|
|
6675
|
+
revoked_at: string | null;
|
|
6676
|
+
/**
|
|
6677
|
+
* Format: date-time
|
|
6678
|
+
* @description Timestamp when the session was created.
|
|
6679
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
6680
|
+
*/
|
|
6681
|
+
created_at: string;
|
|
6682
|
+
/**
|
|
6683
|
+
* Format: date-time
|
|
6684
|
+
* @description Timestamp when the session was last updated.
|
|
6685
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
6686
|
+
*/
|
|
6687
|
+
updated_at: string;
|
|
6688
|
+
};
|
|
6689
|
+
ApiKey: {
|
|
6690
|
+
/**
|
|
6691
|
+
* @description Distinguishes the API Key object.
|
|
6692
|
+
* @constant
|
|
6693
|
+
*/
|
|
6694
|
+
object: "api_key";
|
|
6695
|
+
/**
|
|
6696
|
+
* @description Unique identifier of the API Key.
|
|
6697
|
+
* @example api_key_01EHZNVPK3SFK441A1RGBFSHRT
|
|
6698
|
+
*/
|
|
6699
|
+
id: string;
|
|
6700
|
+
/**
|
|
6701
|
+
* @description The entity that owns the API Key.
|
|
6702
|
+
* @example {
|
|
6703
|
+
* "type": "organization",
|
|
6704
|
+
* "id": "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
6705
|
+
* }
|
|
6706
|
+
*/
|
|
6707
|
+
owner: {
|
|
6708
|
+
/**
|
|
6709
|
+
* @description The type of the API Key owner.
|
|
6710
|
+
* @example organization
|
|
6711
|
+
* @constant
|
|
6712
|
+
*/
|
|
6713
|
+
type: "organization";
|
|
6714
|
+
/**
|
|
6715
|
+
* @description Unique identifier of the API Key owner.
|
|
6716
|
+
* @example org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
6717
|
+
*/
|
|
6718
|
+
id: string;
|
|
6719
|
+
} | {
|
|
6720
|
+
/**
|
|
6721
|
+
* @description The type of the API Key owner.
|
|
6722
|
+
* @example user
|
|
6723
|
+
* @constant
|
|
6724
|
+
*/
|
|
6725
|
+
type: "user";
|
|
6726
|
+
/**
|
|
6727
|
+
* @description Unique identifier of the API Key owner.
|
|
6728
|
+
* @example user_01EHZNVPK3SFK441A1RGBFSHRT
|
|
6729
|
+
*/
|
|
6730
|
+
id: string;
|
|
6731
|
+
/**
|
|
6732
|
+
* @description Unique identifier of the organization the API Key can access.
|
|
6733
|
+
* @example org_01EHZNVPK3SFK441A1RGBFSHRT
|
|
6734
|
+
*/
|
|
6735
|
+
organization_id: string;
|
|
6736
|
+
};
|
|
6737
|
+
/**
|
|
6738
|
+
* @description A descriptive name for the API Key.
|
|
6739
|
+
* @example Production API Key
|
|
6740
|
+
*/
|
|
6741
|
+
name: string;
|
|
6742
|
+
/**
|
|
6743
|
+
* @description An obfuscated representation of the API Key value.
|
|
6744
|
+
* @example sk_...3456
|
|
6745
|
+
*/
|
|
6746
|
+
obfuscated_value: string;
|
|
6747
|
+
/**
|
|
6748
|
+
* Format: date-time
|
|
6749
|
+
* @description Timestamp of when the API Key was last used.
|
|
6750
|
+
* @example null
|
|
6751
|
+
*/
|
|
6752
|
+
last_used_at: string | null;
|
|
6753
|
+
/**
|
|
6754
|
+
* Format: date-time
|
|
6755
|
+
* @description Timestamp when the API Key expires. Null means the key does not expire.
|
|
6756
|
+
* @example null
|
|
6757
|
+
*/
|
|
6758
|
+
expires_at: string | null;
|
|
6759
|
+
/**
|
|
6760
|
+
* @description The permission slugs assigned to the API Key.
|
|
6761
|
+
* @example [
|
|
6762
|
+
* "posts:read",
|
|
6763
|
+
* "posts:write"
|
|
6764
|
+
* ]
|
|
6765
|
+
*/
|
|
6766
|
+
permissions: string[];
|
|
6767
|
+
/**
|
|
6768
|
+
* Format: date-time
|
|
6769
|
+
* @description An ISO 8601 timestamp.
|
|
6770
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
6771
|
+
*/
|
|
6772
|
+
created_at: string;
|
|
6773
|
+
/**
|
|
6774
|
+
* Format: date-time
|
|
6775
|
+
* @description An ISO 8601 timestamp.
|
|
6776
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
6777
|
+
*/
|
|
6778
|
+
updated_at: string;
|
|
6779
|
+
};
|
|
6780
|
+
ApiKeyValidationResponse: {
|
|
6781
|
+
api_key: components["schemas"]["ApiKey"] | null;
|
|
6782
|
+
/**
|
|
6783
|
+
* @description The ID of the agent registration this API Key was issued for. Present only when the API Key is assigned to an agent registration.
|
|
6784
|
+
* @example agent_reg_01EHZNVPK3SFK441A1RGBFSHRT
|
|
6785
|
+
*/
|
|
6786
|
+
agent_registration_id?: string;
|
|
6787
|
+
};
|
|
6788
|
+
ConnectApplication: {
|
|
6789
|
+
/**
|
|
6790
|
+
* @description Distinguishes the connect application object.
|
|
6791
|
+
* @example connect_application
|
|
6792
|
+
* @constant
|
|
6793
|
+
*/
|
|
6794
|
+
object: "connect_application";
|
|
6795
|
+
/**
|
|
6796
|
+
* @description The unique ID of the connect application.
|
|
6797
|
+
* @example conn_app_01HXYZ123456789ABCDEFGHIJ
|
|
6798
|
+
*/
|
|
6799
|
+
id: string;
|
|
6800
|
+
/**
|
|
6801
|
+
* @description The client ID of the connect application.
|
|
6802
|
+
* @example client_01HXYZ123456789ABCDEFGHIJ
|
|
6803
|
+
*/
|
|
6804
|
+
client_id: string;
|
|
6805
|
+
/**
|
|
6806
|
+
* @description A description of the connect application.
|
|
6807
|
+
* @example An application for managing user access
|
|
6808
|
+
*/
|
|
6809
|
+
description: string | null;
|
|
6810
|
+
/**
|
|
6811
|
+
* @description The name of the connect application.
|
|
6812
|
+
* @example My Application
|
|
6813
|
+
*/
|
|
6814
|
+
name: string;
|
|
6815
|
+
/**
|
|
6816
|
+
* @description The scopes available for this application.
|
|
6817
|
+
* @example [
|
|
6818
|
+
* "openid",
|
|
6819
|
+
* "profile",
|
|
6820
|
+
* "email"
|
|
6821
|
+
* ]
|
|
6822
|
+
*/
|
|
6823
|
+
scopes: string[];
|
|
6824
|
+
/**
|
|
6825
|
+
* Format: date-time
|
|
6826
|
+
* @description An ISO 8601 timestamp.
|
|
6827
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
6828
|
+
*/
|
|
6829
|
+
created_at: string;
|
|
6830
|
+
/**
|
|
6831
|
+
* Format: date-time
|
|
6832
|
+
* @description An ISO 8601 timestamp.
|
|
6833
|
+
* @example 2026-01-15T12:00:00.000Z
|
|
6834
|
+
*/
|
|
6835
|
+
updated_at: string;
|
|
6836
|
+
} & (({
|
|
6837
|
+
/**
|
|
6838
|
+
* @description The type of the application.
|
|
6839
|
+
* @constant
|
|
6453
6840
|
*/
|
|
6454
6841
|
application_type: "oauth";
|
|
6455
6842
|
/** @description The redirect URIs configured for this application. */
|
|
@@ -14959,7 +15346,7 @@ export interface components {
|
|
|
14959
15346
|
* @example users
|
|
14960
15347
|
* @enum {string}
|
|
14961
15348
|
*/
|
|
14962
|
-
resource_type: "users" | "organizations" | "events" | "sessions";
|
|
15349
|
+
resource_type: "users" | "organizations" | "events" | "sessions" | "auditLogEvents";
|
|
14963
15350
|
};
|
|
14964
15351
|
/**
|
|
14965
15352
|
* Format: date-time
|
|
@@ -14993,7 +15380,7 @@ export interface components {
|
|
|
14993
15380
|
* @example users
|
|
14994
15381
|
* @enum {string}
|
|
14995
15382
|
*/
|
|
14996
|
-
resource_type: "users" | "organizations" | "events" | "sessions";
|
|
15383
|
+
resource_type: "users" | "organizations" | "events" | "sessions" | "auditLogEvents";
|
|
14997
15384
|
};
|
|
14998
15385
|
/**
|
|
14999
15386
|
* Format: date-time
|
|
@@ -15027,7 +15414,7 @@ export interface components {
|
|
|
15027
15414
|
* @example users
|
|
15028
15415
|
* @enum {string}
|
|
15029
15416
|
*/
|
|
15030
|
-
resource_type: "users" | "organizations" | "events" | "sessions";
|
|
15417
|
+
resource_type: "users" | "organizations" | "events" | "sessions" | "auditLogEvents";
|
|
15031
15418
|
};
|
|
15032
15419
|
/**
|
|
15033
15420
|
* Format: date-time
|
|
@@ -15061,7 +15448,7 @@ export interface components {
|
|
|
15061
15448
|
* @example users
|
|
15062
15449
|
* @enum {string}
|
|
15063
15450
|
*/
|
|
15064
|
-
resource_type: "users" | "organizations" | "events" | "sessions";
|
|
15451
|
+
resource_type: "users" | "organizations" | "events" | "sessions" | "auditLogEvents";
|
|
15065
15452
|
};
|
|
15066
15453
|
/**
|
|
15067
15454
|
* Format: date-time
|
|
@@ -18891,136 +19278,156 @@ export interface components {
|
|
|
18891
19278
|
}
|
|
18892
19279
|
export type $defs = Record<string, never>;
|
|
18893
19280
|
export interface operations {
|
|
18894
|
-
|
|
19281
|
+
AgentBlueprintsController_list: {
|
|
18895
19282
|
parameters: {
|
|
18896
|
-
query?:
|
|
19283
|
+
query?: {
|
|
19284
|
+
/** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `before="obj_123"` to fetch a new batch of objects before `"obj_123"`. */
|
|
19285
|
+
before?: string;
|
|
19286
|
+
/** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `after="obj_123"` to fetch a new batch of objects after `"obj_123"`. */
|
|
19287
|
+
after?: string;
|
|
19288
|
+
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
19289
|
+
limit?: number;
|
|
19290
|
+
/** @description Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to `normal`. */
|
|
19291
|
+
order?: components["schemas"]["PaginationOrder"];
|
|
19292
|
+
};
|
|
18897
19293
|
header?: never;
|
|
18898
19294
|
path?: never;
|
|
18899
19295
|
cookie?: never;
|
|
18900
19296
|
};
|
|
18901
|
-
requestBody
|
|
18902
|
-
|
|
18903
|
-
|
|
18904
|
-
|
|
18905
|
-
|
|
18906
|
-
|
|
18907
|
-
|
|
18908
|
-
|
|
18909
|
-
|
|
18910
|
-
/**
|
|
18911
|
-
* @description The token identifying the claim attempt.
|
|
18912
|
-
* @example cla_tkn_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
18913
|
-
*/
|
|
18914
|
-
claim_attempt_token: string;
|
|
18915
|
-
/**
|
|
18916
|
-
* @description The user to attach to the claim attempt, identified by email and external ID.
|
|
18917
|
-
* @example {
|
|
18918
|
-
* "email": "alice@example.com",
|
|
18919
|
-
* "external_id": "user_abc123"
|
|
18920
|
-
* }
|
|
18921
|
-
*/
|
|
18922
|
-
user: {
|
|
19297
|
+
requestBody?: never;
|
|
19298
|
+
responses: {
|
|
19299
|
+
/** @description OK */
|
|
19300
|
+
200: {
|
|
19301
|
+
headers: {
|
|
19302
|
+
[name: string]: unknown;
|
|
19303
|
+
};
|
|
19304
|
+
content: {
|
|
19305
|
+
"application/json": {
|
|
18923
19306
|
/**
|
|
18924
|
-
*
|
|
18925
|
-
* @
|
|
18926
|
-
* @example alice@example.com
|
|
19307
|
+
* @description Indicates this is a list response.
|
|
19308
|
+
* @constant
|
|
18927
19309
|
*/
|
|
18928
|
-
|
|
18929
|
-
/**
|
|
18930
|
-
|
|
18931
|
-
|
|
18932
|
-
|
|
18933
|
-
|
|
19310
|
+
object?: "list";
|
|
19311
|
+
/** @description Pagination cursors for navigating between pages of results. */
|
|
19312
|
+
list_metadata?: {
|
|
19313
|
+
/**
|
|
19314
|
+
* @description An object ID that defines your place in the list. When the ID is not present, you are at the start of the list.
|
|
19315
|
+
* @example agent_blueprint_01HXYZ123456789ABCDEFGHIJ
|
|
19316
|
+
*/
|
|
19317
|
+
before: string | null;
|
|
19318
|
+
/**
|
|
19319
|
+
* @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
|
|
19320
|
+
* @example agent_blueprint_01HXYZ987654321KJIHGFEDCBA
|
|
19321
|
+
*/
|
|
19322
|
+
after: string | null;
|
|
19323
|
+
};
|
|
19324
|
+
} & {
|
|
19325
|
+
/** @description The list of records for the current page. */
|
|
19326
|
+
data?: components["schemas"]["AgentBlueprint"][];
|
|
18934
19327
|
};
|
|
18935
|
-
/**
|
|
18936
|
-
* @description The organization to place the agent in. Required when the user belongs to more than one organization.
|
|
18937
|
-
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
18938
|
-
*/
|
|
18939
|
-
organization_id?: string;
|
|
18940
|
-
};
|
|
18941
|
-
};
|
|
18942
|
-
};
|
|
18943
|
-
responses: {
|
|
18944
|
-
/** @description Claim attempt linked to external user. */
|
|
18945
|
-
200: {
|
|
18946
|
-
headers: {
|
|
18947
|
-
[name: string]: unknown;
|
|
18948
|
-
};
|
|
18949
|
-
content: {
|
|
18950
|
-
"application/json": components["schemas"]["ClaimViewResponse"];
|
|
18951
19328
|
};
|
|
18952
19329
|
};
|
|
18953
|
-
/** @description
|
|
18954
|
-
|
|
19330
|
+
/** @description Unauthorized */
|
|
19331
|
+
401: {
|
|
18955
19332
|
headers: {
|
|
18956
19333
|
[name: string]: unknown;
|
|
18957
19334
|
};
|
|
18958
19335
|
content: {
|
|
18959
19336
|
"application/json": {
|
|
18960
|
-
/**
|
|
18961
|
-
* @description The error code identifying the type of error.
|
|
18962
|
-
* @example invalid_request
|
|
18963
|
-
* @constant
|
|
18964
|
-
*/
|
|
18965
|
-
code: "invalid_request";
|
|
18966
|
-
/**
|
|
18967
|
-
* @description A human-readable description of the error.
|
|
18968
|
-
* @example Request could not be processed.
|
|
18969
|
-
*/
|
|
18970
|
-
message: string;
|
|
18971
|
-
} | {
|
|
18972
|
-
/**
|
|
18973
|
-
* @description The error code identifying the type of error.
|
|
18974
|
-
* @example invalid_claim
|
|
18975
|
-
* @constant
|
|
18976
|
-
*/
|
|
18977
|
-
code: "invalid_claim";
|
|
18978
19337
|
/**
|
|
18979
19338
|
* @description A human-readable description of the error.
|
|
18980
|
-
* @example
|
|
19339
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
18981
19340
|
*/
|
|
18982
19341
|
message: string;
|
|
18983
|
-
}
|
|
18984
|
-
|
|
18985
|
-
|
|
18986
|
-
|
|
18987
|
-
|
|
18988
|
-
|
|
18989
|
-
|
|
19342
|
+
};
|
|
19343
|
+
};
|
|
19344
|
+
};
|
|
19345
|
+
};
|
|
19346
|
+
};
|
|
19347
|
+
AgentBlueprintsController_create: {
|
|
19348
|
+
parameters: {
|
|
19349
|
+
query?: never;
|
|
19350
|
+
header?: never;
|
|
19351
|
+
path?: never;
|
|
19352
|
+
cookie?: never;
|
|
19353
|
+
};
|
|
19354
|
+
requestBody: {
|
|
19355
|
+
content: {
|
|
19356
|
+
"application/json": {
|
|
19357
|
+
/**
|
|
19358
|
+
* @description Human-readable name of the agent blueprint.
|
|
19359
|
+
* @example Prospecting Agent
|
|
19360
|
+
*/
|
|
19361
|
+
name: string;
|
|
19362
|
+
/**
|
|
19363
|
+
* @description Human-readable description of the agent blueprint.
|
|
19364
|
+
* @example Finds and qualifies sales prospects.
|
|
19365
|
+
*/
|
|
19366
|
+
description?: string;
|
|
19367
|
+
/**
|
|
19368
|
+
* @description Permission slugs forming the ceiling on what sessions minted from this blueprint may do. Each slug must exist in the environment.
|
|
19369
|
+
* @default []
|
|
19370
|
+
* @example [
|
|
19371
|
+
* "crm:read",
|
|
19372
|
+
* "email:send"
|
|
19373
|
+
* ]
|
|
19374
|
+
*/
|
|
19375
|
+
permissions?: string[];
|
|
19376
|
+
/**
|
|
19377
|
+
* @description Who may mint sessions from this blueprint.
|
|
19378
|
+
* @default {}
|
|
19379
|
+
*/
|
|
19380
|
+
invocable_by?: {
|
|
18990
19381
|
/**
|
|
18991
|
-
* @description
|
|
18992
|
-
* @
|
|
19382
|
+
* @description Role slugs whose members may mint user-delegated sessions from this blueprint. An empty list allows any member.
|
|
19383
|
+
* @default []
|
|
19384
|
+
* @example [
|
|
19385
|
+
* "manager"
|
|
19386
|
+
* ]
|
|
18993
19387
|
*/
|
|
18994
|
-
|
|
18995
|
-
} | {
|
|
19388
|
+
role_slugs?: string[];
|
|
18996
19389
|
/**
|
|
18997
|
-
* @description
|
|
18998
|
-
* @
|
|
18999
|
-
* @
|
|
19390
|
+
* @description Organizations in which sessions may be minted from this blueprint, enforced on user-delegated, autonomous, and agent-delegated mints. An empty list allows any organization in the environment.
|
|
19391
|
+
* @default []
|
|
19392
|
+
* @example [
|
|
19393
|
+
* "org_01EHWNCE74X7JSDV0X3SZ3KJNY"
|
|
19394
|
+
* ]
|
|
19000
19395
|
*/
|
|
19001
|
-
|
|
19396
|
+
organization_ids?: string[];
|
|
19397
|
+
};
|
|
19398
|
+
/** @description Token and session lifetimes for sessions minted from this blueprint. */
|
|
19399
|
+
session_settings: {
|
|
19002
19400
|
/**
|
|
19003
|
-
* @description
|
|
19004
|
-
* @example
|
|
19401
|
+
* @description Maximum lifetime of a session in seconds; refreshes never extend a session past this. At most 31,536,000 (365 days).
|
|
19402
|
+
* @example 3600
|
|
19005
19403
|
*/
|
|
19006
|
-
|
|
19007
|
-
} | {
|
|
19404
|
+
max_age_seconds: number;
|
|
19008
19405
|
/**
|
|
19009
|
-
* @description
|
|
19010
|
-
* @example
|
|
19011
|
-
* @constant
|
|
19406
|
+
* @description Lifetime of each minted access token in seconds. At most 3,600 (1 hour).
|
|
19407
|
+
* @example 300
|
|
19012
19408
|
*/
|
|
19013
|
-
|
|
19409
|
+
access_token_ttl_seconds: number;
|
|
19014
19410
|
/**
|
|
19015
|
-
* @description
|
|
19016
|
-
* @example
|
|
19411
|
+
* @description Lifetime of each rotated refresh token in seconds. At most 5,184,000 (60 days).
|
|
19412
|
+
* @example 3600
|
|
19017
19413
|
*/
|
|
19018
|
-
|
|
19414
|
+
refresh_token_ttl_seconds: number;
|
|
19019
19415
|
};
|
|
19020
19416
|
};
|
|
19021
19417
|
};
|
|
19022
|
-
|
|
19023
|
-
|
|
19418
|
+
};
|
|
19419
|
+
responses: {
|
|
19420
|
+
/** @description Created */
|
|
19421
|
+
201: {
|
|
19422
|
+
headers: {
|
|
19423
|
+
[name: string]: unknown;
|
|
19424
|
+
};
|
|
19425
|
+
content: {
|
|
19426
|
+
"application/json": components["schemas"]["AgentBlueprint"];
|
|
19427
|
+
};
|
|
19428
|
+
};
|
|
19429
|
+
/** @description Bad Request */
|
|
19430
|
+
400: {
|
|
19024
19431
|
headers: {
|
|
19025
19432
|
[name: string]: unknown;
|
|
19026
19433
|
};
|
|
@@ -19028,22 +19435,10 @@ export interface operations {
|
|
|
19028
19435
|
"application/json": {
|
|
19029
19436
|
/**
|
|
19030
19437
|
* @description The error code identifying the type of error.
|
|
19031
|
-
* @example
|
|
19032
|
-
* @constant
|
|
19033
|
-
*/
|
|
19034
|
-
code: "claim_denied";
|
|
19035
|
-
/**
|
|
19036
|
-
* @description A human-readable description of the error.
|
|
19037
|
-
* @example Request could not be processed.
|
|
19038
|
-
*/
|
|
19039
|
-
message: string;
|
|
19040
|
-
} | {
|
|
19041
|
-
/**
|
|
19042
|
-
* @description The error code identifying the type of error.
|
|
19043
|
-
* @example auth_method_disabled
|
|
19438
|
+
* @example invalid_request
|
|
19044
19439
|
* @constant
|
|
19045
19440
|
*/
|
|
19046
|
-
code: "
|
|
19441
|
+
code: "invalid_request";
|
|
19047
19442
|
/**
|
|
19048
19443
|
* @description A human-readable description of the error.
|
|
19049
19444
|
* @example Request could not be processed.
|
|
@@ -19052,7 +19447,6 @@ export interface operations {
|
|
|
19052
19447
|
};
|
|
19053
19448
|
};
|
|
19054
19449
|
};
|
|
19055
|
-
/** @description Organization selection required, email already in use, or claim already completed. */
|
|
19056
19450
|
409: {
|
|
19057
19451
|
headers: {
|
|
19058
19452
|
[name: string]: unknown;
|
|
@@ -19061,35 +19455,31 @@ export interface operations {
|
|
|
19061
19455
|
"application/json": {
|
|
19062
19456
|
/**
|
|
19063
19457
|
* @description The error code identifying the type of error.
|
|
19064
|
-
* @example
|
|
19458
|
+
* @example name_already_in_use
|
|
19065
19459
|
* @constant
|
|
19066
19460
|
*/
|
|
19067
|
-
code: "
|
|
19461
|
+
code: "name_already_in_use";
|
|
19068
19462
|
/**
|
|
19069
19463
|
* @description A human-readable description of the error.
|
|
19070
19464
|
* @example Request could not be processed.
|
|
19071
19465
|
*/
|
|
19072
19466
|
message: string;
|
|
19073
|
-
|
|
19074
|
-
|
|
19075
|
-
|
|
19076
|
-
|
|
19077
|
-
|
|
19078
|
-
|
|
19079
|
-
|
|
19080
|
-
|
|
19081
|
-
|
|
19082
|
-
|
|
19083
|
-
*/
|
|
19084
|
-
name: string;
|
|
19085
|
-
}[];
|
|
19086
|
-
} | {
|
|
19467
|
+
};
|
|
19468
|
+
};
|
|
19469
|
+
};
|
|
19470
|
+
/** @description Unprocessable Entity */
|
|
19471
|
+
422: {
|
|
19472
|
+
headers: {
|
|
19473
|
+
[name: string]: unknown;
|
|
19474
|
+
};
|
|
19475
|
+
content: {
|
|
19476
|
+
"application/json": {
|
|
19087
19477
|
/**
|
|
19088
19478
|
* @description The error code identifying the type of error.
|
|
19089
|
-
* @example
|
|
19479
|
+
* @example permission_not_found
|
|
19090
19480
|
* @constant
|
|
19091
19481
|
*/
|
|
19092
|
-
code: "
|
|
19482
|
+
code: "permission_not_found";
|
|
19093
19483
|
/**
|
|
19094
19484
|
* @description A human-readable description of the error.
|
|
19095
19485
|
* @example Request could not be processed.
|
|
@@ -19098,31 +19488,10 @@ export interface operations {
|
|
|
19098
19488
|
} | {
|
|
19099
19489
|
/**
|
|
19100
19490
|
* @description The error code identifying the type of error.
|
|
19101
|
-
* @example
|
|
19102
|
-
* @constant
|
|
19103
|
-
*/
|
|
19104
|
-
code: "already_claimed";
|
|
19105
|
-
/**
|
|
19106
|
-
* @description A human-readable description of the error.
|
|
19107
|
-
* @example Request could not be processed.
|
|
19108
|
-
*/
|
|
19109
|
-
message: string;
|
|
19110
|
-
};
|
|
19111
|
-
};
|
|
19112
|
-
};
|
|
19113
|
-
/** @description Claim or user code has expired. */
|
|
19114
|
-
410: {
|
|
19115
|
-
headers: {
|
|
19116
|
-
[name: string]: unknown;
|
|
19117
|
-
};
|
|
19118
|
-
content: {
|
|
19119
|
-
"application/json": {
|
|
19120
|
-
/**
|
|
19121
|
-
* @description The error code identifying the type of error.
|
|
19122
|
-
* @example claim_expired
|
|
19491
|
+
* @example role_not_found
|
|
19123
19492
|
* @constant
|
|
19124
19493
|
*/
|
|
19125
|
-
code: "
|
|
19494
|
+
code: "role_not_found";
|
|
19126
19495
|
/**
|
|
19127
19496
|
* @description A human-readable description of the error.
|
|
19128
19497
|
* @example Request could not be processed.
|
|
@@ -19131,10 +19500,10 @@ export interface operations {
|
|
|
19131
19500
|
} | {
|
|
19132
19501
|
/**
|
|
19133
19502
|
* @description The error code identifying the type of error.
|
|
19134
|
-
* @example
|
|
19503
|
+
* @example organization_not_found
|
|
19135
19504
|
* @constant
|
|
19136
19505
|
*/
|
|
19137
|
-
code: "
|
|
19506
|
+
code: "organization_not_found";
|
|
19138
19507
|
/**
|
|
19139
19508
|
* @description A human-readable description of the error.
|
|
19140
19509
|
* @example Request could not be processed.
|
|
@@ -19145,45 +19514,17 @@ export interface operations {
|
|
|
19145
19514
|
};
|
|
19146
19515
|
};
|
|
19147
19516
|
};
|
|
19148
|
-
|
|
19517
|
+
AgentBlueprintsController_get: {
|
|
19149
19518
|
parameters: {
|
|
19150
19519
|
query?: never;
|
|
19151
19520
|
header?: never;
|
|
19152
|
-
path
|
|
19153
|
-
|
|
19154
|
-
|
|
19155
|
-
requestBody: {
|
|
19156
|
-
content: {
|
|
19157
|
-
"application/json": {
|
|
19158
|
-
/**
|
|
19159
|
-
* @description The kind of credential being validated — an agent API key or an agent access token.
|
|
19160
|
-
* @constant
|
|
19161
|
-
*/
|
|
19162
|
-
type: "api_key";
|
|
19163
|
-
/**
|
|
19164
|
-
* @description The credential value to validate: the API key value for `api_key`, or the access token (JWT) for `access_token`.
|
|
19165
|
-
* @example sk_agent_example_1234567890
|
|
19166
|
-
*/
|
|
19167
|
-
credential: string;
|
|
19168
|
-
} | {
|
|
19169
|
-
/**
|
|
19170
|
-
* @description The kind of credential being validated — an agent API key or an agent access token.
|
|
19171
|
-
* @constant
|
|
19172
|
-
*/
|
|
19173
|
-
type: "access_token";
|
|
19174
|
-
/**
|
|
19175
|
-
* @description The credential value to validate: the API key value for `api_key`, or the access token (JWT) for `access_token`.
|
|
19176
|
-
* @example eyJhbGciOiJSUzI1NiIsImtpZCI6...
|
|
19177
|
-
*/
|
|
19178
|
-
credential: string;
|
|
19179
|
-
/**
|
|
19180
|
-
* @description When provided, the access token's `aud` claim is verified against this value. Tokens issued for a different resource are rejected.
|
|
19181
|
-
* @example https://api.example.com
|
|
19182
|
-
*/
|
|
19183
|
-
audience?: string;
|
|
19184
|
-
};
|
|
19521
|
+
path: {
|
|
19522
|
+
/** @description The unique ID of the agent blueprint. */
|
|
19523
|
+
agent_blueprint_id: string;
|
|
19185
19524
|
};
|
|
19525
|
+
cookie?: never;
|
|
19186
19526
|
};
|
|
19527
|
+
requestBody?: never;
|
|
19187
19528
|
responses: {
|
|
19188
19529
|
/** @description OK */
|
|
19189
19530
|
200: {
|
|
@@ -19191,25 +19532,19 @@ export interface operations {
|
|
|
19191
19532
|
[name: string]: unknown;
|
|
19192
19533
|
};
|
|
19193
19534
|
content: {
|
|
19194
|
-
"application/json": components["schemas"]["
|
|
19535
|
+
"application/json": components["schemas"]["AgentBlueprint"];
|
|
19195
19536
|
};
|
|
19196
19537
|
};
|
|
19197
|
-
/** @description
|
|
19198
|
-
|
|
19538
|
+
/** @description Not Found */
|
|
19539
|
+
404: {
|
|
19199
19540
|
headers: {
|
|
19200
19541
|
[name: string]: unknown;
|
|
19201
19542
|
};
|
|
19202
19543
|
content: {
|
|
19203
19544
|
"application/json": {
|
|
19204
|
-
/**
|
|
19205
|
-
* @description The error code identifying the type of error.
|
|
19206
|
-
* @example invalid_request
|
|
19207
|
-
* @constant
|
|
19208
|
-
*/
|
|
19209
|
-
code: "invalid_request";
|
|
19210
19545
|
/**
|
|
19211
19546
|
* @description A human-readable description of the error.
|
|
19212
|
-
* @example
|
|
19547
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
19213
19548
|
*/
|
|
19214
19549
|
message: string;
|
|
19215
19550
|
};
|
|
@@ -19217,19 +19552,987 @@ export interface operations {
|
|
|
19217
19552
|
};
|
|
19218
19553
|
};
|
|
19219
19554
|
};
|
|
19220
|
-
|
|
19555
|
+
AgentBlueprintsController_delete: {
|
|
19221
19556
|
parameters: {
|
|
19222
19557
|
query?: never;
|
|
19223
19558
|
header?: never;
|
|
19224
19559
|
path: {
|
|
19225
|
-
/** @description The unique ID of the agent
|
|
19226
|
-
|
|
19560
|
+
/** @description The unique ID of the agent blueprint. */
|
|
19561
|
+
agent_blueprint_id: string;
|
|
19227
19562
|
};
|
|
19228
19563
|
cookie?: never;
|
|
19229
19564
|
};
|
|
19230
19565
|
requestBody?: never;
|
|
19231
19566
|
responses: {
|
|
19232
|
-
/** @description
|
|
19567
|
+
/** @description Agent blueprint deleted. */
|
|
19568
|
+
204: {
|
|
19569
|
+
headers: {
|
|
19570
|
+
[name: string]: unknown;
|
|
19571
|
+
};
|
|
19572
|
+
content?: never;
|
|
19573
|
+
};
|
|
19574
|
+
/** @description Not Found */
|
|
19575
|
+
404: {
|
|
19576
|
+
headers: {
|
|
19577
|
+
[name: string]: unknown;
|
|
19578
|
+
};
|
|
19579
|
+
content: {
|
|
19580
|
+
"application/json": {
|
|
19581
|
+
/**
|
|
19582
|
+
* @description A human-readable description of the error.
|
|
19583
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
19584
|
+
*/
|
|
19585
|
+
message: string;
|
|
19586
|
+
};
|
|
19587
|
+
};
|
|
19588
|
+
};
|
|
19589
|
+
};
|
|
19590
|
+
};
|
|
19591
|
+
AgentBlueprintsController_update: {
|
|
19592
|
+
parameters: {
|
|
19593
|
+
query?: never;
|
|
19594
|
+
header?: never;
|
|
19595
|
+
path: {
|
|
19596
|
+
/** @description The unique ID of the agent blueprint. */
|
|
19597
|
+
agent_blueprint_id: string;
|
|
19598
|
+
};
|
|
19599
|
+
cookie?: never;
|
|
19600
|
+
};
|
|
19601
|
+
requestBody: {
|
|
19602
|
+
content: {
|
|
19603
|
+
"application/json": {
|
|
19604
|
+
/**
|
|
19605
|
+
* @description Human-readable name of the agent blueprint.
|
|
19606
|
+
* @example Prospecting Agent
|
|
19607
|
+
*/
|
|
19608
|
+
name?: string;
|
|
19609
|
+
/**
|
|
19610
|
+
* @description Human-readable description of the agent blueprint. Pass `null` to clear it.
|
|
19611
|
+
* @example Finds and qualifies sales prospects.
|
|
19612
|
+
*/
|
|
19613
|
+
description?: string | null;
|
|
19614
|
+
/**
|
|
19615
|
+
* @description Permission slugs forming the ceiling on what sessions minted from this blueprint may do. Each slug must exist in the environment.
|
|
19616
|
+
* @example [
|
|
19617
|
+
* "crm:read",
|
|
19618
|
+
* "email:send"
|
|
19619
|
+
* ]
|
|
19620
|
+
*/
|
|
19621
|
+
permissions?: string[];
|
|
19622
|
+
/** @description Who may mint sessions from this blueprint. Omitted lists are left unchanged. */
|
|
19623
|
+
invocable_by?: {
|
|
19624
|
+
/**
|
|
19625
|
+
* @description Role slugs whose members may mint user-delegated sessions from this blueprint. An empty list allows any member.
|
|
19626
|
+
* @example [
|
|
19627
|
+
* "manager"
|
|
19628
|
+
* ]
|
|
19629
|
+
*/
|
|
19630
|
+
role_slugs?: string[];
|
|
19631
|
+
/**
|
|
19632
|
+
* @description Organizations in which sessions may be minted from this blueprint, enforced on user-delegated, autonomous, and agent-delegated mints. An empty list allows any organization in the environment.
|
|
19633
|
+
* @example [
|
|
19634
|
+
* "org_01EHWNCE74X7JSDV0X3SZ3KJNY"
|
|
19635
|
+
* ]
|
|
19636
|
+
*/
|
|
19637
|
+
organization_ids?: string[];
|
|
19638
|
+
};
|
|
19639
|
+
/** @description Token and session lifetimes for sessions minted from this blueprint. Omitted fields are left unchanged. */
|
|
19640
|
+
session_settings?: {
|
|
19641
|
+
/**
|
|
19642
|
+
* @description Maximum lifetime of a session in seconds; refreshes never extend a session past this. At most 31,536,000 (365 days).
|
|
19643
|
+
* @example 3600
|
|
19644
|
+
*/
|
|
19645
|
+
max_age_seconds?: number;
|
|
19646
|
+
/**
|
|
19647
|
+
* @description Lifetime of each minted access token in seconds. At most 3,600 (1 hour).
|
|
19648
|
+
* @example 300
|
|
19649
|
+
*/
|
|
19650
|
+
access_token_ttl_seconds?: number;
|
|
19651
|
+
/**
|
|
19652
|
+
* @description Lifetime of each rotated refresh token in seconds. At most 5,184,000 (60 days).
|
|
19653
|
+
* @example 3600
|
|
19654
|
+
*/
|
|
19655
|
+
refresh_token_ttl_seconds?: number;
|
|
19656
|
+
};
|
|
19657
|
+
};
|
|
19658
|
+
};
|
|
19659
|
+
};
|
|
19660
|
+
responses: {
|
|
19661
|
+
/** @description OK */
|
|
19662
|
+
200: {
|
|
19663
|
+
headers: {
|
|
19664
|
+
[name: string]: unknown;
|
|
19665
|
+
};
|
|
19666
|
+
content: {
|
|
19667
|
+
"application/json": components["schemas"]["AgentBlueprint"];
|
|
19668
|
+
};
|
|
19669
|
+
};
|
|
19670
|
+
/** @description Bad Request */
|
|
19671
|
+
400: {
|
|
19672
|
+
headers: {
|
|
19673
|
+
[name: string]: unknown;
|
|
19674
|
+
};
|
|
19675
|
+
content: {
|
|
19676
|
+
"application/json": {
|
|
19677
|
+
/**
|
|
19678
|
+
* @description The error code identifying the type of error.
|
|
19679
|
+
* @example invalid_request
|
|
19680
|
+
* @constant
|
|
19681
|
+
*/
|
|
19682
|
+
code: "invalid_request";
|
|
19683
|
+
/**
|
|
19684
|
+
* @description A human-readable description of the error.
|
|
19685
|
+
* @example Request could not be processed.
|
|
19686
|
+
*/
|
|
19687
|
+
message: string;
|
|
19688
|
+
};
|
|
19689
|
+
};
|
|
19690
|
+
};
|
|
19691
|
+
/** @description Not Found */
|
|
19692
|
+
404: {
|
|
19693
|
+
headers: {
|
|
19694
|
+
[name: string]: unknown;
|
|
19695
|
+
};
|
|
19696
|
+
content: {
|
|
19697
|
+
"application/json": {
|
|
19698
|
+
/**
|
|
19699
|
+
* @description A human-readable description of the error.
|
|
19700
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
19701
|
+
*/
|
|
19702
|
+
message: string;
|
|
19703
|
+
};
|
|
19704
|
+
};
|
|
19705
|
+
};
|
|
19706
|
+
409: {
|
|
19707
|
+
headers: {
|
|
19708
|
+
[name: string]: unknown;
|
|
19709
|
+
};
|
|
19710
|
+
content: {
|
|
19711
|
+
"application/json": {
|
|
19712
|
+
/**
|
|
19713
|
+
* @description The error code identifying the type of error.
|
|
19714
|
+
* @example name_already_in_use
|
|
19715
|
+
* @constant
|
|
19716
|
+
*/
|
|
19717
|
+
code: "name_already_in_use";
|
|
19718
|
+
/**
|
|
19719
|
+
* @description A human-readable description of the error.
|
|
19720
|
+
* @example Request could not be processed.
|
|
19721
|
+
*/
|
|
19722
|
+
message: string;
|
|
19723
|
+
};
|
|
19724
|
+
};
|
|
19725
|
+
};
|
|
19726
|
+
/** @description Unprocessable Entity */
|
|
19727
|
+
422: {
|
|
19728
|
+
headers: {
|
|
19729
|
+
[name: string]: unknown;
|
|
19730
|
+
};
|
|
19731
|
+
content: {
|
|
19732
|
+
"application/json": {
|
|
19733
|
+
/**
|
|
19734
|
+
* @description The error code identifying the type of error.
|
|
19735
|
+
* @example permission_not_found
|
|
19736
|
+
* @constant
|
|
19737
|
+
*/
|
|
19738
|
+
code: "permission_not_found";
|
|
19739
|
+
/**
|
|
19740
|
+
* @description A human-readable description of the error.
|
|
19741
|
+
* @example Request could not be processed.
|
|
19742
|
+
*/
|
|
19743
|
+
message: string;
|
|
19744
|
+
} | {
|
|
19745
|
+
/**
|
|
19746
|
+
* @description The error code identifying the type of error.
|
|
19747
|
+
* @example role_not_found
|
|
19748
|
+
* @constant
|
|
19749
|
+
*/
|
|
19750
|
+
code: "role_not_found";
|
|
19751
|
+
/**
|
|
19752
|
+
* @description A human-readable description of the error.
|
|
19753
|
+
* @example Request could not be processed.
|
|
19754
|
+
*/
|
|
19755
|
+
message: string;
|
|
19756
|
+
} | {
|
|
19757
|
+
/**
|
|
19758
|
+
* @description The error code identifying the type of error.
|
|
19759
|
+
* @example organization_not_found
|
|
19760
|
+
* @constant
|
|
19761
|
+
*/
|
|
19762
|
+
code: "organization_not_found";
|
|
19763
|
+
/**
|
|
19764
|
+
* @description A human-readable description of the error.
|
|
19765
|
+
* @example Request could not be processed.
|
|
19766
|
+
*/
|
|
19767
|
+
message: string;
|
|
19768
|
+
};
|
|
19769
|
+
};
|
|
19770
|
+
};
|
|
19771
|
+
};
|
|
19772
|
+
};
|
|
19773
|
+
AgentBlueprintsTokenController_mintToken: {
|
|
19774
|
+
parameters: {
|
|
19775
|
+
query?: never;
|
|
19776
|
+
header?: never;
|
|
19777
|
+
path: {
|
|
19778
|
+
/** @description The unique ID of the agent blueprint. */
|
|
19779
|
+
agent_blueprint_id: string;
|
|
19780
|
+
};
|
|
19781
|
+
cookie?: never;
|
|
19782
|
+
};
|
|
19783
|
+
requestBody: {
|
|
19784
|
+
content: {
|
|
19785
|
+
"application/json": {
|
|
19786
|
+
/**
|
|
19787
|
+
* @description How the session is minted: `user_delegated`, `autonomous`, `agent_delegated`, or `refresh`.
|
|
19788
|
+
* @constant
|
|
19789
|
+
*/
|
|
19790
|
+
type: "user_delegated";
|
|
19791
|
+
/**
|
|
19792
|
+
* @description The access token of the user delegating to the agent. The token identifies the user and organization; effective permissions are resolved server-side.
|
|
19793
|
+
* @example eyJhbGciOiJSUzI1NiIsImtpZCI6...
|
|
19794
|
+
*/
|
|
19795
|
+
user_access_token: string;
|
|
19796
|
+
/**
|
|
19797
|
+
* @description Optional caller-supplied context, echoed as an object with a `text` field in the `intent` claim of the minted access token.
|
|
19798
|
+
* @example renew-contract-123
|
|
19799
|
+
*/
|
|
19800
|
+
intent?: string;
|
|
19801
|
+
} | {
|
|
19802
|
+
/**
|
|
19803
|
+
* @description How the session is minted: `user_delegated`, `autonomous`, `agent_delegated`, or `refresh`.
|
|
19804
|
+
* @constant
|
|
19805
|
+
*/
|
|
19806
|
+
type: "autonomous";
|
|
19807
|
+
/**
|
|
19808
|
+
* @description The organization the agent acts within when operating as itself.
|
|
19809
|
+
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
19810
|
+
*/
|
|
19811
|
+
organization_id: string;
|
|
19812
|
+
/**
|
|
19813
|
+
* @description Optional caller-supplied context, echoed as an object with a `text` field in the `intent` claim of the minted access token.
|
|
19814
|
+
* @example renew-contract-123
|
|
19815
|
+
*/
|
|
19816
|
+
intent?: string;
|
|
19817
|
+
} | {
|
|
19818
|
+
/**
|
|
19819
|
+
* @description How the session is minted: `user_delegated`, `autonomous`, `agent_delegated`, or `refresh`.
|
|
19820
|
+
* @constant
|
|
19821
|
+
*/
|
|
19822
|
+
type: "agent_delegated";
|
|
19823
|
+
/**
|
|
19824
|
+
* @description The agent's own access token to exchange for a new session on the same instance. The token must have been minted from this blueprint; permissions are re-derived from current authority.
|
|
19825
|
+
* @example eyJhbGciOiJSUzI1NiIsImtpZCI6...
|
|
19826
|
+
*/
|
|
19827
|
+
agent_access_token: string;
|
|
19828
|
+
/**
|
|
19829
|
+
* @description Optional caller-supplied context, echoed as an object with a `text` field in the `intent` claim of the minted access token.
|
|
19830
|
+
* @example renew-contract-123
|
|
19831
|
+
*/
|
|
19832
|
+
intent?: string;
|
|
19833
|
+
} | {
|
|
19834
|
+
/**
|
|
19835
|
+
* @description How the session is minted: `user_delegated`, `autonomous`, `agent_delegated`, or `refresh`.
|
|
19836
|
+
* @constant
|
|
19837
|
+
*/
|
|
19838
|
+
type: "refresh";
|
|
19839
|
+
/**
|
|
19840
|
+
* @description The refresh token issued with a previous agent access token. Refresh tokens are single-use: each refresh rotates it.
|
|
19841
|
+
* @example njGkA8Wyht0GBEGGA0Zh1Q3wZzL2...
|
|
19842
|
+
*/
|
|
19843
|
+
refresh_token: string;
|
|
19844
|
+
/**
|
|
19845
|
+
* @description Optional caller-supplied context, echoed as an object with a `text` field in the `intent` claim of the minted access token.
|
|
19846
|
+
* @example renew-contract-123
|
|
19847
|
+
*/
|
|
19848
|
+
intent?: string;
|
|
19849
|
+
};
|
|
19850
|
+
};
|
|
19851
|
+
};
|
|
19852
|
+
responses: {
|
|
19853
|
+
/** @description OK */
|
|
19854
|
+
200: {
|
|
19855
|
+
headers: {
|
|
19856
|
+
[name: string]: unknown;
|
|
19857
|
+
};
|
|
19858
|
+
content: {
|
|
19859
|
+
"application/json": components["schemas"]["AgentToken"];
|
|
19860
|
+
};
|
|
19861
|
+
};
|
|
19862
|
+
/** @description Bad Request */
|
|
19863
|
+
400: {
|
|
19864
|
+
headers: {
|
|
19865
|
+
[name: string]: unknown;
|
|
19866
|
+
};
|
|
19867
|
+
content: {
|
|
19868
|
+
"application/json": {
|
|
19869
|
+
/**
|
|
19870
|
+
* @description The error code identifying the type of error.
|
|
19871
|
+
* @example invalid_request
|
|
19872
|
+
* @constant
|
|
19873
|
+
*/
|
|
19874
|
+
code: "invalid_request";
|
|
19875
|
+
/**
|
|
19876
|
+
* @description A human-readable description of the error.
|
|
19877
|
+
* @example Request could not be processed.
|
|
19878
|
+
*/
|
|
19879
|
+
message: string;
|
|
19880
|
+
} | {
|
|
19881
|
+
/**
|
|
19882
|
+
* @description The error code identifying the type of error.
|
|
19883
|
+
* @example invalid_user_access_token
|
|
19884
|
+
* @constant
|
|
19885
|
+
*/
|
|
19886
|
+
code: "invalid_user_access_token";
|
|
19887
|
+
/**
|
|
19888
|
+
* @description A human-readable description of the error.
|
|
19889
|
+
* @example Request could not be processed.
|
|
19890
|
+
*/
|
|
19891
|
+
message: string;
|
|
19892
|
+
} | {
|
|
19893
|
+
/**
|
|
19894
|
+
* @description The error code identifying the type of error.
|
|
19895
|
+
* @example invalid_agent_access_token
|
|
19896
|
+
* @constant
|
|
19897
|
+
*/
|
|
19898
|
+
code: "invalid_agent_access_token";
|
|
19899
|
+
/**
|
|
19900
|
+
* @description A human-readable description of the error.
|
|
19901
|
+
* @example Request could not be processed.
|
|
19902
|
+
*/
|
|
19903
|
+
message: string;
|
|
19904
|
+
} | {
|
|
19905
|
+
/**
|
|
19906
|
+
* @description The error code identifying the type of error.
|
|
19907
|
+
* @example invalid_refresh_token
|
|
19908
|
+
* @constant
|
|
19909
|
+
*/
|
|
19910
|
+
code: "invalid_refresh_token";
|
|
19911
|
+
/**
|
|
19912
|
+
* @description A human-readable description of the error.
|
|
19913
|
+
* @example Request could not be processed.
|
|
19914
|
+
*/
|
|
19915
|
+
message: string;
|
|
19916
|
+
} | {
|
|
19917
|
+
/**
|
|
19918
|
+
* @description The error code identifying the type of error.
|
|
19919
|
+
* @example session_revoked
|
|
19920
|
+
* @constant
|
|
19921
|
+
*/
|
|
19922
|
+
code: "session_revoked";
|
|
19923
|
+
/**
|
|
19924
|
+
* @description A human-readable description of the error.
|
|
19925
|
+
* @example Request could not be processed.
|
|
19926
|
+
*/
|
|
19927
|
+
message: string;
|
|
19928
|
+
} | {
|
|
19929
|
+
/**
|
|
19930
|
+
* @description The error code identifying the type of error.
|
|
19931
|
+
* @example session_expired
|
|
19932
|
+
* @constant
|
|
19933
|
+
*/
|
|
19934
|
+
code: "session_expired";
|
|
19935
|
+
/**
|
|
19936
|
+
* @description A human-readable description of the error.
|
|
19937
|
+
* @example Request could not be processed.
|
|
19938
|
+
*/
|
|
19939
|
+
message: string;
|
|
19940
|
+
} | {
|
|
19941
|
+
/**
|
|
19942
|
+
* @description The error code identifying the type of error.
|
|
19943
|
+
* @example user_session_ended
|
|
19944
|
+
* @constant
|
|
19945
|
+
*/
|
|
19946
|
+
code: "user_session_ended";
|
|
19947
|
+
/**
|
|
19948
|
+
* @description A human-readable description of the error.
|
|
19949
|
+
* @example Request could not be processed.
|
|
19950
|
+
*/
|
|
19951
|
+
message: string;
|
|
19952
|
+
} | {
|
|
19953
|
+
/**
|
|
19954
|
+
* @description The error code identifying the type of error.
|
|
19955
|
+
* @example max_age_exceeded
|
|
19956
|
+
* @constant
|
|
19957
|
+
*/
|
|
19958
|
+
code: "max_age_exceeded";
|
|
19959
|
+
/**
|
|
19960
|
+
* @description A human-readable description of the error.
|
|
19961
|
+
* @example Request could not be processed.
|
|
19962
|
+
*/
|
|
19963
|
+
message: string;
|
|
19964
|
+
} | {
|
|
19965
|
+
/**
|
|
19966
|
+
* @description The error code identifying the type of error.
|
|
19967
|
+
* @example session_settings_not_found
|
|
19968
|
+
* @constant
|
|
19969
|
+
*/
|
|
19970
|
+
code: "session_settings_not_found";
|
|
19971
|
+
/**
|
|
19972
|
+
* @description A human-readable description of the error.
|
|
19973
|
+
* @example Request could not be processed.
|
|
19974
|
+
*/
|
|
19975
|
+
message: string;
|
|
19976
|
+
} | {
|
|
19977
|
+
/**
|
|
19978
|
+
* @description The error code identifying the type of error.
|
|
19979
|
+
* @example chain_depth_exceeded
|
|
19980
|
+
* @constant
|
|
19981
|
+
*/
|
|
19982
|
+
code: "chain_depth_exceeded";
|
|
19983
|
+
/**
|
|
19984
|
+
* @description A human-readable description of the error.
|
|
19985
|
+
* @example Request could not be processed.
|
|
19986
|
+
*/
|
|
19987
|
+
message: string;
|
|
19988
|
+
};
|
|
19989
|
+
};
|
|
19990
|
+
};
|
|
19991
|
+
/** @description Forbidden */
|
|
19992
|
+
403: {
|
|
19993
|
+
headers: {
|
|
19994
|
+
[name: string]: unknown;
|
|
19995
|
+
};
|
|
19996
|
+
content: {
|
|
19997
|
+
"application/json": {
|
|
19998
|
+
/**
|
|
19999
|
+
* @description The error code identifying the type of error.
|
|
20000
|
+
* @example user_not_member_of_organization
|
|
20001
|
+
* @constant
|
|
20002
|
+
*/
|
|
20003
|
+
code: "user_not_member_of_organization";
|
|
20004
|
+
/**
|
|
20005
|
+
* @description A human-readable description of the error.
|
|
20006
|
+
* @example Request could not be processed.
|
|
20007
|
+
*/
|
|
20008
|
+
message: string;
|
|
20009
|
+
} | {
|
|
20010
|
+
/**
|
|
20011
|
+
* @description The error code identifying the type of error.
|
|
20012
|
+
* @example organization_not_invocable
|
|
20013
|
+
* @constant
|
|
20014
|
+
*/
|
|
20015
|
+
code: "organization_not_invocable";
|
|
20016
|
+
/**
|
|
20017
|
+
* @description A human-readable description of the error.
|
|
20018
|
+
* @example Request could not be processed.
|
|
20019
|
+
*/
|
|
20020
|
+
message: string;
|
|
20021
|
+
} | {
|
|
20022
|
+
/**
|
|
20023
|
+
* @description The error code identifying the type of error.
|
|
20024
|
+
* @example role_not_invocable
|
|
20025
|
+
* @constant
|
|
20026
|
+
*/
|
|
20027
|
+
code: "role_not_invocable";
|
|
20028
|
+
/**
|
|
20029
|
+
* @description A human-readable description of the error.
|
|
20030
|
+
* @example Request could not be processed.
|
|
20031
|
+
*/
|
|
20032
|
+
message: string;
|
|
20033
|
+
};
|
|
20034
|
+
};
|
|
20035
|
+
};
|
|
20036
|
+
/** @description Not Found */
|
|
20037
|
+
404: {
|
|
20038
|
+
headers: {
|
|
20039
|
+
[name: string]: unknown;
|
|
20040
|
+
};
|
|
20041
|
+
content: {
|
|
20042
|
+
"application/json": {
|
|
20043
|
+
/**
|
|
20044
|
+
* @description A human-readable description of the error.
|
|
20045
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
20046
|
+
*/
|
|
20047
|
+
message: string;
|
|
20048
|
+
};
|
|
20049
|
+
};
|
|
20050
|
+
};
|
|
20051
|
+
};
|
|
20052
|
+
};
|
|
20053
|
+
AgentAdminController_linkClaimAttemptToExternalUser: {
|
|
20054
|
+
parameters: {
|
|
20055
|
+
query?: never;
|
|
20056
|
+
header?: never;
|
|
20057
|
+
path?: never;
|
|
20058
|
+
cookie?: never;
|
|
20059
|
+
};
|
|
20060
|
+
requestBody: {
|
|
20061
|
+
content: {
|
|
20062
|
+
"application/json": {
|
|
20063
|
+
/**
|
|
20064
|
+
* @description The operation to perform on the claim attempt. Currently only `link_external_user` is supported.
|
|
20065
|
+
* @example link_external_user
|
|
20066
|
+
* @constant
|
|
20067
|
+
*/
|
|
20068
|
+
type: "link_external_user";
|
|
20069
|
+
/**
|
|
20070
|
+
* @description The token identifying the claim attempt.
|
|
20071
|
+
* @example cla_tkn_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
20072
|
+
*/
|
|
20073
|
+
claim_attempt_token: string;
|
|
20074
|
+
/**
|
|
20075
|
+
* @description The user to attach to the claim attempt, identified by email and external ID.
|
|
20076
|
+
* @example {
|
|
20077
|
+
* "email": "alice@example.com",
|
|
20078
|
+
* "external_id": "user_abc123"
|
|
20079
|
+
* }
|
|
20080
|
+
*/
|
|
20081
|
+
user: {
|
|
20082
|
+
/**
|
|
20083
|
+
* Format: email
|
|
20084
|
+
* @description The email address of the user.
|
|
20085
|
+
* @example alice@example.com
|
|
20086
|
+
*/
|
|
20087
|
+
email: string;
|
|
20088
|
+
/**
|
|
20089
|
+
* @description The external ID of the user.
|
|
20090
|
+
* @example user_abc123
|
|
20091
|
+
*/
|
|
20092
|
+
external_id: string;
|
|
20093
|
+
};
|
|
20094
|
+
/**
|
|
20095
|
+
* @description The organization to place the agent in. Required when the user belongs to more than one organization.
|
|
20096
|
+
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
20097
|
+
*/
|
|
20098
|
+
organization_id?: string;
|
|
20099
|
+
};
|
|
20100
|
+
};
|
|
20101
|
+
};
|
|
20102
|
+
responses: {
|
|
20103
|
+
/** @description Claim attempt linked to external user. */
|
|
20104
|
+
200: {
|
|
20105
|
+
headers: {
|
|
20106
|
+
[name: string]: unknown;
|
|
20107
|
+
};
|
|
20108
|
+
content: {
|
|
20109
|
+
"application/json": components["schemas"]["ClaimViewResponse"];
|
|
20110
|
+
};
|
|
20111
|
+
};
|
|
20112
|
+
/** @description Invalid request, email mismatch, invalid claim, invalid organization, or wrong account. */
|
|
20113
|
+
400: {
|
|
20114
|
+
headers: {
|
|
20115
|
+
[name: string]: unknown;
|
|
20116
|
+
};
|
|
20117
|
+
content: {
|
|
20118
|
+
"application/json": {
|
|
20119
|
+
/**
|
|
20120
|
+
* @description The error code identifying the type of error.
|
|
20121
|
+
* @example invalid_request
|
|
20122
|
+
* @constant
|
|
20123
|
+
*/
|
|
20124
|
+
code: "invalid_request";
|
|
20125
|
+
/**
|
|
20126
|
+
* @description A human-readable description of the error.
|
|
20127
|
+
* @example Request could not be processed.
|
|
20128
|
+
*/
|
|
20129
|
+
message: string;
|
|
20130
|
+
} | {
|
|
20131
|
+
/**
|
|
20132
|
+
* @description The error code identifying the type of error.
|
|
20133
|
+
* @example invalid_claim
|
|
20134
|
+
* @constant
|
|
20135
|
+
*/
|
|
20136
|
+
code: "invalid_claim";
|
|
20137
|
+
/**
|
|
20138
|
+
* @description A human-readable description of the error.
|
|
20139
|
+
* @example Request could not be processed.
|
|
20140
|
+
*/
|
|
20141
|
+
message: string;
|
|
20142
|
+
} | {
|
|
20143
|
+
/**
|
|
20144
|
+
* @description The error code identifying the type of error.
|
|
20145
|
+
* @example invalid_organization
|
|
20146
|
+
* @constant
|
|
20147
|
+
*/
|
|
20148
|
+
code: "invalid_organization";
|
|
20149
|
+
/**
|
|
20150
|
+
* @description A human-readable description of the error.
|
|
20151
|
+
* @example Request could not be processed.
|
|
20152
|
+
*/
|
|
20153
|
+
message: string;
|
|
20154
|
+
} | {
|
|
20155
|
+
/**
|
|
20156
|
+
* @description The error code identifying the type of error.
|
|
20157
|
+
* @example email_mismatch
|
|
20158
|
+
* @constant
|
|
20159
|
+
*/
|
|
20160
|
+
code: "email_mismatch";
|
|
20161
|
+
/**
|
|
20162
|
+
* @description A human-readable description of the error.
|
|
20163
|
+
* @example Request could not be processed.
|
|
20164
|
+
*/
|
|
20165
|
+
message: string;
|
|
20166
|
+
} | {
|
|
20167
|
+
/**
|
|
20168
|
+
* @description The error code identifying the type of error.
|
|
20169
|
+
* @example wrong_account
|
|
20170
|
+
* @constant
|
|
20171
|
+
*/
|
|
20172
|
+
code: "wrong_account";
|
|
20173
|
+
/**
|
|
20174
|
+
* @description A human-readable description of the error.
|
|
20175
|
+
* @example Request could not be processed.
|
|
20176
|
+
*/
|
|
20177
|
+
message: string;
|
|
20178
|
+
};
|
|
20179
|
+
};
|
|
20180
|
+
};
|
|
20181
|
+
/** @description Claim denied or auth method disabled. */
|
|
20182
|
+
403: {
|
|
20183
|
+
headers: {
|
|
20184
|
+
[name: string]: unknown;
|
|
20185
|
+
};
|
|
20186
|
+
content: {
|
|
20187
|
+
"application/json": {
|
|
20188
|
+
/**
|
|
20189
|
+
* @description The error code identifying the type of error.
|
|
20190
|
+
* @example claim_denied
|
|
20191
|
+
* @constant
|
|
20192
|
+
*/
|
|
20193
|
+
code: "claim_denied";
|
|
20194
|
+
/**
|
|
20195
|
+
* @description A human-readable description of the error.
|
|
20196
|
+
* @example Request could not be processed.
|
|
20197
|
+
*/
|
|
20198
|
+
message: string;
|
|
20199
|
+
} | {
|
|
20200
|
+
/**
|
|
20201
|
+
* @description The error code identifying the type of error.
|
|
20202
|
+
* @example auth_method_disabled
|
|
20203
|
+
* @constant
|
|
20204
|
+
*/
|
|
20205
|
+
code: "auth_method_disabled";
|
|
20206
|
+
/**
|
|
20207
|
+
* @description A human-readable description of the error.
|
|
20208
|
+
* @example Request could not be processed.
|
|
20209
|
+
*/
|
|
20210
|
+
message: string;
|
|
20211
|
+
};
|
|
20212
|
+
};
|
|
20213
|
+
};
|
|
20214
|
+
/** @description Organization selection required, email already in use, or claim already completed. */
|
|
20215
|
+
409: {
|
|
20216
|
+
headers: {
|
|
20217
|
+
[name: string]: unknown;
|
|
20218
|
+
};
|
|
20219
|
+
content: {
|
|
20220
|
+
"application/json": {
|
|
20221
|
+
/**
|
|
20222
|
+
* @description The error code identifying the type of error.
|
|
20223
|
+
* @example organization_selection_required
|
|
20224
|
+
* @constant
|
|
20225
|
+
*/
|
|
20226
|
+
code: "organization_selection_required";
|
|
20227
|
+
/**
|
|
20228
|
+
* @description A human-readable description of the error.
|
|
20229
|
+
* @example Request could not be processed.
|
|
20230
|
+
*/
|
|
20231
|
+
message: string;
|
|
20232
|
+
/** @description Organizations the user belongs to. Pick one and retry with organization_id. */
|
|
20233
|
+
organizations: {
|
|
20234
|
+
/**
|
|
20235
|
+
* @description The organization ID.
|
|
20236
|
+
* @example org_01EHWNCE74X7JSDV0X3SZ3KJNY
|
|
20237
|
+
*/
|
|
20238
|
+
id: string;
|
|
20239
|
+
/**
|
|
20240
|
+
* @description The organization name.
|
|
20241
|
+
* @example Acme Corp
|
|
20242
|
+
*/
|
|
20243
|
+
name: string;
|
|
20244
|
+
}[];
|
|
20245
|
+
} | {
|
|
20246
|
+
/**
|
|
20247
|
+
* @description The error code identifying the type of error.
|
|
20248
|
+
* @example email_already_in_use
|
|
20249
|
+
* @constant
|
|
20250
|
+
*/
|
|
20251
|
+
code: "email_already_in_use";
|
|
20252
|
+
/**
|
|
20253
|
+
* @description A human-readable description of the error.
|
|
20254
|
+
* @example Request could not be processed.
|
|
20255
|
+
*/
|
|
20256
|
+
message: string;
|
|
20257
|
+
} | {
|
|
20258
|
+
/**
|
|
20259
|
+
* @description The error code identifying the type of error.
|
|
20260
|
+
* @example already_claimed
|
|
20261
|
+
* @constant
|
|
20262
|
+
*/
|
|
20263
|
+
code: "already_claimed";
|
|
20264
|
+
/**
|
|
20265
|
+
* @description A human-readable description of the error.
|
|
20266
|
+
* @example Request could not be processed.
|
|
20267
|
+
*/
|
|
20268
|
+
message: string;
|
|
20269
|
+
};
|
|
20270
|
+
};
|
|
20271
|
+
};
|
|
20272
|
+
/** @description Claim or user code has expired. */
|
|
20273
|
+
410: {
|
|
20274
|
+
headers: {
|
|
20275
|
+
[name: string]: unknown;
|
|
20276
|
+
};
|
|
20277
|
+
content: {
|
|
20278
|
+
"application/json": {
|
|
20279
|
+
/**
|
|
20280
|
+
* @description The error code identifying the type of error.
|
|
20281
|
+
* @example claim_expired
|
|
20282
|
+
* @constant
|
|
20283
|
+
*/
|
|
20284
|
+
code: "claim_expired";
|
|
20285
|
+
/**
|
|
20286
|
+
* @description A human-readable description of the error.
|
|
20287
|
+
* @example Request could not be processed.
|
|
20288
|
+
*/
|
|
20289
|
+
message: string;
|
|
20290
|
+
} | {
|
|
20291
|
+
/**
|
|
20292
|
+
* @description The error code identifying the type of error.
|
|
20293
|
+
* @example user_code_expired
|
|
20294
|
+
* @constant
|
|
20295
|
+
*/
|
|
20296
|
+
code: "user_code_expired";
|
|
20297
|
+
/**
|
|
20298
|
+
* @description A human-readable description of the error.
|
|
20299
|
+
* @example Request could not be processed.
|
|
20300
|
+
*/
|
|
20301
|
+
message: string;
|
|
20302
|
+
};
|
|
20303
|
+
};
|
|
20304
|
+
};
|
|
20305
|
+
};
|
|
20306
|
+
};
|
|
20307
|
+
AgentAdminController_validateCredential: {
|
|
20308
|
+
parameters: {
|
|
20309
|
+
query?: never;
|
|
20310
|
+
header?: never;
|
|
20311
|
+
path?: never;
|
|
20312
|
+
cookie?: never;
|
|
20313
|
+
};
|
|
20314
|
+
requestBody: {
|
|
20315
|
+
content: {
|
|
20316
|
+
"application/json": {
|
|
20317
|
+
/**
|
|
20318
|
+
* @description The kind of credential being validated — an agent API key or an agent access token.
|
|
20319
|
+
* @constant
|
|
20320
|
+
*/
|
|
20321
|
+
type: "api_key";
|
|
20322
|
+
/**
|
|
20323
|
+
* @description The credential value to validate: the API key value for `api_key`, or the access token (JWT) for `access_token`.
|
|
20324
|
+
* @example sk_agent_example_1234567890
|
|
20325
|
+
*/
|
|
20326
|
+
credential: string;
|
|
20327
|
+
} | {
|
|
20328
|
+
/**
|
|
20329
|
+
* @description The kind of credential being validated — an agent API key or an agent access token.
|
|
20330
|
+
* @constant
|
|
20331
|
+
*/
|
|
20332
|
+
type: "access_token";
|
|
20333
|
+
/**
|
|
20334
|
+
* @description The credential value to validate: the API key value for `api_key`, or the access token (JWT) for `access_token`.
|
|
20335
|
+
* @example eyJhbGciOiJSUzI1NiIsImtpZCI6...
|
|
20336
|
+
*/
|
|
20337
|
+
credential: string;
|
|
20338
|
+
/**
|
|
20339
|
+
* @description When provided, the access token's `aud` claim is verified against this value. Tokens issued for a different resource are rejected.
|
|
20340
|
+
* @example https://api.example.com
|
|
20341
|
+
*/
|
|
20342
|
+
audience?: string;
|
|
20343
|
+
};
|
|
20344
|
+
};
|
|
20345
|
+
};
|
|
20346
|
+
responses: {
|
|
20347
|
+
/** @description OK */
|
|
20348
|
+
200: {
|
|
20349
|
+
headers: {
|
|
20350
|
+
[name: string]: unknown;
|
|
20351
|
+
};
|
|
20352
|
+
content: {
|
|
20353
|
+
"application/json": components["schemas"]["AgentCredentialValidation"];
|
|
20354
|
+
};
|
|
20355
|
+
};
|
|
20356
|
+
/** @description Bad Request */
|
|
20357
|
+
400: {
|
|
20358
|
+
headers: {
|
|
20359
|
+
[name: string]: unknown;
|
|
20360
|
+
};
|
|
20361
|
+
content: {
|
|
20362
|
+
"application/json": {
|
|
20363
|
+
/**
|
|
20364
|
+
* @description The error code identifying the type of error.
|
|
20365
|
+
* @example invalid_request
|
|
20366
|
+
* @constant
|
|
20367
|
+
*/
|
|
20368
|
+
code: "invalid_request";
|
|
20369
|
+
/**
|
|
20370
|
+
* @description A human-readable description of the error.
|
|
20371
|
+
* @example Request could not be processed.
|
|
20372
|
+
*/
|
|
20373
|
+
message: string;
|
|
20374
|
+
};
|
|
20375
|
+
};
|
|
20376
|
+
};
|
|
20377
|
+
};
|
|
20378
|
+
};
|
|
20379
|
+
AgentInstancesController_list: {
|
|
20380
|
+
parameters: {
|
|
20381
|
+
query?: {
|
|
20382
|
+
/** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `before="obj_123"` to fetch a new batch of objects before `"obj_123"`. */
|
|
20383
|
+
before?: string;
|
|
20384
|
+
/** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `after="obj_123"` to fetch a new batch of objects after `"obj_123"`. */
|
|
20385
|
+
after?: string;
|
|
20386
|
+
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
20387
|
+
limit?: number;
|
|
20388
|
+
/** @description Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to `normal`. */
|
|
20389
|
+
order?: components["schemas"]["PaginationOrder"];
|
|
20390
|
+
/** @description Only return instances acting within this organization. */
|
|
20391
|
+
organization_id?: string;
|
|
20392
|
+
/** @description Only return instances minted from this blueprint. */
|
|
20393
|
+
agent_blueprint_id?: string;
|
|
20394
|
+
};
|
|
20395
|
+
header?: never;
|
|
20396
|
+
path?: never;
|
|
20397
|
+
cookie?: never;
|
|
20398
|
+
};
|
|
20399
|
+
requestBody?: never;
|
|
20400
|
+
responses: {
|
|
20401
|
+
/** @description OK */
|
|
20402
|
+
200: {
|
|
20403
|
+
headers: {
|
|
20404
|
+
[name: string]: unknown;
|
|
20405
|
+
};
|
|
20406
|
+
content: {
|
|
20407
|
+
"application/json": {
|
|
20408
|
+
/**
|
|
20409
|
+
* @description Indicates this is a list response.
|
|
20410
|
+
* @constant
|
|
20411
|
+
*/
|
|
20412
|
+
object?: "list";
|
|
20413
|
+
/** @description Pagination cursors for navigating between pages of results. */
|
|
20414
|
+
list_metadata?: {
|
|
20415
|
+
/**
|
|
20416
|
+
* @description An object ID that defines your place in the list. When the ID is not present, you are at the start of the list.
|
|
20417
|
+
* @example agent_01HXYZ123456789ABCDEFGHIJ
|
|
20418
|
+
*/
|
|
20419
|
+
before: string | null;
|
|
20420
|
+
/**
|
|
20421
|
+
* @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
|
|
20422
|
+
* @example agent_01HXYZ987654321KJIHGFEDCBA
|
|
20423
|
+
*/
|
|
20424
|
+
after: string | null;
|
|
20425
|
+
};
|
|
20426
|
+
} & {
|
|
20427
|
+
/** @description The list of records for the current page. */
|
|
20428
|
+
data?: components["schemas"]["AgentInstance"][];
|
|
20429
|
+
};
|
|
20430
|
+
};
|
|
20431
|
+
};
|
|
20432
|
+
/** @description Unauthorized */
|
|
20433
|
+
401: {
|
|
20434
|
+
headers: {
|
|
20435
|
+
[name: string]: unknown;
|
|
20436
|
+
};
|
|
20437
|
+
content: {
|
|
20438
|
+
"application/json": {
|
|
20439
|
+
/**
|
|
20440
|
+
* @description A human-readable description of the error.
|
|
20441
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
20442
|
+
*/
|
|
20443
|
+
message: string;
|
|
20444
|
+
};
|
|
20445
|
+
};
|
|
20446
|
+
};
|
|
20447
|
+
};
|
|
20448
|
+
};
|
|
20449
|
+
AgentInstancesController_get: {
|
|
20450
|
+
parameters: {
|
|
20451
|
+
query?: never;
|
|
20452
|
+
header?: never;
|
|
20453
|
+
path: {
|
|
20454
|
+
/** @description The unique ID of the agent instance. */
|
|
20455
|
+
agent_instance_id: string;
|
|
20456
|
+
};
|
|
20457
|
+
cookie?: never;
|
|
20458
|
+
};
|
|
20459
|
+
requestBody?: never;
|
|
20460
|
+
responses: {
|
|
20461
|
+
/** @description OK */
|
|
20462
|
+
200: {
|
|
20463
|
+
headers: {
|
|
20464
|
+
[name: string]: unknown;
|
|
20465
|
+
};
|
|
20466
|
+
content: {
|
|
20467
|
+
"application/json": components["schemas"]["AgentInstance"];
|
|
20468
|
+
};
|
|
20469
|
+
};
|
|
20470
|
+
/** @description Not Found */
|
|
20471
|
+
404: {
|
|
20472
|
+
headers: {
|
|
20473
|
+
[name: string]: unknown;
|
|
20474
|
+
};
|
|
20475
|
+
content: {
|
|
20476
|
+
"application/json": {
|
|
20477
|
+
/**
|
|
20478
|
+
* @description A human-readable description of the error.
|
|
20479
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
20480
|
+
*/
|
|
20481
|
+
message: string;
|
|
20482
|
+
};
|
|
20483
|
+
};
|
|
20484
|
+
};
|
|
20485
|
+
};
|
|
20486
|
+
};
|
|
20487
|
+
AgentInstancesController_delete: {
|
|
20488
|
+
parameters: {
|
|
20489
|
+
query?: never;
|
|
20490
|
+
header?: never;
|
|
20491
|
+
path: {
|
|
20492
|
+
/** @description The unique ID of the agent instance. */
|
|
20493
|
+
agent_instance_id: string;
|
|
20494
|
+
};
|
|
20495
|
+
cookie?: never;
|
|
20496
|
+
};
|
|
20497
|
+
requestBody?: never;
|
|
20498
|
+
responses: {
|
|
20499
|
+
/** @description Agent instance deleted. */
|
|
20500
|
+
204: {
|
|
20501
|
+
headers: {
|
|
20502
|
+
[name: string]: unknown;
|
|
20503
|
+
};
|
|
20504
|
+
content?: never;
|
|
20505
|
+
};
|
|
20506
|
+
/** @description Not Found */
|
|
20507
|
+
404: {
|
|
20508
|
+
headers: {
|
|
20509
|
+
[name: string]: unknown;
|
|
20510
|
+
};
|
|
20511
|
+
content: {
|
|
20512
|
+
"application/json": {
|
|
20513
|
+
/**
|
|
20514
|
+
* @description A human-readable description of the error.
|
|
20515
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
20516
|
+
*/
|
|
20517
|
+
message: string;
|
|
20518
|
+
};
|
|
20519
|
+
};
|
|
20520
|
+
};
|
|
20521
|
+
};
|
|
20522
|
+
};
|
|
20523
|
+
AgentAdminController_getRegistration: {
|
|
20524
|
+
parameters: {
|
|
20525
|
+
query?: never;
|
|
20526
|
+
header?: never;
|
|
20527
|
+
path: {
|
|
20528
|
+
/** @description The unique ID of the agent registration. */
|
|
20529
|
+
id: string;
|
|
20530
|
+
};
|
|
20531
|
+
cookie?: never;
|
|
20532
|
+
};
|
|
20533
|
+
requestBody?: never;
|
|
20534
|
+
responses: {
|
|
20535
|
+
/** @description OK */
|
|
19233
20536
|
200: {
|
|
19234
20537
|
headers: {
|
|
19235
20538
|
[name: string]: unknown;
|
|
@@ -19255,6 +20558,180 @@ export interface operations {
|
|
|
19255
20558
|
};
|
|
19256
20559
|
};
|
|
19257
20560
|
};
|
|
20561
|
+
AgentInstanceSessionsController_list: {
|
|
20562
|
+
parameters: {
|
|
20563
|
+
query?: {
|
|
20564
|
+
/** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `before="obj_123"` to fetch a new batch of objects before `"obj_123"`. */
|
|
20565
|
+
before?: string;
|
|
20566
|
+
/** @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `"obj_123"`, your subsequent call can include `after="obj_123"` to fetch a new batch of objects after `"obj_123"`. */
|
|
20567
|
+
after?: string;
|
|
20568
|
+
/** @description Upper limit on the number of objects to return, between `1` and `100`. */
|
|
20569
|
+
limit?: number;
|
|
20570
|
+
/** @description Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to `normal`. */
|
|
20571
|
+
order?: components["schemas"]["PaginationOrder"];
|
|
20572
|
+
/** @description Only return sessions of instances minted from this blueprint. */
|
|
20573
|
+
agent_blueprint_id?: string;
|
|
20574
|
+
/** @description Only return sessions belonging to this agent instance. */
|
|
20575
|
+
agent_instance_id?: string;
|
|
20576
|
+
};
|
|
20577
|
+
header?: never;
|
|
20578
|
+
path?: never;
|
|
20579
|
+
cookie?: never;
|
|
20580
|
+
};
|
|
20581
|
+
requestBody?: never;
|
|
20582
|
+
responses: {
|
|
20583
|
+
/** @description OK */
|
|
20584
|
+
200: {
|
|
20585
|
+
headers: {
|
|
20586
|
+
[name: string]: unknown;
|
|
20587
|
+
};
|
|
20588
|
+
content: {
|
|
20589
|
+
"application/json": {
|
|
20590
|
+
/**
|
|
20591
|
+
* @description Indicates this is a list response.
|
|
20592
|
+
* @constant
|
|
20593
|
+
*/
|
|
20594
|
+
object?: "list";
|
|
20595
|
+
/** @description Pagination cursors for navigating between pages of results. */
|
|
20596
|
+
list_metadata?: {
|
|
20597
|
+
/**
|
|
20598
|
+
* @description An object ID that defines your place in the list. When the ID is not present, you are at the start of the list.
|
|
20599
|
+
* @example agent_session_01HXYZ123456789ABCDEFGHIJ
|
|
20600
|
+
*/
|
|
20601
|
+
before: string | null;
|
|
20602
|
+
/**
|
|
20603
|
+
* @description An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
|
|
20604
|
+
* @example agent_session_01HXYZ987654321KJIHGFEDCBA
|
|
20605
|
+
*/
|
|
20606
|
+
after: string | null;
|
|
20607
|
+
};
|
|
20608
|
+
} & {
|
|
20609
|
+
/** @description The list of records for the current page. */
|
|
20610
|
+
data?: components["schemas"]["AgentInstanceSession"][];
|
|
20611
|
+
};
|
|
20612
|
+
};
|
|
20613
|
+
};
|
|
20614
|
+
/** @description Unauthorized */
|
|
20615
|
+
401: {
|
|
20616
|
+
headers: {
|
|
20617
|
+
[name: string]: unknown;
|
|
20618
|
+
};
|
|
20619
|
+
content: {
|
|
20620
|
+
"application/json": {
|
|
20621
|
+
/**
|
|
20622
|
+
* @description A human-readable description of the error.
|
|
20623
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
20624
|
+
*/
|
|
20625
|
+
message: string;
|
|
20626
|
+
};
|
|
20627
|
+
};
|
|
20628
|
+
};
|
|
20629
|
+
/** @description Unprocessable Entity */
|
|
20630
|
+
422: {
|
|
20631
|
+
headers: {
|
|
20632
|
+
[name: string]: unknown;
|
|
20633
|
+
};
|
|
20634
|
+
content: {
|
|
20635
|
+
"application/json": {
|
|
20636
|
+
/**
|
|
20637
|
+
* @description A human-readable description of the error.
|
|
20638
|
+
* @example Validation failed.
|
|
20639
|
+
*/
|
|
20640
|
+
message: string;
|
|
20641
|
+
/** @description The list of validation errors. */
|
|
20642
|
+
errors: {
|
|
20643
|
+
/**
|
|
20644
|
+
* @description The validation error code.
|
|
20645
|
+
* @example required
|
|
20646
|
+
*/
|
|
20647
|
+
code: string;
|
|
20648
|
+
/**
|
|
20649
|
+
* @description The field that failed validation.
|
|
20650
|
+
* @example event.action
|
|
20651
|
+
*/
|
|
20652
|
+
field: string;
|
|
20653
|
+
}[];
|
|
20654
|
+
};
|
|
20655
|
+
};
|
|
20656
|
+
};
|
|
20657
|
+
};
|
|
20658
|
+
};
|
|
20659
|
+
AgentInstanceSessionsController_get: {
|
|
20660
|
+
parameters: {
|
|
20661
|
+
query?: never;
|
|
20662
|
+
header?: never;
|
|
20663
|
+
path: {
|
|
20664
|
+
/** @description The unique ID of the agent instance session. */
|
|
20665
|
+
agent_instance_session_id: string;
|
|
20666
|
+
};
|
|
20667
|
+
cookie?: never;
|
|
20668
|
+
};
|
|
20669
|
+
requestBody?: never;
|
|
20670
|
+
responses: {
|
|
20671
|
+
/** @description OK */
|
|
20672
|
+
200: {
|
|
20673
|
+
headers: {
|
|
20674
|
+
[name: string]: unknown;
|
|
20675
|
+
};
|
|
20676
|
+
content: {
|
|
20677
|
+
"application/json": components["schemas"]["AgentInstanceSession"];
|
|
20678
|
+
};
|
|
20679
|
+
};
|
|
20680
|
+
/** @description Not Found */
|
|
20681
|
+
404: {
|
|
20682
|
+
headers: {
|
|
20683
|
+
[name: string]: unknown;
|
|
20684
|
+
};
|
|
20685
|
+
content: {
|
|
20686
|
+
"application/json": {
|
|
20687
|
+
/**
|
|
20688
|
+
* @description A human-readable description of the error.
|
|
20689
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
20690
|
+
*/
|
|
20691
|
+
message: string;
|
|
20692
|
+
};
|
|
20693
|
+
};
|
|
20694
|
+
};
|
|
20695
|
+
};
|
|
20696
|
+
};
|
|
20697
|
+
AgentInstanceSessionsController_revoke: {
|
|
20698
|
+
parameters: {
|
|
20699
|
+
query?: never;
|
|
20700
|
+
header?: never;
|
|
20701
|
+
path: {
|
|
20702
|
+
/** @description The unique ID of the agent instance session. */
|
|
20703
|
+
agent_instance_session_id: string;
|
|
20704
|
+
};
|
|
20705
|
+
cookie?: never;
|
|
20706
|
+
};
|
|
20707
|
+
requestBody?: never;
|
|
20708
|
+
responses: {
|
|
20709
|
+
/** @description OK */
|
|
20710
|
+
200: {
|
|
20711
|
+
headers: {
|
|
20712
|
+
[name: string]: unknown;
|
|
20713
|
+
};
|
|
20714
|
+
content: {
|
|
20715
|
+
"application/json": components["schemas"]["AgentInstanceSession"];
|
|
20716
|
+
};
|
|
20717
|
+
};
|
|
20718
|
+
/** @description Not Found */
|
|
20719
|
+
404: {
|
|
20720
|
+
headers: {
|
|
20721
|
+
[name: string]: unknown;
|
|
20722
|
+
};
|
|
20723
|
+
content: {
|
|
20724
|
+
"application/json": {
|
|
20725
|
+
/**
|
|
20726
|
+
* @description A human-readable description of the error.
|
|
20727
|
+
* @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
|
|
20728
|
+
*/
|
|
20729
|
+
message: string;
|
|
20730
|
+
};
|
|
20731
|
+
};
|
|
20732
|
+
};
|
|
20733
|
+
};
|
|
20734
|
+
};
|
|
19258
20735
|
ApiKeysController_validateApiKey: {
|
|
19259
20736
|
parameters: {
|
|
19260
20737
|
query?: never;
|