browser-use-sdk 0.1.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/CHANGELOG.md +15 -0
- package/LICENSE +201 -0
- package/README.md +358 -0
- package/api-promise.d.mts +2 -0
- package/api-promise.d.mts.map +1 -0
- package/api-promise.d.ts +2 -0
- package/api-promise.d.ts.map +1 -0
- package/api-promise.js +6 -0
- package/api-promise.js.map +1 -0
- package/api-promise.mjs +2 -0
- package/api-promise.mjs.map +1 -0
- package/client.d.mts +189 -0
- package/client.d.mts.map +1 -0
- package/client.d.ts +189 -0
- package/client.d.ts.map +1 -0
- package/client.js +470 -0
- package/client.js.map +1 -0
- package/client.mjs +466 -0
- package/client.mjs.map +1 -0
- package/core/api-promise.d.mts +46 -0
- package/core/api-promise.d.mts.map +1 -0
- package/core/api-promise.d.ts +46 -0
- package/core/api-promise.d.ts.map +1 -0
- package/core/api-promise.js +74 -0
- package/core/api-promise.js.map +1 -0
- package/core/api-promise.mjs +70 -0
- package/core/api-promise.mjs.map +1 -0
- package/core/error.d.mts +46 -0
- package/core/error.d.mts.map +1 -0
- package/core/error.d.ts +46 -0
- package/core/error.d.ts.map +1 -0
- package/core/error.js +113 -0
- package/core/error.js.map +1 -0
- package/core/error.mjs +97 -0
- package/core/error.mjs.map +1 -0
- package/core/resource.d.mts +6 -0
- package/core/resource.d.mts.map +1 -0
- package/core/resource.d.ts +6 -0
- package/core/resource.d.ts.map +1 -0
- package/core/resource.js +11 -0
- package/core/resource.js.map +1 -0
- package/core/resource.mjs +7 -0
- package/core/resource.mjs.map +1 -0
- package/core/uploads.d.mts +3 -0
- package/core/uploads.d.mts.map +1 -0
- package/core/uploads.d.ts +3 -0
- package/core/uploads.d.ts.map +1 -0
- package/core/uploads.js +6 -0
- package/core/uploads.js.map +1 -0
- package/core/uploads.mjs +2 -0
- package/core/uploads.mjs.map +1 -0
- package/error.d.mts +2 -0
- package/error.d.mts.map +1 -0
- package/error.d.ts +2 -0
- package/error.d.ts.map +1 -0
- package/error.js +6 -0
- package/error.js.map +1 -0
- package/error.mjs +2 -0
- package/error.mjs.map +1 -0
- package/index.d.mts +6 -0
- package/index.d.mts.map +1 -0
- package/index.d.ts +6 -0
- package/index.d.ts.map +1 -0
- package/index.js +30 -0
- package/index.js.map +1 -0
- package/index.mjs +7 -0
- package/index.mjs.map +1 -0
- package/internal/builtin-types.d.mts +73 -0
- package/internal/builtin-types.d.mts.map +1 -0
- package/internal/builtin-types.d.ts +73 -0
- package/internal/builtin-types.d.ts.map +1 -0
- package/internal/builtin-types.js +4 -0
- package/internal/builtin-types.js.map +1 -0
- package/internal/builtin-types.mjs +3 -0
- package/internal/builtin-types.mjs.map +1 -0
- package/internal/detect-platform.d.mts +15 -0
- package/internal/detect-platform.d.mts.map +1 -0
- package/internal/detect-platform.d.ts +15 -0
- package/internal/detect-platform.d.ts.map +1 -0
- package/internal/detect-platform.js +162 -0
- package/internal/detect-platform.js.map +1 -0
- package/internal/detect-platform.mjs +157 -0
- package/internal/detect-platform.mjs.map +1 -0
- package/internal/errors.d.mts +3 -0
- package/internal/errors.d.mts.map +1 -0
- package/internal/errors.d.ts +3 -0
- package/internal/errors.d.ts.map +1 -0
- package/internal/errors.js +41 -0
- package/internal/errors.js.map +1 -0
- package/internal/errors.mjs +36 -0
- package/internal/errors.mjs.map +1 -0
- package/internal/headers.d.mts +20 -0
- package/internal/headers.d.mts.map +1 -0
- package/internal/headers.d.ts +20 -0
- package/internal/headers.d.ts.map +1 -0
- package/internal/headers.js +79 -0
- package/internal/headers.js.map +1 -0
- package/internal/headers.mjs +74 -0
- package/internal/headers.mjs.map +1 -0
- package/internal/parse.d.mts +12 -0
- package/internal/parse.d.mts.map +1 -0
- package/internal/parse.d.ts +12 -0
- package/internal/parse.d.ts.map +1 -0
- package/internal/parse.js +35 -0
- package/internal/parse.js.map +1 -0
- package/internal/parse.mjs +32 -0
- package/internal/parse.mjs.map +1 -0
- package/internal/request-options.d.mts +75 -0
- package/internal/request-options.d.mts.map +1 -0
- package/internal/request-options.d.ts +75 -0
- package/internal/request-options.d.ts.map +1 -0
- package/internal/request-options.js +14 -0
- package/internal/request-options.js.map +1 -0
- package/internal/request-options.mjs +10 -0
- package/internal/request-options.mjs.map +1 -0
- package/internal/shim-types.d.mts +17 -0
- package/internal/shim-types.d.mts.map +1 -0
- package/internal/shim-types.d.ts +17 -0
- package/internal/shim-types.d.ts.map +1 -0
- package/internal/shim-types.js +4 -0
- package/internal/shim-types.js.map +1 -0
- package/internal/shim-types.mjs +3 -0
- package/internal/shim-types.mjs.map +1 -0
- package/internal/shims.d.mts +20 -0
- package/internal/shims.d.mts.map +1 -0
- package/internal/shims.d.ts +20 -0
- package/internal/shims.d.ts.map +1 -0
- package/internal/shims.js +92 -0
- package/internal/shims.js.map +1 -0
- package/internal/shims.mjs +85 -0
- package/internal/shims.mjs.map +1 -0
- package/internal/to-file.d.mts +45 -0
- package/internal/to-file.d.mts.map +1 -0
- package/internal/to-file.d.ts +45 -0
- package/internal/to-file.d.ts.map +1 -0
- package/internal/to-file.js +91 -0
- package/internal/to-file.js.map +1 -0
- package/internal/to-file.mjs +88 -0
- package/internal/to-file.mjs.map +1 -0
- package/internal/tslib.js +81 -0
- package/internal/tslib.mjs +17 -0
- package/internal/types.d.mts +69 -0
- package/internal/types.d.mts.map +1 -0
- package/internal/types.d.ts +69 -0
- package/internal/types.d.ts.map +1 -0
- package/internal/types.js +4 -0
- package/internal/types.js.map +1 -0
- package/internal/types.mjs +3 -0
- package/internal/types.mjs.map +1 -0
- package/internal/uploads.d.mts +42 -0
- package/internal/uploads.d.mts.map +1 -0
- package/internal/uploads.d.ts +42 -0
- package/internal/uploads.d.ts.map +1 -0
- package/internal/uploads.js +141 -0
- package/internal/uploads.js.map +1 -0
- package/internal/uploads.mjs +131 -0
- package/internal/uploads.mjs.map +1 -0
- package/internal/utils/base64.d.mts +3 -0
- package/internal/utils/base64.d.mts.map +1 -0
- package/internal/utils/base64.d.ts +3 -0
- package/internal/utils/base64.d.ts.map +1 -0
- package/internal/utils/base64.js +38 -0
- package/internal/utils/base64.js.map +1 -0
- package/internal/utils/base64.mjs +33 -0
- package/internal/utils/base64.mjs.map +1 -0
- package/internal/utils/bytes.d.mts +4 -0
- package/internal/utils/bytes.d.mts.map +1 -0
- package/internal/utils/bytes.d.ts +4 -0
- package/internal/utils/bytes.d.ts.map +1 -0
- package/internal/utils/bytes.js +31 -0
- package/internal/utils/bytes.js.map +1 -0
- package/internal/utils/bytes.mjs +26 -0
- package/internal/utils/bytes.mjs.map +1 -0
- package/internal/utils/env.d.mts +9 -0
- package/internal/utils/env.d.mts.map +1 -0
- package/internal/utils/env.d.ts +9 -0
- package/internal/utils/env.d.ts.map +1 -0
- package/internal/utils/env.js +22 -0
- package/internal/utils/env.js.map +1 -0
- package/internal/utils/env.mjs +18 -0
- package/internal/utils/env.mjs.map +1 -0
- package/internal/utils/log.d.mts +37 -0
- package/internal/utils/log.d.mts.map +1 -0
- package/internal/utils/log.d.ts +37 -0
- package/internal/utils/log.d.ts.map +1 -0
- package/internal/utils/log.js +86 -0
- package/internal/utils/log.js.map +1 -0
- package/internal/utils/log.mjs +80 -0
- package/internal/utils/log.mjs.map +1 -0
- package/internal/utils/path.d.mts +15 -0
- package/internal/utils/path.d.mts.map +1 -0
- package/internal/utils/path.d.ts +15 -0
- package/internal/utils/path.d.ts.map +1 -0
- package/internal/utils/path.js +79 -0
- package/internal/utils/path.js.map +1 -0
- package/internal/utils/path.mjs +74 -0
- package/internal/utils/path.mjs.map +1 -0
- package/internal/utils/sleep.d.mts +2 -0
- package/internal/utils/sleep.d.mts.map +1 -0
- package/internal/utils/sleep.d.ts +2 -0
- package/internal/utils/sleep.d.ts.map +1 -0
- package/internal/utils/sleep.js +7 -0
- package/internal/utils/sleep.js.map +1 -0
- package/internal/utils/sleep.mjs +3 -0
- package/internal/utils/sleep.mjs.map +1 -0
- package/internal/utils/uuid.d.mts +5 -0
- package/internal/utils/uuid.d.mts.map +1 -0
- package/internal/utils/uuid.d.ts +5 -0
- package/internal/utils/uuid.d.ts.map +1 -0
- package/internal/utils/uuid.js +19 -0
- package/internal/utils/uuid.js.map +1 -0
- package/internal/utils/uuid.mjs +15 -0
- package/internal/utils/uuid.mjs.map +1 -0
- package/internal/utils/values.d.mts +18 -0
- package/internal/utils/values.d.mts.map +1 -0
- package/internal/utils/values.d.ts +18 -0
- package/internal/utils/values.d.ts.map +1 -0
- package/internal/utils/values.js +112 -0
- package/internal/utils/values.js.map +1 -0
- package/internal/utils/values.mjs +94 -0
- package/internal/utils/values.mjs.map +1 -0
- package/internal/utils.d.mts +7 -0
- package/internal/utils.d.mts.map +1 -0
- package/internal/utils.d.ts +7 -0
- package/internal/utils.d.ts.map +1 -0
- package/internal/utils.js +11 -0
- package/internal/utils.js.map +1 -0
- package/internal/utils.mjs +8 -0
- package/internal/utils.mjs.map +1 -0
- package/package.json +138 -0
- package/resource.d.mts +2 -0
- package/resource.d.mts.map +1 -0
- package/resource.d.ts +2 -0
- package/resource.d.ts.map +1 -0
- package/resource.js +6 -0
- package/resource.js.map +1 -0
- package/resource.mjs +2 -0
- package/resource.mjs.map +1 -0
- package/resources/agent-profiles.d.mts +94 -0
- package/resources/agent-profiles.d.mts.map +1 -0
- package/resources/agent-profiles.d.ts +94 -0
- package/resources/agent-profiles.d.ts.map +1 -0
- package/resources/agent-profiles.js +40 -0
- package/resources/agent-profiles.js.map +1 -0
- package/resources/agent-profiles.mjs +36 -0
- package/resources/agent-profiles.mjs.map +1 -0
- package/resources/browser-profiles.d.mts +98 -0
- package/resources/browser-profiles.d.mts.map +1 -0
- package/resources/browser-profiles.d.ts +98 -0
- package/resources/browser-profiles.d.ts.map +1 -0
- package/resources/browser-profiles.js +40 -0
- package/resources/browser-profiles.js.map +1 -0
- package/resources/browser-profiles.mjs +36 -0
- package/resources/browser-profiles.mjs.map +1 -0
- package/resources/index.d.mts +5 -0
- package/resources/index.d.mts.map +1 -0
- package/resources/index.d.ts +5 -0
- package/resources/index.d.ts.map +1 -0
- package/resources/index.js +13 -0
- package/resources/index.js.map +1 -0
- package/resources/index.mjs +6 -0
- package/resources/index.mjs.map +1 -0
- package/resources/sessions/index.d.mts +3 -0
- package/resources/sessions/index.d.mts.map +1 -0
- package/resources/sessions/index.d.ts +3 -0
- package/resources/sessions/index.d.ts.map +1 -0
- package/resources/sessions/index.js +9 -0
- package/resources/sessions/index.js.map +1 -0
- package/resources/sessions/index.mjs +4 -0
- package/resources/sessions/index.mjs.map +1 -0
- package/resources/sessions/public-share.d.mts +36 -0
- package/resources/sessions/public-share.d.mts.map +1 -0
- package/resources/sessions/public-share.d.ts +36 -0
- package/resources/sessions/public-share.d.ts.map +1 -0
- package/resources/sessions/public-share.js +28 -0
- package/resources/sessions/public-share.js.map +1 -0
- package/resources/sessions/public-share.mjs +24 -0
- package/resources/sessions/public-share.mjs.map +1 -0
- package/resources/sessions/sessions.d.mts +97 -0
- package/resources/sessions/sessions.d.mts.map +1 -0
- package/resources/sessions/sessions.d.ts +97 -0
- package/resources/sessions/sessions.d.ts.map +1 -0
- package/resources/sessions/sessions.js +36 -0
- package/resources/sessions/sessions.js.map +1 -0
- package/resources/sessions/sessions.mjs +31 -0
- package/resources/sessions/sessions.mjs.map +1 -0
- package/resources/sessions.d.mts +2 -0
- package/resources/sessions.d.mts.map +1 -0
- package/resources/sessions.d.ts +2 -0
- package/resources/sessions.d.ts.map +1 -0
- package/resources/sessions.js +6 -0
- package/resources/sessions.js.map +1 -0
- package/resources/sessions.mjs +3 -0
- package/resources/sessions.mjs.map +1 -0
- package/resources/tasks.d.mts +246 -0
- package/resources/tasks.d.mts.map +1 -0
- package/resources/tasks.d.ts +246 -0
- package/resources/tasks.d.ts.map +1 -0
- package/resources/tasks.js +47 -0
- package/resources/tasks.js.map +1 -0
- package/resources/tasks.mjs +43 -0
- package/resources/tasks.mjs.map +1 -0
- package/resources.d.mts +2 -0
- package/resources.d.mts.map +1 -0
- package/resources.d.ts +2 -0
- package/resources.d.ts.map +1 -0
- package/resources.js +5 -0
- package/resources.js.map +1 -0
- package/resources.mjs +2 -0
- package/resources.mjs.map +1 -0
- package/src/api-promise.ts +2 -0
- package/src/client.ts +817 -0
- package/src/core/README.md +3 -0
- package/src/core/api-promise.ts +92 -0
- package/src/core/error.ts +130 -0
- package/src/core/resource.ts +11 -0
- package/src/core/uploads.ts +2 -0
- package/src/error.ts +2 -0
- package/src/index.ts +22 -0
- package/src/internal/README.md +3 -0
- package/src/internal/builtin-types.ts +93 -0
- package/src/internal/detect-platform.ts +196 -0
- package/src/internal/errors.ts +33 -0
- package/src/internal/headers.ts +97 -0
- package/src/internal/parse.ts +50 -0
- package/src/internal/request-options.ts +91 -0
- package/src/internal/shim-types.ts +26 -0
- package/src/internal/shims.ts +107 -0
- package/src/internal/to-file.ts +154 -0
- package/src/internal/types.ts +95 -0
- package/src/internal/uploads.ts +187 -0
- package/src/internal/utils/base64.ts +40 -0
- package/src/internal/utils/bytes.ts +32 -0
- package/src/internal/utils/env.ts +18 -0
- package/src/internal/utils/log.ts +127 -0
- package/src/internal/utils/path.ts +88 -0
- package/src/internal/utils/sleep.ts +3 -0
- package/src/internal/utils/uuid.ts +17 -0
- package/src/internal/utils/values.ts +105 -0
- package/src/internal/utils.ts +8 -0
- package/src/lib/.keep +4 -0
- package/src/resource.ts +2 -0
- package/src/resources/agent-profiles.ts +163 -0
- package/src/resources/browser-profiles.ts +172 -0
- package/src/resources/index.ts +45 -0
- package/src/resources/sessions/index.ts +12 -0
- package/src/resources/sessions/public-share.ts +53 -0
- package/src/resources/sessions/sessions.ts +150 -0
- package/src/resources/sessions.ts +3 -0
- package/src/resources/tasks.ts +352 -0
- package/src/resources.ts +1 -0
- package/src/tsconfig.json +11 -0
- package/src/uploads.ts +2 -0
- package/src/version.ts +1 -0
- package/uploads.d.mts +2 -0
- package/uploads.d.mts.map +1 -0
- package/uploads.d.ts +2 -0
- package/uploads.d.ts.map +1 -0
- package/uploads.js +6 -0
- package/uploads.js.map +1 -0
- package/uploads.mjs +2 -0
- package/uploads.mjs.map +1 -0
- package/version.d.mts +2 -0
- package/version.d.mts.map +1 -0
- package/version.d.ts +2 -0
- package/version.d.ts.map +1 -0
- package/version.js +5 -0
- package/version.js.map +1 -0
- package/version.mjs +2 -0
- package/version.mjs.map +1 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sessions.d.mts","sourceRoot":"","sources":["../../src/resources/sessions/sessions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,cAAc;OACnB,EAAE,WAAW,EAAE,yBAAyB,EAAE,SAAS,EAAE;OACrD,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IAEvF;;OAEG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC;IAI1B;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIvG;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAGnC;AAED;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEjD;;;;;;;;;;GAUG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;OAMG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import * as TasksAPI from "../tasks.js";
|
|
3
|
+
import * as PublicShareAPI from "./public-share.js";
|
|
4
|
+
import { PublicShare, PublicShareDeleteResponse, ShareView } from "./public-share.js";
|
|
5
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
6
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
7
|
+
export declare class Sessions extends APIResource {
|
|
8
|
+
publicShare: PublicShareAPI.PublicShare;
|
|
9
|
+
/**
|
|
10
|
+
* Get Session
|
|
11
|
+
*/
|
|
12
|
+
retrieve(sessionID: string, query?: SessionRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<SessionView>;
|
|
13
|
+
/**
|
|
14
|
+
* Update Session
|
|
15
|
+
*/
|
|
16
|
+
update(sessionID: string, body: SessionUpdateParams, options?: RequestOptions): APIPromise<SessionView>;
|
|
17
|
+
/**
|
|
18
|
+
* List Sessions
|
|
19
|
+
*/
|
|
20
|
+
list(query?: SessionListParams | null | undefined, options?: RequestOptions): APIPromise<SessionListResponse>;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Enumeration of possible (browser) session states
|
|
24
|
+
*
|
|
25
|
+
* Attributes: ACTIVE: Session is currently active and running (aka browser is
|
|
26
|
+
* running) STOPPED: Session has been stopped and is no longer active (aka browser
|
|
27
|
+
* is stopped)
|
|
28
|
+
*/
|
|
29
|
+
export type SessionStatus = 'active' | 'stopped';
|
|
30
|
+
/**
|
|
31
|
+
* View model for representing a (browser) session with its associated tasks.
|
|
32
|
+
*
|
|
33
|
+
* Attributes: id: Unique identifier for the session. status: Current status of the
|
|
34
|
+
* session (active/stopped). live_url: URL where the browser can be viewed live in
|
|
35
|
+
* real-time. record_url: URL to access the recorded session playback. started_at:
|
|
36
|
+
* Timestamp when the session was created and started. finished_at: Timestamp when
|
|
37
|
+
* the session was stopped (None if still active). tasks: List of tasks associated
|
|
38
|
+
* with this session (optional). public_share_url: URL to access the public share
|
|
39
|
+
* of the session (optional).
|
|
40
|
+
*/
|
|
41
|
+
export interface SessionView {
|
|
42
|
+
id: string;
|
|
43
|
+
startedAt: string;
|
|
44
|
+
/**
|
|
45
|
+
* Enumeration of possible (browser) session states
|
|
46
|
+
*
|
|
47
|
+
* Attributes: ACTIVE: Session is currently active and running (aka browser is
|
|
48
|
+
* running) STOPPED: Session has been stopped and is no longer active (aka browser
|
|
49
|
+
* is stopped)
|
|
50
|
+
*/
|
|
51
|
+
status: SessionStatus;
|
|
52
|
+
finishedAt?: string | null;
|
|
53
|
+
liveUrl?: string | null;
|
|
54
|
+
publicShareUrl?: string | null;
|
|
55
|
+
recordUrl?: string | null;
|
|
56
|
+
tasks?: Array<TasksAPI.TaskView> | null;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Response model for paginated session list requests
|
|
60
|
+
*
|
|
61
|
+
* Attributes: items: List of session views for the current page
|
|
62
|
+
*/
|
|
63
|
+
export interface SessionListResponse {
|
|
64
|
+
items: Array<SessionView>;
|
|
65
|
+
pageNumber: number;
|
|
66
|
+
pageSize: number;
|
|
67
|
+
totalItems: number;
|
|
68
|
+
}
|
|
69
|
+
export interface SessionRetrieveParams {
|
|
70
|
+
includeTasks?: boolean;
|
|
71
|
+
}
|
|
72
|
+
export interface SessionUpdateParams {
|
|
73
|
+
/**
|
|
74
|
+
* Available actions that can be performed on a session
|
|
75
|
+
*
|
|
76
|
+
* Attributes: STOP: Stop the session and all its associated tasks
|
|
77
|
+
*/
|
|
78
|
+
action: 'stop';
|
|
79
|
+
}
|
|
80
|
+
export interface SessionListParams {
|
|
81
|
+
/**
|
|
82
|
+
* Enumeration of possible (browser) session states
|
|
83
|
+
*
|
|
84
|
+
* Attributes: ACTIVE: Session is currently active and running (aka browser is
|
|
85
|
+
* running) STOPPED: Session has been stopped and is no longer active (aka browser
|
|
86
|
+
* is stopped)
|
|
87
|
+
*/
|
|
88
|
+
filterBy?: SessionStatus | null;
|
|
89
|
+
includeTasks?: boolean;
|
|
90
|
+
pageNumber?: number;
|
|
91
|
+
pageSize?: number;
|
|
92
|
+
}
|
|
93
|
+
export declare namespace Sessions {
|
|
94
|
+
export { type SessionStatus as SessionStatus, type SessionView as SessionView, type SessionListResponse as SessionListResponse, type SessionRetrieveParams as SessionRetrieveParams, type SessionUpdateParams as SessionUpdateParams, type SessionListParams as SessionListParams, };
|
|
95
|
+
export { PublicShare as PublicShare, type ShareView as ShareView, type PublicShareDeleteResponse as PublicShareDeleteResponse, };
|
|
96
|
+
}
|
|
97
|
+
//# sourceMappingURL=sessions.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sessions.d.ts","sourceRoot":"","sources":["../../src/resources/sessions/sessions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,KAAK,cAAc;OACnB,EAAE,WAAW,EAAE,yBAAyB,EAAE,SAAS,EAAE;OACrD,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC,WAAW,EAAE,cAAc,CAAC,WAAW,CAAgD;IAEvF;;OAEG;IACH,QAAQ,CACN,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,qBAAqB,GAAG,IAAI,GAAG,SAAc,EACpD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,WAAW,CAAC;IAI1B;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIvG;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,mBAAmB,CAAC;CAGnC;AAED;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEjD;;;;;;;;;;GAUG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IAEX,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;OAMG;IACH,MAAM,EAAE,aAAa,CAAC;IAEtB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;IAE1B,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IAEhC,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,WAAW,IAAI,WAAW,EAC1B,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Sessions = void 0;
|
|
5
|
+
const tslib_1 = require("../../internal/tslib.js");
|
|
6
|
+
const resource_1 = require("../../core/resource.js");
|
|
7
|
+
const PublicShareAPI = tslib_1.__importStar(require("./public-share.js"));
|
|
8
|
+
const public_share_1 = require("./public-share.js");
|
|
9
|
+
const path_1 = require("../../internal/utils/path.js");
|
|
10
|
+
class Sessions extends resource_1.APIResource {
|
|
11
|
+
constructor() {
|
|
12
|
+
super(...arguments);
|
|
13
|
+
this.publicShare = new PublicShareAPI.PublicShare(this._client);
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Get Session
|
|
17
|
+
*/
|
|
18
|
+
retrieve(sessionID, query = {}, options) {
|
|
19
|
+
return this._client.get((0, path_1.path) `/sessions/${sessionID}`, { query, ...options });
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Update Session
|
|
23
|
+
*/
|
|
24
|
+
update(sessionID, body, options) {
|
|
25
|
+
return this._client.patch((0, path_1.path) `/sessions/${sessionID}`, { body, ...options });
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* List Sessions
|
|
29
|
+
*/
|
|
30
|
+
list(query = {}, options) {
|
|
31
|
+
return this._client.get('/sessions', { query, ...options });
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
exports.Sessions = Sessions;
|
|
35
|
+
Sessions.PublicShare = public_share_1.PublicShare;
|
|
36
|
+
//# sourceMappingURL=sessions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sessions.js","sourceRoot":"","sources":["../../src/resources/sessions/sessions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,qDAAkD;AAElD,0EAAiD;AACjD,oDAAmF;AAGnF,uDAAiD;AAEjD,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA6BzF,CAAC;IA3BC;;OAEG;IACH,QAAQ,CACN,SAAiB,EACjB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;CACF;AA9BD,4BA8BC;AA4FD,QAAQ,CAAC,WAAW,GAAG,0BAAW,CAAC"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import * as PublicShareAPI from "./public-share.mjs";
|
|
4
|
+
import { PublicShare } from "./public-share.mjs";
|
|
5
|
+
import { path } from "../../internal/utils/path.mjs";
|
|
6
|
+
export class Sessions extends APIResource {
|
|
7
|
+
constructor() {
|
|
8
|
+
super(...arguments);
|
|
9
|
+
this.publicShare = new PublicShareAPI.PublicShare(this._client);
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Get Session
|
|
13
|
+
*/
|
|
14
|
+
retrieve(sessionID, query = {}, options) {
|
|
15
|
+
return this._client.get(path `/sessions/${sessionID}`, { query, ...options });
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Update Session
|
|
19
|
+
*/
|
|
20
|
+
update(sessionID, body, options) {
|
|
21
|
+
return this._client.patch(path `/sessions/${sessionID}`, { body, ...options });
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* List Sessions
|
|
25
|
+
*/
|
|
26
|
+
list(query = {}, options) {
|
|
27
|
+
return this._client.get('/sessions', { query, ...options });
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
Sessions.PublicShare = PublicShare;
|
|
31
|
+
//# sourceMappingURL=sessions.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sessions.mjs","sourceRoot":"","sources":["../../src/resources/sessions/sessions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,KAAK,cAAc;OACnB,EAAE,WAAW,EAAwC;OAGrD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,gBAAW,GAA+B,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IA6BzF,CAAC;IA3BC;;OAEG;IACH,QAAQ,CACN,SAAiB,EACjB,QAAkD,EAAE,EACpD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,SAAS,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,aAAa,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChF,CAAC;IAED;;OAEG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;CACF;AA4FD,QAAQ,CAAC,WAAW,GAAG,WAAW,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sessions.d.mts","sourceRoot":"","sources":["../src/resources/sessions.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sessions.d.ts","sourceRoot":"","sources":["../src/resources/sessions.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
const tslib_1 = require("../internal/tslib.js");
|
|
5
|
+
tslib_1.__exportStar(require("./sessions/index.js"), exports);
|
|
6
|
+
//# sourceMappingURL=sessions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sessions.js","sourceRoot":"","sources":["../src/resources/sessions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8DAAiC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sessions.mjs","sourceRoot":"","sources":["../src/resources/sessions.ts"],"names":[],"mappings":"AAAA,sFAAsF"}
|
|
@@ -0,0 +1,246 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.mjs";
|
|
2
|
+
import * as TasksAPI from "./tasks.mjs";
|
|
3
|
+
import { APIPromise } from "../core/api-promise.mjs";
|
|
4
|
+
import { RequestOptions } from "../internal/request-options.mjs";
|
|
5
|
+
export declare class Tasks extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Create Task
|
|
8
|
+
*/
|
|
9
|
+
create(body: TaskCreateParams, options?: RequestOptions): APIPromise<TaskView>;
|
|
10
|
+
/**
|
|
11
|
+
* Get Task
|
|
12
|
+
*/
|
|
13
|
+
retrieve(taskID: string, query?: TaskRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<TaskRetrieveResponse>;
|
|
14
|
+
/**
|
|
15
|
+
* Update Task
|
|
16
|
+
*/
|
|
17
|
+
update(taskID: string, body: TaskUpdateParams, options?: RequestOptions): APIPromise<TaskView>;
|
|
18
|
+
/**
|
|
19
|
+
* List Tasks
|
|
20
|
+
*/
|
|
21
|
+
list(query?: TaskListParams | null | undefined, options?: RequestOptions): APIPromise<TaskListResponse>;
|
|
22
|
+
/**
|
|
23
|
+
* Get Task Logs
|
|
24
|
+
*/
|
|
25
|
+
retrieveLogs(taskID: string, options?: RequestOptions): APIPromise<TaskRetrieveLogsResponse>;
|
|
26
|
+
/**
|
|
27
|
+
* Get Task Output File
|
|
28
|
+
*/
|
|
29
|
+
retrieveOutputFile(fileName: string, params: TaskRetrieveOutputFileParams, options?: RequestOptions): APIPromise<TaskRetrieveOutputFileResponse>;
|
|
30
|
+
}
|
|
31
|
+
export type LlmModel = 'gpt-4o' | 'gpt-4o-mini' | 'gpt-4.1' | 'gpt-4.1-mini' | 'o4-mini' | 'o3' | 'gemini-2.0-flash' | 'gemini-2.0-flash-lite' | 'gemini-2.5-flash-preview-04-17' | 'gemini-2.5-flash' | 'gemini-2.5-pro' | 'claude-3-7-sonnet-20250219' | 'claude-sonnet-4-20250514' | 'llama-4-maverick-17b-128e-instruct';
|
|
32
|
+
/**
|
|
33
|
+
* Enumeration of possible task execution states
|
|
34
|
+
*
|
|
35
|
+
* Attributes: STARTED: Task has been initiated and is currently running PAUSED:
|
|
36
|
+
* Task execution has been temporarily paused STOPPED: Task execution has been
|
|
37
|
+
* stopped (not completed) FINISHED: Task has completed successfully
|
|
38
|
+
*/
|
|
39
|
+
export type TaskStatus = 'started' | 'paused' | 'stopped' | 'finished';
|
|
40
|
+
/**
|
|
41
|
+
* View model for representing a task with its execution details
|
|
42
|
+
*
|
|
43
|
+
* Attributes: id: Unique identifier for the task session_id: ID of the session
|
|
44
|
+
* this task belongs to session_live_url: Live URL of the session llm: The LLM
|
|
45
|
+
* model used for this task task: The task prompt/instruction given to the agent
|
|
46
|
+
* status: Current status of the task execution started_at: Naive UTC timestamp
|
|
47
|
+
* when the task was started finished_at: Naive UTC timestamp when the task
|
|
48
|
+
* completed (None if still running) metadata: Additional metadata associated with
|
|
49
|
+
* the task (optionally set by the user) is_scheduled: Whether this task was
|
|
50
|
+
* created as a scheduled task steps: List of execution steps (optionally included
|
|
51
|
+
* per user request) done_output: Final output/result of the task
|
|
52
|
+
* user_uploaded_files: List of files uploaded by user for this task (optionally
|
|
53
|
+
* included per user request) output_files: List of files generated as output by
|
|
54
|
+
* this task (optionally included per user request) browser_use_version: Version of
|
|
55
|
+
* browser-use used for this task
|
|
56
|
+
*/
|
|
57
|
+
export interface TaskView {
|
|
58
|
+
id: string;
|
|
59
|
+
doneOutput: string;
|
|
60
|
+
isScheduled: boolean;
|
|
61
|
+
llm: LlmModel;
|
|
62
|
+
sessionId: string;
|
|
63
|
+
startedAt: string;
|
|
64
|
+
/**
|
|
65
|
+
* Enumeration of possible task execution states
|
|
66
|
+
*
|
|
67
|
+
* Attributes: STARTED: Task has been initiated and is currently running PAUSED:
|
|
68
|
+
* Task execution has been temporarily paused STOPPED: Task execution has been
|
|
69
|
+
* stopped (not completed) FINISHED: Task has completed successfully
|
|
70
|
+
*/
|
|
71
|
+
status: TaskStatus;
|
|
72
|
+
task: string;
|
|
73
|
+
browserUseVersion?: string | null;
|
|
74
|
+
finishedAt?: string | null;
|
|
75
|
+
metadata?: {
|
|
76
|
+
[key: string]: unknown;
|
|
77
|
+
};
|
|
78
|
+
outputFiles?: Array<string> | null;
|
|
79
|
+
sessionLiveUrl?: string | null;
|
|
80
|
+
steps?: Array<TaskView.Step> | null;
|
|
81
|
+
userUploadedFiles?: Array<string> | null;
|
|
82
|
+
}
|
|
83
|
+
export declare namespace TaskView {
|
|
84
|
+
/**
|
|
85
|
+
* View model for representing a single step in a task's execution
|
|
86
|
+
*
|
|
87
|
+
* Attributes: number: Sequential step number within the task memory: Agent's
|
|
88
|
+
* memory/context at this step evaluation_previous_goal: Agent's evaluation of the
|
|
89
|
+
* previous goal completion next_goal: The goal for the next step url: Current URL
|
|
90
|
+
* the browser is on for this step screenshot_url: URL to the screenshot taken at
|
|
91
|
+
* this step actions: List of stringified json actions performed by the agent in
|
|
92
|
+
* this step
|
|
93
|
+
*/
|
|
94
|
+
interface Step {
|
|
95
|
+
actions: Array<string>;
|
|
96
|
+
evaluationPreviousGoal: string;
|
|
97
|
+
memory: string;
|
|
98
|
+
nextGoal: string;
|
|
99
|
+
number: number;
|
|
100
|
+
url: string;
|
|
101
|
+
screenshotUrl?: string | null;
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* View model for representing a task with its execution details
|
|
106
|
+
*
|
|
107
|
+
* Attributes: id: Unique identifier for the task session_id: ID of the session
|
|
108
|
+
* this task belongs to session_live_url: Live URL of the session llm: The LLM
|
|
109
|
+
* model used for this task task: The task prompt/instruction given to the agent
|
|
110
|
+
* status: Current status of the task execution started_at: Naive UTC timestamp
|
|
111
|
+
* when the task was started finished_at: Naive UTC timestamp when the task
|
|
112
|
+
* completed (None if still running) metadata: Additional metadata associated with
|
|
113
|
+
* the task (optionally set by the user) is_scheduled: Whether this task was
|
|
114
|
+
* created as a scheduled task steps: List of execution steps (optionally included
|
|
115
|
+
* per user request) done_output: Final output/result of the task
|
|
116
|
+
* user_uploaded_files: List of files uploaded by user for this task (optionally
|
|
117
|
+
* included per user request) output_files: List of files generated as output by
|
|
118
|
+
* this task (optionally included per user request) browser_use_version: Version of
|
|
119
|
+
* browser-use used for this task
|
|
120
|
+
*/
|
|
121
|
+
export type TaskRetrieveResponse = TaskView | TaskRetrieveResponse.TaskStatusView;
|
|
122
|
+
export declare namespace TaskRetrieveResponse {
|
|
123
|
+
/**
|
|
124
|
+
* Minimal view for returning just the task status
|
|
125
|
+
*
|
|
126
|
+
* Attributes: status: Current status of the task
|
|
127
|
+
*/
|
|
128
|
+
interface TaskStatusView {
|
|
129
|
+
/**
|
|
130
|
+
* Enumeration of possible task execution states
|
|
131
|
+
*
|
|
132
|
+
* Attributes: STARTED: Task has been initiated and is currently running PAUSED:
|
|
133
|
+
* Task execution has been temporarily paused STOPPED: Task execution has been
|
|
134
|
+
* stopped (not completed) FINISHED: Task has completed successfully
|
|
135
|
+
*/
|
|
136
|
+
status: TasksAPI.TaskStatus;
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* Response model for paginated task list requests
|
|
141
|
+
*
|
|
142
|
+
* Attributes: items: List of task views for the current page
|
|
143
|
+
*/
|
|
144
|
+
export interface TaskListResponse {
|
|
145
|
+
items: Array<TaskView>;
|
|
146
|
+
pageNumber: number;
|
|
147
|
+
pageSize: number;
|
|
148
|
+
totalItems: number;
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* Response model for log file requests
|
|
152
|
+
*
|
|
153
|
+
* Attributes: download_url: URL to download the log file
|
|
154
|
+
*/
|
|
155
|
+
export interface TaskRetrieveLogsResponse {
|
|
156
|
+
downloadUrl: string;
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* Response model for output file requests
|
|
160
|
+
*
|
|
161
|
+
* Attributes: download_url: URL to download the output file
|
|
162
|
+
*/
|
|
163
|
+
export interface TaskRetrieveOutputFileResponse {
|
|
164
|
+
downloadUrl: string;
|
|
165
|
+
}
|
|
166
|
+
export interface TaskCreateParams {
|
|
167
|
+
task: string;
|
|
168
|
+
/**
|
|
169
|
+
* Configuration settings for the AI agent
|
|
170
|
+
*
|
|
171
|
+
* Attributes: llm: The LLM model to use for the agent (default: O3 - best
|
|
172
|
+
* performance for now) profile_id: ID of the agent profile to use for the task
|
|
173
|
+
* (None for default)
|
|
174
|
+
*/
|
|
175
|
+
agentSettings?: TaskCreateParams.AgentSettings;
|
|
176
|
+
/**
|
|
177
|
+
* Configuration settings for the browser session
|
|
178
|
+
*
|
|
179
|
+
* Attributes: session_id: ID of existing session to continue (None for new
|
|
180
|
+
* session) profile_id: ID of browser profile to use (None for default)
|
|
181
|
+
* save_browser_data: Whether to save browser state/data for the user to download
|
|
182
|
+
* later
|
|
183
|
+
*/
|
|
184
|
+
browserSettings?: TaskCreateParams.BrowserSettings;
|
|
185
|
+
includedFileNames?: Array<string> | null;
|
|
186
|
+
metadata?: {
|
|
187
|
+
[key: string]: string;
|
|
188
|
+
} | null;
|
|
189
|
+
secrets?: {
|
|
190
|
+
[key: string]: string;
|
|
191
|
+
} | null;
|
|
192
|
+
structuredOutputJson?: string | null;
|
|
193
|
+
}
|
|
194
|
+
export declare namespace TaskCreateParams {
|
|
195
|
+
/**
|
|
196
|
+
* Configuration settings for the AI agent
|
|
197
|
+
*
|
|
198
|
+
* Attributes: llm: The LLM model to use for the agent (default: O3 - best
|
|
199
|
+
* performance for now) profile_id: ID of the agent profile to use for the task
|
|
200
|
+
* (None for default)
|
|
201
|
+
*/
|
|
202
|
+
interface AgentSettings {
|
|
203
|
+
llm?: TasksAPI.LlmModel;
|
|
204
|
+
profileId?: string | null;
|
|
205
|
+
}
|
|
206
|
+
/**
|
|
207
|
+
* Configuration settings for the browser session
|
|
208
|
+
*
|
|
209
|
+
* Attributes: session_id: ID of existing session to continue (None for new
|
|
210
|
+
* session) profile_id: ID of browser profile to use (None for default)
|
|
211
|
+
* save_browser_data: Whether to save browser state/data for the user to download
|
|
212
|
+
* later
|
|
213
|
+
*/
|
|
214
|
+
interface BrowserSettings {
|
|
215
|
+
profileId?: string | null;
|
|
216
|
+
saveBrowserData?: boolean;
|
|
217
|
+
sessionId?: string | null;
|
|
218
|
+
}
|
|
219
|
+
}
|
|
220
|
+
export interface TaskRetrieveParams {
|
|
221
|
+
statusOnly?: boolean;
|
|
222
|
+
}
|
|
223
|
+
export interface TaskUpdateParams {
|
|
224
|
+
/**
|
|
225
|
+
* Available actions that can be performed on a task
|
|
226
|
+
*
|
|
227
|
+
* Attributes: STOP: Stop the current task execution PAUSE: Pause the current task
|
|
228
|
+
* execution RESUME: Resume a paused task execution STOP_TASK_AND_SESSION: Stop
|
|
229
|
+
* both the task and its parent session
|
|
230
|
+
*/
|
|
231
|
+
action: 'stop' | 'pause' | 'resume' | 'stop_task_and_session';
|
|
232
|
+
}
|
|
233
|
+
export interface TaskListParams {
|
|
234
|
+
includeOutputFiles?: boolean;
|
|
235
|
+
includeSteps?: boolean;
|
|
236
|
+
includeUserUploadedFiles?: boolean;
|
|
237
|
+
pageNumber?: number;
|
|
238
|
+
pageSize?: number;
|
|
239
|
+
}
|
|
240
|
+
export interface TaskRetrieveOutputFileParams {
|
|
241
|
+
task_id: string;
|
|
242
|
+
}
|
|
243
|
+
export declare namespace Tasks {
|
|
244
|
+
export { type LlmModel as LlmModel, type TaskStatus as TaskStatus, type TaskView as TaskView, type TaskRetrieveResponse as TaskRetrieveResponse, type TaskListResponse as TaskListResponse, type TaskRetrieveLogsResponse as TaskRetrieveLogsResponse, type TaskRetrieveOutputFileResponse as TaskRetrieveOutputFileResponse, type TaskCreateParams as TaskCreateParams, type TaskRetrieveParams as TaskRetrieveParams, type TaskUpdateParams as TaskUpdateParams, type TaskListParams as TaskListParams, type TaskRetrieveOutputFileParams as TaskRetrieveOutputFileParams, };
|
|
245
|
+
}
|
|
246
|
+
//# sourceMappingURL=tasks.d.mts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tasks.d.mts","sourceRoot":"","sources":["../src/resources/tasks.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,QAAQ;OACb,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI9E;;OAEG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAInC;;OAEG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI9F;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAI/B;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAI5F;;OAEG;IACH,kBAAkB,CAChB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,4BAA4B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAI9C;AAED,MAAM,MAAM,QAAQ,GAChB,QAAQ,GACR,aAAa,GACb,SAAS,GACT,cAAc,GACd,SAAS,GACT,IAAI,GACJ,kBAAkB,GAClB,uBAAuB,GACvB,gCAAgC,GAChC,kBAAkB,GAClB,gBAAgB,GAChB,4BAA4B,GAC5B,0BAA0B,GAC1B,oCAAoC,CAAC;AAEzC;;;;;;GAMG;AACH,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC;AAEvE;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IAEX,UAAU,EAAE,MAAM,CAAC;IAEnB,WAAW,EAAE,OAAO,CAAC;IAErB,GAAG,EAAE,QAAQ,CAAC;IAEd,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;OAMG;IACH,MAAM,EAAE,UAAU,CAAC;IAEnB,IAAI,EAAE,MAAM,CAAC;IAEb,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAEtC,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEnC,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAEpC,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CAC1C;AAED,yBAAiB,QAAQ,CAAC;IACxB;;;;;;;;;OASG;IACH,UAAiB,IAAI;QACnB,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvB,sBAAsB,EAAE,MAAM,CAAC;QAE/B,MAAM,EAAE,MAAM,CAAC;QAEf,QAAQ,EAAE,MAAM,CAAC;QAEjB,MAAM,EAAE,MAAM,CAAC;QAEf,GAAG,EAAE,MAAM,CAAC;QAEZ,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC/B;CACF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG,oBAAoB,CAAC,cAAc,CAAC;AAElF,yBAAiB,oBAAoB,CAAC;IACpC;;;;OAIG;IACH,UAAiB,cAAc;QAC7B;;;;;;WAMG;QACH,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC;KAC7B;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEvB,UAAU,EAAE,MAAM,CAAC;IAEnB,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC;IAE/C;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,gBAAgB,CAAC,eAAe,CAAC;IAEnD,iBAAiB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;IAEzC,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5C,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE3C,oBAAoB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;;;;;OAMG;IACH,UAAiB,aAAa;QAC5B,GAAG,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAExB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;IAED;;;;;;;OAOG;IACH,UAAiB,eAAe;QAC9B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B,eAAe,CAAC,EAAE,OAAO,CAAC;QAE1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,uBAAuB,CAAC;CAC/D;AAED,MAAM,WAAW,cAAc;IAC7B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
|