asteroid-odyssey 1.2.3 → 1.3.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.
@@ -1,641 +0,0 @@
1
- /**
2
- * Request to execute an agent with specific parameters
3
- */
4
- export type AgentExecutionRequest = {
5
- [key: string]: unknown;
6
- };
7
- export type ExecutionResponse = {
8
- /**
9
- * The ID of the execution
10
- */
11
- execution_id: string;
12
- };
13
- export type ExecutionStatusResponse = {
14
- /**
15
- * The ID of the execution
16
- */
17
- execution_id: string;
18
- status: Status;
19
- /**
20
- * Reason for the current status (if applicable)
21
- */
22
- reason?: string;
23
- /**
24
- * Time when the status was last updated
25
- */
26
- updated_at?: string;
27
- };
28
- export type ExecutionResultResponse = {
29
- /**
30
- * The ID of the execution
31
- */
32
- execution_id: string;
33
- status: Status;
34
- /**
35
- * (Deprecated, use execution_result instead) The structured result data from the execution. Contains the outcome, reasoning, final answer, and result.
36
- * @deprecated
37
- */
38
- result?: {
39
- [key: string]: unknown;
40
- };
41
- /**
42
- * Error message (if execution failed)
43
- */
44
- error?: string;
45
- execution_result?: ExecutionResult;
46
- };
47
- /**
48
- * The result of an execution. Contains the outcome, reasoning, and result.
49
- */
50
- export type ExecutionResult = {
51
- /**
52
- * The outcome of the execution (success or failure)
53
- */
54
- outcome?: 'success' | 'failure';
55
- /**
56
- * The reasoning behind the execution outcome
57
- */
58
- reasoning?: string;
59
- /**
60
- * The structured result data from the execution. This will follow the format defined in the result_schema of the agent.
61
- */
62
- result?: {
63
- [key: string]: unknown;
64
- };
65
- };
66
- /**
67
- * Status of the execution
68
- */
69
- export type Status = 'starting' | 'running' | 'paused' | 'completed' | 'cancelled' | 'failed' | 'awaiting_confirmation' | 'paused_by_agent';
70
- export type ErrorResponse = {
71
- /**
72
- * Error message
73
- */
74
- error: string;
75
- };
76
- export type BrowserSessionRecordingResponse = {
77
- /**
78
- * The URL of the browser session recording
79
- */
80
- recording_url: string;
81
- };
82
- /**
83
- * Request to execute an agent with structured parameters including optional agent profile configuration
84
- */
85
- export type StructuredAgentExecutionRequest = {
86
- /**
87
- * The ID of the browser profile to use
88
- */
89
- agent_profile_id?: string;
90
- /**
91
- * Dynamic data to be merged into the saved agent configuration.
92
- */
93
- dynamic_data?: {
94
- [key: string]: unknown;
95
- };
96
- };
97
- export type AgentProfile = {
98
- /**
99
- * Unique identifier for the agent profile
100
- */
101
- id: string;
102
- /**
103
- * Name of the agent profile (unique within organization)
104
- */
105
- name: string;
106
- /**
107
- * Description of the agent profile
108
- */
109
- description: string;
110
- /**
111
- * The ID of the organization that the agent profile belongs to
112
- */
113
- organization_id: string;
114
- proxy_cc: CountryCode;
115
- proxy_type: ProxyType;
116
- /**
117
- * Whether the captcha solver is active for this profile
118
- */
119
- captcha_solver_active: boolean;
120
- /**
121
- * Whether the same IP address should be used for all executions of this profile
122
- */
123
- sticky_ip: boolean;
124
- /**
125
- * List of credentials associated with this agent profile
126
- */
127
- credentials: Array<Credential>;
128
- /**
129
- * The date and time the agent profile was created
130
- */
131
- created_at: string;
132
- /**
133
- * The last update time of the agent profile
134
- */
135
- updated_at: string;
136
- };
137
- export type CreateAgentProfileRequest = {
138
- /**
139
- * Name of the agent profile (must be unique within organization)
140
- */
141
- name: string;
142
- /**
143
- * Description of the agent profile
144
- */
145
- description: string;
146
- /**
147
- * The ID of the organization that the agent profile belongs to
148
- */
149
- organization_id: string;
150
- proxy_cc: CountryCode;
151
- proxy_type: ProxyType;
152
- /**
153
- * Whether the captcha solver should be active for this profile
154
- */
155
- captcha_solver_active: boolean;
156
- /**
157
- * Whether the same IP address should be used for all executions of this profile
158
- */
159
- sticky_ip: boolean;
160
- /**
161
- * Optional list of credentials to create with the profile
162
- */
163
- credentials: Array<Credential>;
164
- };
165
- export type UpdateAgentProfileRequest = {
166
- /**
167
- * The name of the agent profile
168
- */
169
- name?: string;
170
- /**
171
- * The description of the agent profile
172
- */
173
- description?: string;
174
- proxy_cc?: CountryCode;
175
- proxy_type?: ProxyType;
176
- /**
177
- * Whether the captcha solver should be active for this profile
178
- */
179
- captcha_solver_active?: boolean;
180
- /**
181
- * Whether the same IP address should be used for all executions of this profile
182
- */
183
- sticky_ip?: boolean;
184
- /**
185
- * Complete list of credentials (replaces existing)
186
- */
187
- credentials?: Array<Credential>;
188
- };
189
- /**
190
- * Two-letter country code for proxy location
191
- */
192
- export type CountryCode = 'us' | 'uk' | 'fr' | 'it' | 'jp' | 'au' | 'de' | 'fi' | 'ca';
193
- /**
194
- * Type of proxy to use
195
- */
196
- export type ProxyType = 'residential' | 'mobile';
197
- export type Credential = {
198
- /**
199
- * The unique identifier for this credential
200
- */
201
- id?: string;
202
- /**
203
- * The credential name
204
- */
205
- name: string;
206
- /**
207
- * The encrypted credential
208
- */
209
- data: string;
210
- /**
211
- * When the credential was created
212
- */
213
- created_at?: string;
214
- };
215
- export type GetOpenApiData = {
216
- body?: never;
217
- path?: never;
218
- query?: never;
219
- url: '/openapi.yaml';
220
- };
221
- export type GetOpenApiResponses = {
222
- /**
223
- * OpenAPI schema
224
- */
225
- 200: unknown;
226
- };
227
- export type UploadExecutionFilesData = {
228
- body: {
229
- /**
230
- * Files to upload to the execution
231
- */
232
- files?: Array<Blob | File>;
233
- };
234
- path: {
235
- /**
236
- * The ID of the execution
237
- */
238
- id: string;
239
- };
240
- query?: never;
241
- url: '/execution/{id}/files';
242
- };
243
- export type UploadExecutionFilesErrors = {
244
- /**
245
- * Bad request
246
- */
247
- 400: ErrorResponse;
248
- /**
249
- * Unauthorized
250
- */
251
- 401: ErrorResponse;
252
- /**
253
- * Execution not found
254
- */
255
- 404: ErrorResponse;
256
- };
257
- export type UploadExecutionFilesError = UploadExecutionFilesErrors[keyof UploadExecutionFilesErrors];
258
- export type UploadExecutionFilesResponses = {
259
- /**
260
- * Files uploaded successfully
261
- */
262
- 200: {
263
- /**
264
- * Success message
265
- */
266
- message?: string;
267
- /**
268
- * IDs of the uploaded files
269
- */
270
- file_ids?: Array<string>;
271
- };
272
- };
273
- export type UploadExecutionFilesResponse = UploadExecutionFilesResponses[keyof UploadExecutionFilesResponses];
274
- export type HealthCheckData = {
275
- body?: never;
276
- path?: never;
277
- query?: never;
278
- url: '/health';
279
- };
280
- export type HealthCheckErrors = {
281
- /**
282
- * API is unhealthy
283
- */
284
- 500: {
285
- /**
286
- * The error message
287
- */
288
- error?: string;
289
- };
290
- };
291
- export type HealthCheckError = HealthCheckErrors[keyof HealthCheckErrors];
292
- export type HealthCheckResponses = {
293
- /**
294
- * API is healthy
295
- */
296
- 200: {
297
- /**
298
- * The health status of the API
299
- */
300
- status?: string;
301
- };
302
- };
303
- export type HealthCheckResponse = HealthCheckResponses[keyof HealthCheckResponses];
304
- export type ExecuteAgentData = {
305
- body: AgentExecutionRequest;
306
- path: {
307
- /**
308
- * The ID of the agent
309
- */
310
- id: string;
311
- };
312
- query?: never;
313
- url: '/agent/{id}';
314
- };
315
- export type ExecuteAgentErrors = {
316
- /**
317
- * Invalid request
318
- */
319
- 400: ErrorResponse;
320
- /**
321
- * Agent not found
322
- */
323
- 404: ErrorResponse;
324
- /**
325
- * Internal server error
326
- */
327
- 500: ErrorResponse;
328
- };
329
- export type ExecuteAgentError = ExecuteAgentErrors[keyof ExecuteAgentErrors];
330
- export type ExecuteAgentResponses = {
331
- /**
332
- * Agent execution started successfully
333
- */
334
- 202: ExecutionResponse;
335
- };
336
- export type ExecuteAgentResponse = ExecuteAgentResponses[keyof ExecuteAgentResponses];
337
- export type ExecuteAgentStructuredData = {
338
- body: StructuredAgentExecutionRequest;
339
- path: {
340
- /**
341
- * The ID of the agent
342
- */
343
- id: string;
344
- };
345
- query?: never;
346
- url: '/agent/{id}/execute';
347
- };
348
- export type ExecuteAgentStructuredErrors = {
349
- /**
350
- * Invalid request
351
- */
352
- 400: ErrorResponse;
353
- /**
354
- * Agent not found
355
- */
356
- 404: ErrorResponse;
357
- /**
358
- * Internal server error
359
- */
360
- 500: ErrorResponse;
361
- };
362
- export type ExecuteAgentStructuredError = ExecuteAgentStructuredErrors[keyof ExecuteAgentStructuredErrors];
363
- export type ExecuteAgentStructuredResponses = {
364
- /**
365
- * Agent execution started successfully
366
- */
367
- 202: ExecutionResponse;
368
- };
369
- export type ExecuteAgentStructuredResponse = ExecuteAgentStructuredResponses[keyof ExecuteAgentStructuredResponses];
370
- export type GetExecutionStatusData = {
371
- body?: never;
372
- path: {
373
- /**
374
- * The ID of the execution
375
- */
376
- id: string;
377
- };
378
- query?: never;
379
- url: '/execution/{id}/status';
380
- };
381
- export type GetExecutionStatusErrors = {
382
- /**
383
- * Execution not found
384
- */
385
- 404: ErrorResponse;
386
- /**
387
- * Internal server error
388
- */
389
- 500: ErrorResponse;
390
- };
391
- export type GetExecutionStatusError = GetExecutionStatusErrors[keyof GetExecutionStatusErrors];
392
- export type GetExecutionStatusResponses = {
393
- /**
394
- * Execution status retrieved successfully
395
- */
396
- 200: ExecutionStatusResponse;
397
- };
398
- export type GetExecutionStatusResponse = GetExecutionStatusResponses[keyof GetExecutionStatusResponses];
399
- export type GetExecutionResultData = {
400
- body?: never;
401
- path: {
402
- /**
403
- * The ID of the execution
404
- */
405
- id: string;
406
- };
407
- query?: never;
408
- url: '/execution/{id}/result';
409
- };
410
- export type GetExecutionResultErrors = {
411
- /**
412
- * Execution not found
413
- */
414
- 404: ErrorResponse;
415
- /**
416
- * Internal server error
417
- */
418
- 500: ErrorResponse;
419
- };
420
- export type GetExecutionResultError = GetExecutionResultErrors[keyof GetExecutionResultErrors];
421
- export type GetExecutionResultResponses = {
422
- /**
423
- * Execution result retrieved successfully
424
- */
425
- 200: ExecutionResultResponse;
426
- };
427
- export type GetExecutionResultResponse = GetExecutionResultResponses[keyof GetExecutionResultResponses];
428
- export type GetBrowserSessionRecordingData = {
429
- body?: never;
430
- path: {
431
- /**
432
- * The ID of the execution
433
- */
434
- id: string;
435
- };
436
- query?: never;
437
- url: '/execution/{id}/browser_session/recording';
438
- };
439
- export type GetBrowserSessionRecordingErrors = {
440
- /**
441
- * Browser session not found
442
- */
443
- 404: ErrorResponse;
444
- /**
445
- * Internal server error
446
- */
447
- 500: ErrorResponse;
448
- };
449
- export type GetBrowserSessionRecordingError = GetBrowserSessionRecordingErrors[keyof GetBrowserSessionRecordingErrors];
450
- export type GetBrowserSessionRecordingResponses = {
451
- /**
452
- * Browser session recording retrieved successfully
453
- */
454
- 200: BrowserSessionRecordingResponse;
455
- };
456
- export type GetBrowserSessionRecordingResponse = GetBrowserSessionRecordingResponses[keyof GetBrowserSessionRecordingResponses];
457
- export type GetAgentProfilesData = {
458
- body?: never;
459
- path?: never;
460
- query?: {
461
- /**
462
- * The ID of the organization to filter by
463
- */
464
- organization_id?: string;
465
- };
466
- url: '/agent-profiles';
467
- };
468
- export type GetAgentProfilesErrors = {
469
- /**
470
- * Unauthorized - Authentication required
471
- */
472
- 401: ErrorResponse;
473
- /**
474
- * Forbidden - Insufficient permissions
475
- */
476
- 403: ErrorResponse;
477
- /**
478
- * Internal server error
479
- */
480
- 500: ErrorResponse;
481
- };
482
- export type GetAgentProfilesError = GetAgentProfilesErrors[keyof GetAgentProfilesErrors];
483
- export type GetAgentProfilesResponses = {
484
- /**
485
- * List of agent profiles
486
- */
487
- 200: Array<AgentProfile>;
488
- };
489
- export type GetAgentProfilesResponse = GetAgentProfilesResponses[keyof GetAgentProfilesResponses];
490
- export type CreateAgentProfileData = {
491
- body: CreateAgentProfileRequest;
492
- path?: never;
493
- query?: never;
494
- url: '/agent-profiles';
495
- };
496
- export type CreateAgentProfileErrors = {
497
- /**
498
- * Bad request - Invalid input or profile name already exists
499
- */
500
- 400: ErrorResponse;
501
- /**
502
- * Unauthorized - Authentication required
503
- */
504
- 401: ErrorResponse;
505
- /**
506
- * Forbidden - Insufficient permissions
507
- */
508
- 403: ErrorResponse;
509
- /**
510
- * Internal server error
511
- */
512
- 500: ErrorResponse;
513
- };
514
- export type CreateAgentProfileError = CreateAgentProfileErrors[keyof CreateAgentProfileErrors];
515
- export type CreateAgentProfileResponses = {
516
- /**
517
- * Agent profile created successfully
518
- */
519
- 201: AgentProfile;
520
- };
521
- export type CreateAgentProfileResponse = CreateAgentProfileResponses[keyof CreateAgentProfileResponses];
522
- export type DeleteAgentProfileData = {
523
- body?: never;
524
- path: {
525
- /**
526
- * The ID of the agent profile
527
- */
528
- profile_id: string;
529
- };
530
- query?: never;
531
- url: '/agent-profiles/{profile_id}';
532
- };
533
- export type DeleteAgentProfileErrors = {
534
- /**
535
- * Unauthorized - Authentication required
536
- */
537
- 401: ErrorResponse;
538
- /**
539
- * Forbidden - Insufficient permissions
540
- */
541
- 403: ErrorResponse;
542
- /**
543
- * Agent profile not found
544
- */
545
- 404: ErrorResponse;
546
- /**
547
- * Internal server error
548
- */
549
- 500: ErrorResponse;
550
- };
551
- export type DeleteAgentProfileError = DeleteAgentProfileErrors[keyof DeleteAgentProfileErrors];
552
- export type DeleteAgentProfileResponses = {
553
- /**
554
- * Agent profile deleted successfully
555
- */
556
- 200: {
557
- message?: string;
558
- };
559
- };
560
- export type DeleteAgentProfileResponse = DeleteAgentProfileResponses[keyof DeleteAgentProfileResponses];
561
- export type GetAgentProfileData = {
562
- body?: never;
563
- path: {
564
- /**
565
- * The ID of the agent profile
566
- */
567
- profile_id: string;
568
- };
569
- query?: never;
570
- url: '/agent-profiles/{profile_id}';
571
- };
572
- export type GetAgentProfileErrors = {
573
- /**
574
- * Unauthorized - Authentication required
575
- */
576
- 401: ErrorResponse;
577
- /**
578
- * Forbidden - Insufficient permissions
579
- */
580
- 403: ErrorResponse;
581
- /**
582
- * Agent profile not found
583
- */
584
- 404: ErrorResponse;
585
- /**
586
- * Internal server error
587
- */
588
- 500: ErrorResponse;
589
- };
590
- export type GetAgentProfileError = GetAgentProfileErrors[keyof GetAgentProfileErrors];
591
- export type GetAgentProfileResponses = {
592
- /**
593
- * Agent profile found
594
- */
595
- 200: AgentProfile;
596
- };
597
- export type GetAgentProfileResponse = GetAgentProfileResponses[keyof GetAgentProfileResponses];
598
- export type UpdateAgentProfileData = {
599
- body: UpdateAgentProfileRequest;
600
- path: {
601
- /**
602
- * The ID of the agent profile
603
- */
604
- profile_id: string;
605
- };
606
- query?: never;
607
- url: '/agent-profiles/{profile_id}';
608
- };
609
- export type UpdateAgentProfileErrors = {
610
- /**
611
- * Bad request - Invalid input
612
- */
613
- 400: ErrorResponse;
614
- /**
615
- * Unauthorized - Authentication required
616
- */
617
- 401: ErrorResponse;
618
- /**
619
- * Forbidden - Insufficient permissions
620
- */
621
- 403: ErrorResponse;
622
- /**
623
- * Agent profile not found
624
- */
625
- 404: ErrorResponse;
626
- /**
627
- * Internal server error
628
- */
629
- 500: ErrorResponse;
630
- };
631
- export type UpdateAgentProfileError = UpdateAgentProfileErrors[keyof UpdateAgentProfileErrors];
632
- export type UpdateAgentProfileResponses = {
633
- /**
634
- * Agent profile updated successfully
635
- */
636
- 200: AgentProfile;
637
- };
638
- export type UpdateAgentProfileResponse = UpdateAgentProfileResponses[keyof UpdateAgentProfileResponses];
639
- export type ClientOptions = {
640
- baseUrl: 'https://odyssey.asteroid.ai/api/v1' | `${string}://${string}/api/v1` | (string & {});
641
- };
@@ -1,3 +0,0 @@
1
- "use strict";
2
- // This file is auto-generated by @hey-api/openapi-ts
3
- Object.defineProperty(exports, "__esModule", { value: true });