oz-agent-sdk 1.0.0-alpha.10

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.
Files changed (408) hide show
  1. package/CHANGELOG.md +179 -0
  2. package/LICENSE +201 -0
  3. package/README.md +422 -0
  4. package/api-promise.d.mts +2 -0
  5. package/api-promise.d.mts.map +1 -0
  6. package/api-promise.d.ts +2 -0
  7. package/api-promise.d.ts.map +1 -0
  8. package/api-promise.js +6 -0
  9. package/api-promise.js.map +1 -0
  10. package/api-promise.mjs +2 -0
  11. package/api-promise.mjs.map +1 -0
  12. package/client.d.mts +179 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +179 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +461 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +457 -0
  19. package/client.mjs.map +1 -0
  20. package/core/api-promise.d.mts +46 -0
  21. package/core/api-promise.d.mts.map +1 -0
  22. package/core/api-promise.d.ts +46 -0
  23. package/core/api-promise.d.ts.map +1 -0
  24. package/core/api-promise.js +74 -0
  25. package/core/api-promise.js.map +1 -0
  26. package/core/api-promise.mjs +70 -0
  27. package/core/api-promise.mjs.map +1 -0
  28. package/core/error.d.mts +46 -0
  29. package/core/error.d.mts.map +1 -0
  30. package/core/error.d.ts +46 -0
  31. package/core/error.d.ts.map +1 -0
  32. package/core/error.js +113 -0
  33. package/core/error.js.map +1 -0
  34. package/core/error.mjs +97 -0
  35. package/core/error.mjs.map +1 -0
  36. package/core/resource.d.mts +6 -0
  37. package/core/resource.d.mts.map +1 -0
  38. package/core/resource.d.ts +6 -0
  39. package/core/resource.d.ts.map +1 -0
  40. package/core/resource.js +11 -0
  41. package/core/resource.js.map +1 -0
  42. package/core/resource.mjs +7 -0
  43. package/core/resource.mjs.map +1 -0
  44. package/core/uploads.d.mts +3 -0
  45. package/core/uploads.d.mts.map +1 -0
  46. package/core/uploads.d.ts +3 -0
  47. package/core/uploads.d.ts.map +1 -0
  48. package/core/uploads.js +6 -0
  49. package/core/uploads.js.map +1 -0
  50. package/core/uploads.mjs +2 -0
  51. package/core/uploads.mjs.map +1 -0
  52. package/error.d.mts +2 -0
  53. package/error.d.mts.map +1 -0
  54. package/error.d.ts +2 -0
  55. package/error.d.ts.map +1 -0
  56. package/error.js +6 -0
  57. package/error.js.map +1 -0
  58. package/error.mjs +2 -0
  59. package/error.mjs.map +1 -0
  60. package/index.d.mts +6 -0
  61. package/index.d.mts.map +1 -0
  62. package/index.d.ts +6 -0
  63. package/index.d.ts.map +1 -0
  64. package/index.js +30 -0
  65. package/index.js.map +1 -0
  66. package/index.mjs +7 -0
  67. package/index.mjs.map +1 -0
  68. package/internal/builtin-types.d.mts +73 -0
  69. package/internal/builtin-types.d.mts.map +1 -0
  70. package/internal/builtin-types.d.ts +73 -0
  71. package/internal/builtin-types.d.ts.map +1 -0
  72. package/internal/builtin-types.js +4 -0
  73. package/internal/builtin-types.js.map +1 -0
  74. package/internal/builtin-types.mjs +3 -0
  75. package/internal/builtin-types.mjs.map +1 -0
  76. package/internal/detect-platform.d.mts +15 -0
  77. package/internal/detect-platform.d.mts.map +1 -0
  78. package/internal/detect-platform.d.ts +15 -0
  79. package/internal/detect-platform.d.ts.map +1 -0
  80. package/internal/detect-platform.js +162 -0
  81. package/internal/detect-platform.js.map +1 -0
  82. package/internal/detect-platform.mjs +157 -0
  83. package/internal/detect-platform.mjs.map +1 -0
  84. package/internal/errors.d.mts +3 -0
  85. package/internal/errors.d.mts.map +1 -0
  86. package/internal/errors.d.ts +3 -0
  87. package/internal/errors.d.ts.map +1 -0
  88. package/internal/errors.js +41 -0
  89. package/internal/errors.js.map +1 -0
  90. package/internal/errors.mjs +36 -0
  91. package/internal/errors.mjs.map +1 -0
  92. package/internal/headers.d.mts +20 -0
  93. package/internal/headers.d.mts.map +1 -0
  94. package/internal/headers.d.ts +20 -0
  95. package/internal/headers.d.ts.map +1 -0
  96. package/internal/headers.js +79 -0
  97. package/internal/headers.js.map +1 -0
  98. package/internal/headers.mjs +74 -0
  99. package/internal/headers.mjs.map +1 -0
  100. package/internal/parse.d.mts +12 -0
  101. package/internal/parse.d.mts.map +1 -0
  102. package/internal/parse.d.ts +12 -0
  103. package/internal/parse.d.ts.map +1 -0
  104. package/internal/parse.js +40 -0
  105. package/internal/parse.js.map +1 -0
  106. package/internal/parse.mjs +37 -0
  107. package/internal/parse.mjs.map +1 -0
  108. package/internal/qs/formats.d.mts +7 -0
  109. package/internal/qs/formats.d.mts.map +1 -0
  110. package/internal/qs/formats.d.ts +7 -0
  111. package/internal/qs/formats.d.ts.map +1 -0
  112. package/internal/qs/formats.js +13 -0
  113. package/internal/qs/formats.js.map +1 -0
  114. package/internal/qs/formats.mjs +9 -0
  115. package/internal/qs/formats.mjs.map +1 -0
  116. package/internal/qs/index.d.mts +10 -0
  117. package/internal/qs/index.d.mts.map +1 -0
  118. package/internal/qs/index.d.ts +10 -0
  119. package/internal/qs/index.d.ts.map +1 -0
  120. package/internal/qs/index.js +14 -0
  121. package/internal/qs/index.js.map +1 -0
  122. package/internal/qs/index.mjs +10 -0
  123. package/internal/qs/index.mjs.map +1 -0
  124. package/internal/qs/stringify.d.mts +3 -0
  125. package/internal/qs/stringify.d.mts.map +1 -0
  126. package/internal/qs/stringify.d.ts +3 -0
  127. package/internal/qs/stringify.d.ts.map +1 -0
  128. package/internal/qs/stringify.js +277 -0
  129. package/internal/qs/stringify.js.map +1 -0
  130. package/internal/qs/stringify.mjs +274 -0
  131. package/internal/qs/stringify.mjs.map +1 -0
  132. package/internal/qs/types.d.mts +57 -0
  133. package/internal/qs/types.d.mts.map +1 -0
  134. package/internal/qs/types.d.ts +57 -0
  135. package/internal/qs/types.d.ts.map +1 -0
  136. package/internal/qs/types.js +3 -0
  137. package/internal/qs/types.js.map +1 -0
  138. package/internal/qs/types.mjs +2 -0
  139. package/internal/qs/types.mjs.map +1 -0
  140. package/internal/qs/utils.d.mts +15 -0
  141. package/internal/qs/utils.d.mts.map +1 -0
  142. package/internal/qs/utils.d.ts +15 -0
  143. package/internal/qs/utils.d.ts.map +1 -0
  144. package/internal/qs/utils.js +230 -0
  145. package/internal/qs/utils.js.map +1 -0
  146. package/internal/qs/utils.mjs +217 -0
  147. package/internal/qs/utils.mjs.map +1 -0
  148. package/internal/request-options.d.mts +75 -0
  149. package/internal/request-options.d.mts.map +1 -0
  150. package/internal/request-options.d.ts +75 -0
  151. package/internal/request-options.d.ts.map +1 -0
  152. package/internal/request-options.js +14 -0
  153. package/internal/request-options.js.map +1 -0
  154. package/internal/request-options.mjs +10 -0
  155. package/internal/request-options.mjs.map +1 -0
  156. package/internal/shim-types.d.mts +17 -0
  157. package/internal/shim-types.d.mts.map +1 -0
  158. package/internal/shim-types.d.ts +17 -0
  159. package/internal/shim-types.d.ts.map +1 -0
  160. package/internal/shim-types.js +4 -0
  161. package/internal/shim-types.js.map +1 -0
  162. package/internal/shim-types.mjs +3 -0
  163. package/internal/shim-types.mjs.map +1 -0
  164. package/internal/shims.d.mts +20 -0
  165. package/internal/shims.d.mts.map +1 -0
  166. package/internal/shims.d.ts +20 -0
  167. package/internal/shims.d.ts.map +1 -0
  168. package/internal/shims.js +92 -0
  169. package/internal/shims.js.map +1 -0
  170. package/internal/shims.mjs +85 -0
  171. package/internal/shims.mjs.map +1 -0
  172. package/internal/to-file.d.mts +45 -0
  173. package/internal/to-file.d.mts.map +1 -0
  174. package/internal/to-file.d.ts +45 -0
  175. package/internal/to-file.d.ts.map +1 -0
  176. package/internal/to-file.js +91 -0
  177. package/internal/to-file.js.map +1 -0
  178. package/internal/to-file.mjs +88 -0
  179. package/internal/to-file.mjs.map +1 -0
  180. package/internal/tslib.js +81 -0
  181. package/internal/tslib.mjs +17 -0
  182. package/internal/types.d.mts +69 -0
  183. package/internal/types.d.mts.map +1 -0
  184. package/internal/types.d.ts +69 -0
  185. package/internal/types.d.ts.map +1 -0
  186. package/internal/types.js +4 -0
  187. package/internal/types.js.map +1 -0
  188. package/internal/types.mjs +3 -0
  189. package/internal/types.mjs.map +1 -0
  190. package/internal/uploads.d.mts +42 -0
  191. package/internal/uploads.d.mts.map +1 -0
  192. package/internal/uploads.d.ts +42 -0
  193. package/internal/uploads.d.ts.map +1 -0
  194. package/internal/uploads.js +141 -0
  195. package/internal/uploads.js.map +1 -0
  196. package/internal/uploads.mjs +131 -0
  197. package/internal/uploads.mjs.map +1 -0
  198. package/internal/utils/base64.d.mts +3 -0
  199. package/internal/utils/base64.d.mts.map +1 -0
  200. package/internal/utils/base64.d.ts +3 -0
  201. package/internal/utils/base64.d.ts.map +1 -0
  202. package/internal/utils/base64.js +38 -0
  203. package/internal/utils/base64.js.map +1 -0
  204. package/internal/utils/base64.mjs +33 -0
  205. package/internal/utils/base64.mjs.map +1 -0
  206. package/internal/utils/bytes.d.mts +4 -0
  207. package/internal/utils/bytes.d.mts.map +1 -0
  208. package/internal/utils/bytes.d.ts +4 -0
  209. package/internal/utils/bytes.d.ts.map +1 -0
  210. package/internal/utils/bytes.js +31 -0
  211. package/internal/utils/bytes.js.map +1 -0
  212. package/internal/utils/bytes.mjs +26 -0
  213. package/internal/utils/bytes.mjs.map +1 -0
  214. package/internal/utils/env.d.mts +9 -0
  215. package/internal/utils/env.d.mts.map +1 -0
  216. package/internal/utils/env.d.ts +9 -0
  217. package/internal/utils/env.d.ts.map +1 -0
  218. package/internal/utils/env.js +22 -0
  219. package/internal/utils/env.js.map +1 -0
  220. package/internal/utils/env.mjs +18 -0
  221. package/internal/utils/env.mjs.map +1 -0
  222. package/internal/utils/log.d.mts +37 -0
  223. package/internal/utils/log.d.mts.map +1 -0
  224. package/internal/utils/log.d.ts +37 -0
  225. package/internal/utils/log.d.ts.map +1 -0
  226. package/internal/utils/log.js +85 -0
  227. package/internal/utils/log.js.map +1 -0
  228. package/internal/utils/log.mjs +79 -0
  229. package/internal/utils/log.mjs.map +1 -0
  230. package/internal/utils/path.d.mts +15 -0
  231. package/internal/utils/path.d.mts.map +1 -0
  232. package/internal/utils/path.d.ts +15 -0
  233. package/internal/utils/path.d.ts.map +1 -0
  234. package/internal/utils/path.js +79 -0
  235. package/internal/utils/path.js.map +1 -0
  236. package/internal/utils/path.mjs +74 -0
  237. package/internal/utils/path.mjs.map +1 -0
  238. package/internal/utils/sleep.d.mts +2 -0
  239. package/internal/utils/sleep.d.mts.map +1 -0
  240. package/internal/utils/sleep.d.ts +2 -0
  241. package/internal/utils/sleep.d.ts.map +1 -0
  242. package/internal/utils/sleep.js +7 -0
  243. package/internal/utils/sleep.js.map +1 -0
  244. package/internal/utils/sleep.mjs +3 -0
  245. package/internal/utils/sleep.mjs.map +1 -0
  246. package/internal/utils/uuid.d.mts +5 -0
  247. package/internal/utils/uuid.d.mts.map +1 -0
  248. package/internal/utils/uuid.d.ts +5 -0
  249. package/internal/utils/uuid.d.ts.map +1 -0
  250. package/internal/utils/uuid.js +19 -0
  251. package/internal/utils/uuid.js.map +1 -0
  252. package/internal/utils/uuid.mjs +15 -0
  253. package/internal/utils/uuid.mjs.map +1 -0
  254. package/internal/utils/values.d.mts +18 -0
  255. package/internal/utils/values.d.mts.map +1 -0
  256. package/internal/utils/values.d.ts +18 -0
  257. package/internal/utils/values.d.ts.map +1 -0
  258. package/internal/utils/values.js +112 -0
  259. package/internal/utils/values.js.map +1 -0
  260. package/internal/utils/values.mjs +94 -0
  261. package/internal/utils/values.mjs.map +1 -0
  262. package/internal/utils.d.mts +7 -0
  263. package/internal/utils.d.mts.map +1 -0
  264. package/internal/utils.d.ts +7 -0
  265. package/internal/utils.d.ts.map +1 -0
  266. package/internal/utils.js +11 -0
  267. package/internal/utils.js.map +1 -0
  268. package/internal/utils.mjs +8 -0
  269. package/internal/utils.mjs.map +1 -0
  270. package/package.json +137 -0
  271. package/resource.d.mts +2 -0
  272. package/resource.d.mts.map +1 -0
  273. package/resource.d.ts +2 -0
  274. package/resource.d.ts.map +1 -0
  275. package/resource.js +6 -0
  276. package/resource.js.map +1 -0
  277. package/resource.mjs +2 -0
  278. package/resource.mjs.map +1 -0
  279. package/resources/agent/agent.d.mts +413 -0
  280. package/resources/agent/agent.d.mts.map +1 -0
  281. package/resources/agent/agent.d.ts +413 -0
  282. package/resources/agent/agent.d.ts.map +1 -0
  283. package/resources/agent/agent.js +66 -0
  284. package/resources/agent/agent.js.map +1 -0
  285. package/resources/agent/agent.mjs +61 -0
  286. package/resources/agent/agent.mjs.map +1 -0
  287. package/resources/agent/index.d.mts +5 -0
  288. package/resources/agent/index.d.mts.map +1 -0
  289. package/resources/agent/index.d.ts +5 -0
  290. package/resources/agent/index.d.ts.map +1 -0
  291. package/resources/agent/index.js +13 -0
  292. package/resources/agent/index.js.map +1 -0
  293. package/resources/agent/index.mjs +6 -0
  294. package/resources/agent/index.mjs.map +1 -0
  295. package/resources/agent/runs.d.mts +412 -0
  296. package/resources/agent/runs.d.mts.map +1 -0
  297. package/resources/agent/runs.d.ts +412 -0
  298. package/resources/agent/runs.d.ts.map +1 -0
  299. package/resources/agent/runs.js +46 -0
  300. package/resources/agent/runs.js.map +1 -0
  301. package/resources/agent/runs.mjs +42 -0
  302. package/resources/agent/runs.mjs.map +1 -0
  303. package/resources/agent/schedules.d.mts +241 -0
  304. package/resources/agent/schedules.d.mts.map +1 -0
  305. package/resources/agent/schedules.d.ts +241 -0
  306. package/resources/agent/schedules.d.ts.map +1 -0
  307. package/resources/agent/schedules.js +110 -0
  308. package/resources/agent/schedules.js.map +1 -0
  309. package/resources/agent/schedules.mjs +106 -0
  310. package/resources/agent/schedules.mjs.map +1 -0
  311. package/resources/agent/sessions.d.mts +28 -0
  312. package/resources/agent/sessions.d.mts.map +1 -0
  313. package/resources/agent/sessions.d.ts +28 -0
  314. package/resources/agent/sessions.d.ts.map +1 -0
  315. package/resources/agent/sessions.js +25 -0
  316. package/resources/agent/sessions.js.map +1 -0
  317. package/resources/agent/sessions.mjs +21 -0
  318. package/resources/agent/sessions.mjs.map +1 -0
  319. package/resources/agent.d.mts +2 -0
  320. package/resources/agent.d.mts.map +1 -0
  321. package/resources/agent.d.ts +2 -0
  322. package/resources/agent.d.ts.map +1 -0
  323. package/resources/agent.js +6 -0
  324. package/resources/agent.js.map +1 -0
  325. package/resources/agent.mjs +3 -0
  326. package/resources/agent.mjs.map +1 -0
  327. package/resources/index.d.mts +2 -0
  328. package/resources/index.d.mts.map +1 -0
  329. package/resources/index.d.ts +2 -0
  330. package/resources/index.d.ts.map +1 -0
  331. package/resources/index.js +7 -0
  332. package/resources/index.js.map +1 -0
  333. package/resources/index.mjs +3 -0
  334. package/resources/index.mjs.map +1 -0
  335. package/resources.d.mts +2 -0
  336. package/resources.d.mts.map +1 -0
  337. package/resources.d.ts +2 -0
  338. package/resources.d.ts.map +1 -0
  339. package/resources.js +5 -0
  340. package/resources.js.map +1 -0
  341. package/resources.mjs +2 -0
  342. package/resources.mjs.map +1 -0
  343. package/src/api-promise.ts +2 -0
  344. package/src/client.ts +751 -0
  345. package/src/core/README.md +3 -0
  346. package/src/core/api-promise.ts +92 -0
  347. package/src/core/error.ts +130 -0
  348. package/src/core/resource.ts +11 -0
  349. package/src/core/uploads.ts +2 -0
  350. package/src/error.ts +2 -0
  351. package/src/index.ts +22 -0
  352. package/src/internal/README.md +3 -0
  353. package/src/internal/builtin-types.ts +93 -0
  354. package/src/internal/detect-platform.ts +196 -0
  355. package/src/internal/errors.ts +33 -0
  356. package/src/internal/headers.ts +97 -0
  357. package/src/internal/parse.ts +56 -0
  358. package/src/internal/qs/LICENSE.md +13 -0
  359. package/src/internal/qs/README.md +3 -0
  360. package/src/internal/qs/formats.ts +10 -0
  361. package/src/internal/qs/index.ts +13 -0
  362. package/src/internal/qs/stringify.ts +385 -0
  363. package/src/internal/qs/types.ts +71 -0
  364. package/src/internal/qs/utils.ts +265 -0
  365. package/src/internal/request-options.ts +91 -0
  366. package/src/internal/shim-types.ts +26 -0
  367. package/src/internal/shims.ts +107 -0
  368. package/src/internal/to-file.ts +154 -0
  369. package/src/internal/types.ts +95 -0
  370. package/src/internal/uploads.ts +187 -0
  371. package/src/internal/utils/base64.ts +40 -0
  372. package/src/internal/utils/bytes.ts +32 -0
  373. package/src/internal/utils/env.ts +18 -0
  374. package/src/internal/utils/log.ts +126 -0
  375. package/src/internal/utils/path.ts +88 -0
  376. package/src/internal/utils/sleep.ts +3 -0
  377. package/src/internal/utils/uuid.ts +17 -0
  378. package/src/internal/utils/values.ts +105 -0
  379. package/src/internal/utils.ts +8 -0
  380. package/src/lib/.keep +4 -0
  381. package/src/resource.ts +2 -0
  382. package/src/resources/agent/agent.ts +538 -0
  383. package/src/resources/agent/index.ts +34 -0
  384. package/src/resources/agent/runs.ts +527 -0
  385. package/src/resources/agent/schedules.ts +306 -0
  386. package/src/resources/agent/sessions.ts +35 -0
  387. package/src/resources/agent.ts +3 -0
  388. package/src/resources/index.ts +15 -0
  389. package/src/resources.ts +1 -0
  390. package/src/tsconfig.json +11 -0
  391. package/src/uploads.ts +2 -0
  392. package/src/version.ts +1 -0
  393. package/uploads.d.mts +2 -0
  394. package/uploads.d.mts.map +1 -0
  395. package/uploads.d.ts +2 -0
  396. package/uploads.d.ts.map +1 -0
  397. package/uploads.js +6 -0
  398. package/uploads.js.map +1 -0
  399. package/uploads.mjs +2 -0
  400. package/uploads.mjs.map +1 -0
  401. package/version.d.mts +2 -0
  402. package/version.d.mts.map +1 -0
  403. package/version.d.ts +2 -0
  404. package/version.d.ts.map +1 -0
  405. package/version.js +5 -0
  406. package/version.js.map +1 -0
  407. package/version.mjs +2 -0
  408. package/version.mjs.map +1 -0
@@ -0,0 +1,413 @@
1
+ import { APIResource } from "../../core/resource.mjs";
2
+ import * as RunsAPI from "./runs.mjs";
3
+ import { ArtifactItem, RunCancelResponse, RunItem, RunListParams, RunListResponse, RunSourceType, RunState, Runs } from "./runs.mjs";
4
+ import * as SchedulesAPI from "./schedules.mjs";
5
+ import { ScheduleCreateParams, ScheduleDeleteResponse, ScheduleListResponse, ScheduleUpdateParams, ScheduledAgentItem, Schedules } from "./schedules.mjs";
6
+ import * as SessionsAPI from "./sessions.mjs";
7
+ import { SessionCheckRedirectResponse, Sessions } from "./sessions.mjs";
8
+ import { APIPromise } from "../../core/api-promise.mjs";
9
+ import { RequestOptions } from "../../internal/request-options.mjs";
10
+ export declare class Agent extends APIResource {
11
+ runs: RunsAPI.Runs;
12
+ schedules: SchedulesAPI.Schedules;
13
+ sessions: SessionsAPI.Sessions;
14
+ /**
15
+ * Retrieve a list of available agents (skills) that can be used to run tasks.
16
+ * Agents are discovered from environments or a specific repository.
17
+ *
18
+ * @example
19
+ * ```ts
20
+ * const agents = await client.agent.list();
21
+ * ```
22
+ */
23
+ list(query?: AgentListParams | null | undefined, options?: RequestOptions): APIPromise<AgentListResponse>;
24
+ /**
25
+ * Retrieve an artifact by its UUID. For screenshot artifacts, returns a
26
+ * time-limited signed download URL.
27
+ *
28
+ * @example
29
+ * ```ts
30
+ * const response = await client.agent.getArtifact(
31
+ * 'artifactUid',
32
+ * );
33
+ * ```
34
+ */
35
+ getArtifact(artifactUid: string, options?: RequestOptions): APIPromise<AgentGetArtifactResponse>;
36
+ /**
37
+ * Spawn a cloud agent with a prompt and optional configuration. The agent will be
38
+ * queued for execution and assigned a unique run ID.
39
+ *
40
+ * @example
41
+ * ```ts
42
+ * const response = await client.agent.run({
43
+ * prompt: 'Fix the bug in auth.go',
44
+ * });
45
+ * ```
46
+ */
47
+ run(body: AgentRunParams, options?: RequestOptions): APIPromise<AgentRunResponse>;
48
+ }
49
+ export interface AgentSkill {
50
+ /**
51
+ * Human-readable name of the agent
52
+ */
53
+ name: string;
54
+ /**
55
+ * Available variants of this agent
56
+ */
57
+ variants: Array<AgentSkill.Variant>;
58
+ }
59
+ export declare namespace AgentSkill {
60
+ interface Variant {
61
+ /**
62
+ * Stable identifier for this skill variant. Format: "{owner}/{repo}:{skill_path}"
63
+ * Example: "warpdotdev/warp-server:.claude/skills/deploy/SKILL.md"
64
+ */
65
+ id: string;
66
+ /**
67
+ * Base prompt/instructions for the agent
68
+ */
69
+ base_prompt: string;
70
+ /**
71
+ * Description of the agent variant
72
+ */
73
+ description: string;
74
+ /**
75
+ * Environments where this agent variant is available
76
+ */
77
+ environments: Array<Variant.Environment>;
78
+ source: Variant.Source;
79
+ /**
80
+ * Timestamp of the last time this skill was run (RFC3339)
81
+ */
82
+ last_run_timestamp?: string | null;
83
+ }
84
+ namespace Variant {
85
+ interface Environment {
86
+ /**
87
+ * Human-readable name of the environment
88
+ */
89
+ name: string;
90
+ /**
91
+ * Unique identifier for the environment
92
+ */
93
+ uid: string;
94
+ }
95
+ interface Source {
96
+ /**
97
+ * GitHub repository name
98
+ */
99
+ name: string;
100
+ /**
101
+ * GitHub repository owner
102
+ */
103
+ owner: string;
104
+ /**
105
+ * Path to the skill definition file within the repository
106
+ */
107
+ skill_path: string;
108
+ }
109
+ }
110
+ }
111
+ /**
112
+ * Configuration for a cloud agent run
113
+ */
114
+ export interface AmbientAgentConfig {
115
+ /**
116
+ * Custom base prompt for the agent
117
+ */
118
+ base_prompt?: string;
119
+ /**
120
+ * Controls whether computer use is enabled for this agent. If not set, defaults to
121
+ * false.
122
+ */
123
+ computer_use_enabled?: boolean;
124
+ /**
125
+ * UID of the environment to run the agent in
126
+ */
127
+ environment_id?: string;
128
+ /**
129
+ * Map of MCP server configurations by name
130
+ */
131
+ mcp_servers?: {
132
+ [key: string]: McpServerConfig;
133
+ };
134
+ /**
135
+ * LLM model to use (uses team default if not specified)
136
+ */
137
+ model_id?: string;
138
+ /**
139
+ * Human-readable label for grouping, filtering, and traceability. Automatically
140
+ * set to the skill name when running a skill-based agent. Set this explicitly to
141
+ * categorize runs by intent (e.g., "nightly-dependency-check") so you can filter
142
+ * and track them via the name query parameter on GET /agent/runs.
143
+ */
144
+ name?: string;
145
+ /**
146
+ * Skill specification identifying which agent skill to use. Format:
147
+ * "{owner}/{repo}:{skill_path}" Example:
148
+ * "warpdotdev/warp-server:.claude/skills/deploy/SKILL.md" Use the list agents
149
+ * endpoint to discover available skills.
150
+ */
151
+ skill_spec?: string;
152
+ /**
153
+ * Self-hosted worker ID that should execute this task. If not specified or set to
154
+ * "warp", the task runs on Warp-hosted workers.
155
+ */
156
+ worker_host?: string;
157
+ }
158
+ /**
159
+ * Configuration for a cloud environment used by scheduled agents
160
+ */
161
+ export interface CloudEnvironmentConfig {
162
+ /**
163
+ * Optional description of the environment
164
+ */
165
+ description?: string | null;
166
+ /**
167
+ * Docker image to use (e.g., "ubuntu:latest" or "registry/repo:tag")
168
+ */
169
+ docker_image?: string;
170
+ /**
171
+ * List of GitHub repositories to clone into the environment
172
+ */
173
+ github_repos?: Array<CloudEnvironmentConfig.GitHubRepo>;
174
+ /**
175
+ * Human-readable name for the environment
176
+ */
177
+ name?: string;
178
+ /**
179
+ * Shell commands to run during environment setup
180
+ */
181
+ setup_commands?: Array<string>;
182
+ }
183
+ export declare namespace CloudEnvironmentConfig {
184
+ interface GitHubRepo {
185
+ /**
186
+ * GitHub repository owner (user or organization)
187
+ */
188
+ owner: string;
189
+ /**
190
+ * GitHub repository name
191
+ */
192
+ repo: string;
193
+ }
194
+ }
195
+ /**
196
+ * Configuration for an MCP server. Must have exactly one of: warp_id, command, or
197
+ * url.
198
+ */
199
+ export interface McpServerConfig {
200
+ /**
201
+ * Stdio transport - command arguments
202
+ */
203
+ args?: Array<string>;
204
+ /**
205
+ * Stdio transport - command to run
206
+ */
207
+ command?: string;
208
+ /**
209
+ * Environment variables for the server
210
+ */
211
+ env?: {
212
+ [key: string]: string;
213
+ };
214
+ /**
215
+ * HTTP headers for SSE/HTTP transport
216
+ */
217
+ headers?: {
218
+ [key: string]: string;
219
+ };
220
+ /**
221
+ * SSE/HTTP transport - server URL
222
+ */
223
+ url?: string;
224
+ /**
225
+ * Reference to a Warp shared MCP server by UUID
226
+ */
227
+ warp_id?: string;
228
+ }
229
+ export interface UserProfile {
230
+ /**
231
+ * Display name of the creator
232
+ */
233
+ display_name?: string;
234
+ /**
235
+ * Email address of the creator
236
+ */
237
+ email?: string;
238
+ /**
239
+ * URL to the creator's photo
240
+ */
241
+ photo_url?: string;
242
+ /**
243
+ * Type of the creator principal
244
+ */
245
+ type?: 'user' | 'service_account';
246
+ /**
247
+ * Unique identifier of the creator
248
+ */
249
+ uid?: string;
250
+ }
251
+ export interface AgentListResponse {
252
+ /**
253
+ * List of available agents
254
+ */
255
+ agents: Array<AgentSkill>;
256
+ }
257
+ /**
258
+ * Response for artifact retrieval. Currently supports screenshot artifacts.
259
+ */
260
+ export interface AgentGetArtifactResponse {
261
+ /**
262
+ * Type of the artifact (e.g., SCREENSHOT)
263
+ */
264
+ artifact_type: string;
265
+ /**
266
+ * Unique identifier (UUID) for the artifact
267
+ */
268
+ artifact_uid: string;
269
+ /**
270
+ * Timestamp when the artifact was created (RFC3339)
271
+ */
272
+ created_at: string;
273
+ /**
274
+ * Response data for a screenshot artifact, including a signed download URL.
275
+ */
276
+ data: AgentGetArtifactResponse.Data;
277
+ }
278
+ export declare namespace AgentGetArtifactResponse {
279
+ /**
280
+ * Response data for a screenshot artifact, including a signed download URL.
281
+ */
282
+ interface Data {
283
+ /**
284
+ * MIME type of the screenshot (e.g., image/png)
285
+ */
286
+ content_type: string;
287
+ /**
288
+ * Time-limited signed URL to download the screenshot
289
+ */
290
+ download_url: string;
291
+ /**
292
+ * Timestamp when the download URL expires (RFC3339)
293
+ */
294
+ expires_at: string;
295
+ /**
296
+ * Optional description of the screenshot
297
+ */
298
+ description?: string;
299
+ }
300
+ }
301
+ export interface AgentRunResponse {
302
+ /**
303
+ * Unique identifier for the created run
304
+ */
305
+ run_id: string;
306
+ /**
307
+ * Current state of the run:
308
+ *
309
+ * - QUEUED: Run is waiting to be picked up
310
+ * - PENDING: Run is being prepared
311
+ * - CLAIMED: Run has been claimed by a worker
312
+ * - INPROGRESS: Run is actively being executed
313
+ * - SUCCEEDED: Run completed successfully
314
+ * - FAILED: Run failed
315
+ * - BLOCKED: Run is blocked (e.g., awaiting user input or approval)
316
+ * - ERROR: Run encountered an error
317
+ * - CANCELLED: Run was cancelled by user
318
+ */
319
+ state: RunsAPI.RunState;
320
+ /**
321
+ * @deprecated Use run_id instead.
322
+ */
323
+ task_id: string;
324
+ /**
325
+ * Whether the system is at capacity when the run was created
326
+ */
327
+ at_capacity?: boolean;
328
+ }
329
+ export interface AgentListParams {
330
+ /**
331
+ * When true, clears the agent list cache before fetching. Use this to force a
332
+ * refresh of the available agents.
333
+ */
334
+ refresh?: boolean;
335
+ /**
336
+ * Optional repository specification to list agents from (format: "owner/repo"). If
337
+ * not provided, lists agents from all accessible environments.
338
+ */
339
+ repo?: string;
340
+ /**
341
+ * Sort order for the returned agents.
342
+ *
343
+ * - "name": Sort alphabetically by name (default)
344
+ * - "last_run": Sort by most recently used
345
+ */
346
+ sort_by?: 'name' | 'last_run';
347
+ }
348
+ export interface AgentRunParams {
349
+ /**
350
+ * Optional file attachments to include with the prompt (max 5). Attachments are
351
+ * uploaded to cloud storage and made available to the agent.
352
+ */
353
+ attachments?: Array<AgentRunParams.Attachment>;
354
+ /**
355
+ * Configuration for a cloud agent run
356
+ */
357
+ config?: AmbientAgentConfig;
358
+ /**
359
+ * Optional conversation ID to continue an existing conversation. If provided, the
360
+ * agent will continue from where the previous run left off.
361
+ */
362
+ conversation_id?: string;
363
+ /**
364
+ * The prompt/instruction for the agent to execute. Required unless a skill is
365
+ * specified via the skill field or config.skill_spec.
366
+ */
367
+ prompt?: string;
368
+ /**
369
+ * Skill specification to use as the base prompt for the agent. Supported formats:
370
+ *
371
+ * - "repo:skill_name" - Simple name in specific repo
372
+ * - "repo:skill_path" - Full path in specific repo
373
+ * - "org/repo:skill_name" - Simple name with org and repo
374
+ * - "org/repo:skill_path" - Full path with org and repo When provided, this takes
375
+ * precedence over config.skill_spec.
376
+ */
377
+ skill?: string;
378
+ /**
379
+ * Whether to create a team-owned run. Defaults to true for users on a single team.
380
+ */
381
+ team?: boolean;
382
+ /**
383
+ * Custom title for the run (auto-generated if not provided)
384
+ */
385
+ title?: string;
386
+ }
387
+ export declare namespace AgentRunParams {
388
+ /**
389
+ * A base64-encoded file attachment to include with the prompt
390
+ */
391
+ interface Attachment {
392
+ /**
393
+ * Base64-encoded attachment data
394
+ */
395
+ data: string;
396
+ /**
397
+ * Name of the attached file
398
+ */
399
+ file_name: string;
400
+ /**
401
+ * MIME type of the attachment. Supported image types: image/jpeg, image/png,
402
+ * image/gif, image/webp
403
+ */
404
+ mime_type: string;
405
+ }
406
+ }
407
+ export declare namespace Agent {
408
+ export { type AgentSkill as AgentSkill, type AmbientAgentConfig as AmbientAgentConfig, type CloudEnvironmentConfig as CloudEnvironmentConfig, type McpServerConfig as McpServerConfig, type UserProfile as UserProfile, type AgentListResponse as AgentListResponse, type AgentGetArtifactResponse as AgentGetArtifactResponse, type AgentRunResponse as AgentRunResponse, type AgentListParams as AgentListParams, type AgentRunParams as AgentRunParams, };
409
+ export { Runs as Runs, type ArtifactItem as ArtifactItem, type RunItem as RunItem, type RunSourceType as RunSourceType, type RunState as RunState, type RunListResponse as RunListResponse, type RunCancelResponse as RunCancelResponse, type RunListParams as RunListParams, };
410
+ export { Schedules as Schedules, type ScheduledAgentItem as ScheduledAgentItem, type ScheduleListResponse as ScheduleListResponse, type ScheduleDeleteResponse as ScheduleDeleteResponse, type ScheduleCreateParams as ScheduleCreateParams, type ScheduleUpdateParams as ScheduleUpdateParams, };
411
+ export { Sessions as Sessions, type SessionCheckRedirectResponse as SessionCheckRedirectResponse };
412
+ }
413
+ //# sourceMappingURL=agent.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"agent.d.mts","sourceRoot":"","sources":["../../src/resources/agent/agent.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,EACL,YAAY,EACZ,iBAAiB,EACjB,OAAO,EACP,aAAa,EACb,eAAe,EACf,aAAa,EACb,QAAQ,EACR,IAAI,EACL;OACM,KAAK,YAAY;OACjB,EACL,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,SAAS,EACV;OACM,KAAK,WAAW;OAChB,EAAE,4BAA4B,EAAE,QAAQ,EAAE;OAC1C,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,KAAM,SAAQ,WAAW;IACpC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAkC;IACpD,SAAS,EAAE,YAAY,CAAC,SAAS,CAA4C;IAC7E,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAIhC;;;;;;;;;;OAUG;IACH,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIhG;;;;;;;;;;OAUG;IACH,GAAG,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;CAGlF;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;CACrC;AAED,yBAAiB,UAAU,CAAC;IAC1B,UAAiB,OAAO;QACtB;;;WAGG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAEzC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC;QAEvB;;WAEG;QACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACpC;IAED,UAAiB,OAAO,CAAC;QACvB,UAAiB,WAAW;YAC1B;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;QAED,UAAiB,MAAM;YACrB;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,UAAU,EAAE,MAAM,CAAC;SACpB;KACF;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAA;KAAE,CAAC;IAEjD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAExD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAChC;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,UAAU;QACzB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,GAAG,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEhC;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEpC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,iBAAiB,CAAC;IAElC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,wBAAwB,CAAC,IAAI,CAAC;CACrC;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;OAYG;IACH,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;CAC/B;AAED,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAE/C;;OAEG;IACH,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAE5B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,cAAc,CAAC;IAC9B;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF;AAMD,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;IAEF,OAAO,EACL,IAAI,IAAI,IAAI,EACZ,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,aAAa,IAAI,aAAa,GACpC,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EAAE,QAAQ,IAAI,QAAQ,EAAE,KAAK,4BAA4B,IAAI,4BAA4B,EAAE,CAAC;CACpG"}