@scenario-labs/sdk 0.1.2

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 (588) hide show
  1. package/CHANGELOG.md +33 -0
  2. package/LICENSE +201 -0
  3. package/README.md +358 -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 +208 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +208 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +492 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +488 -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/query.d.mts +2 -0
  239. package/internal/utils/query.d.mts.map +1 -0
  240. package/internal/utils/query.d.ts +2 -0
  241. package/internal/utils/query.d.ts.map +1 -0
  242. package/internal/utils/query.js +10 -0
  243. package/internal/utils/query.js.map +1 -0
  244. package/internal/utils/query.mjs +6 -0
  245. package/internal/utils/query.mjs.map +1 -0
  246. package/internal/utils/sleep.d.mts +2 -0
  247. package/internal/utils/sleep.d.mts.map +1 -0
  248. package/internal/utils/sleep.d.ts +2 -0
  249. package/internal/utils/sleep.d.ts.map +1 -0
  250. package/internal/utils/sleep.js +7 -0
  251. package/internal/utils/sleep.js.map +1 -0
  252. package/internal/utils/sleep.mjs +3 -0
  253. package/internal/utils/sleep.mjs.map +1 -0
  254. package/internal/utils/uuid.d.mts +5 -0
  255. package/internal/utils/uuid.d.mts.map +1 -0
  256. package/internal/utils/uuid.d.ts +5 -0
  257. package/internal/utils/uuid.d.ts.map +1 -0
  258. package/internal/utils/uuid.js +19 -0
  259. package/internal/utils/uuid.js.map +1 -0
  260. package/internal/utils/uuid.mjs +15 -0
  261. package/internal/utils/uuid.mjs.map +1 -0
  262. package/internal/utils/values.d.mts +18 -0
  263. package/internal/utils/values.d.mts.map +1 -0
  264. package/internal/utils/values.d.ts +18 -0
  265. package/internal/utils/values.d.ts.map +1 -0
  266. package/internal/utils/values.js +112 -0
  267. package/internal/utils/values.js.map +1 -0
  268. package/internal/utils/values.mjs +94 -0
  269. package/internal/utils/values.mjs.map +1 -0
  270. package/internal/utils.d.mts +8 -0
  271. package/internal/utils.d.mts.map +1 -0
  272. package/internal/utils.d.ts +8 -0
  273. package/internal/utils.d.ts.map +1 -0
  274. package/internal/utils.js +12 -0
  275. package/internal/utils.js.map +1 -0
  276. package/internal/utils.mjs +9 -0
  277. package/internal/utils.mjs.map +1 -0
  278. package/package.json +143 -0
  279. package/resource.d.mts +2 -0
  280. package/resource.d.mts.map +1 -0
  281. package/resource.d.ts +2 -0
  282. package/resource.d.ts.map +1 -0
  283. package/resource.js +6 -0
  284. package/resource.js.map +1 -0
  285. package/resource.mjs +2 -0
  286. package/resource.mjs.map +1 -0
  287. package/resources/assets/assets.d.mts +6397 -0
  288. package/resources/assets/assets.d.mts.map +1 -0
  289. package/resources/assets/assets.d.ts +6397 -0
  290. package/resources/assets/assets.d.ts.map +1 -0
  291. package/resources/assets/assets.js +98 -0
  292. package/resources/assets/assets.js.map +1 -0
  293. package/resources/assets/assets.mjs +93 -0
  294. package/resources/assets/assets.mjs.map +1 -0
  295. package/resources/assets/download.d.mts +87 -0
  296. package/resources/assets/download.d.mts.map +1 -0
  297. package/resources/assets/download.d.ts +87 -0
  298. package/resources/assets/download.d.ts.map +1 -0
  299. package/resources/assets/download.js +28 -0
  300. package/resources/assets/download.js.map +1 -0
  301. package/resources/assets/download.mjs +24 -0
  302. package/resources/assets/download.mjs.map +1 -0
  303. package/resources/assets/index.d.mts +4 -0
  304. package/resources/assets/index.d.mts.map +1 -0
  305. package/resources/assets/index.d.ts +4 -0
  306. package/resources/assets/index.d.ts.map +1 -0
  307. package/resources/assets/index.js +11 -0
  308. package/resources/assets/index.js.map +1 -0
  309. package/resources/assets/index.mjs +5 -0
  310. package/resources/assets/index.mjs.map +1 -0
  311. package/resources/assets/public.d.mts +1535 -0
  312. package/resources/assets/public.d.mts.map +1 -0
  313. package/resources/assets/public.d.ts +1535 -0
  314. package/resources/assets/public.d.ts.map +1 -0
  315. package/resources/assets/public.js +28 -0
  316. package/resources/assets/public.js.map +1 -0
  317. package/resources/assets/public.mjs +24 -0
  318. package/resources/assets/public.mjs.map +1 -0
  319. package/resources/assets.d.mts +2 -0
  320. package/resources/assets.d.mts.map +1 -0
  321. package/resources/assets.d.ts +2 -0
  322. package/resources/assets.d.ts.map +1 -0
  323. package/resources/assets.js +6 -0
  324. package/resources/assets.js.map +1 -0
  325. package/resources/assets.mjs +3 -0
  326. package/resources/assets.mjs.map +1 -0
  327. package/resources/collections/assets.d.mts +119 -0
  328. package/resources/collections/assets.d.mts.map +1 -0
  329. package/resources/collections/assets.d.ts +119 -0
  330. package/resources/collections/assets.d.ts.map +1 -0
  331. package/resources/collections/assets.js +22 -0
  332. package/resources/collections/assets.js.map +1 -0
  333. package/resources/collections/assets.mjs +18 -0
  334. package/resources/collections/assets.mjs.map +1 -0
  335. package/resources/collections/collections.d.mts +250 -0
  336. package/resources/collections/collections.d.mts.map +1 -0
  337. package/resources/collections/collections.d.ts +250 -0
  338. package/resources/collections/collections.d.ts.map +1 -0
  339. package/resources/collections/collections.js +52 -0
  340. package/resources/collections/collections.js.map +1 -0
  341. package/resources/collections/collections.mjs +47 -0
  342. package/resources/collections/collections.mjs.map +1 -0
  343. package/resources/collections/index.d.mts +4 -0
  344. package/resources/collections/index.d.mts.map +1 -0
  345. package/resources/collections/index.d.ts +4 -0
  346. package/resources/collections/index.d.ts.map +1 -0
  347. package/resources/collections/index.js +11 -0
  348. package/resources/collections/index.js.map +1 -0
  349. package/resources/collections/index.mjs +5 -0
  350. package/resources/collections/index.mjs.map +1 -0
  351. package/resources/collections/models.d.mts +119 -0
  352. package/resources/collections/models.d.mts.map +1 -0
  353. package/resources/collections/models.d.ts +119 -0
  354. package/resources/collections/models.d.ts.map +1 -0
  355. package/resources/collections/models.js +22 -0
  356. package/resources/collections/models.js.map +1 -0
  357. package/resources/collections/models.mjs +18 -0
  358. package/resources/collections/models.mjs.map +1 -0
  359. package/resources/collections.d.mts +2 -0
  360. package/resources/collections.d.mts.map +1 -0
  361. package/resources/collections.d.ts +2 -0
  362. package/resources/collections.d.ts.map +1 -0
  363. package/resources/collections.js +6 -0
  364. package/resources/collections.js.map +1 -0
  365. package/resources/collections.mjs +3 -0
  366. package/resources/collections.mjs.map +1 -0
  367. package/resources/generate.d.mts +3804 -0
  368. package/resources/generate.d.mts.map +1 -0
  369. package/resources/generate.d.ts +3804 -0
  370. package/resources/generate.d.ts.map +1 -0
  371. package/resources/generate.js +70 -0
  372. package/resources/generate.js.map +1 -0
  373. package/resources/generate.mjs +66 -0
  374. package/resources/generate.mjs.map +1 -0
  375. package/resources/index.d.mts +12 -0
  376. package/resources/index.d.mts.map +1 -0
  377. package/resources/index.d.ts +12 -0
  378. package/resources/index.d.ts.map +1 -0
  379. package/resources/index.js +27 -0
  380. package/resources/index.js.map +1 -0
  381. package/resources/index.mjs +13 -0
  382. package/resources/index.mjs.map +1 -0
  383. package/resources/jobs.d.mts +1191 -0
  384. package/resources/jobs.d.mts.map +1 -0
  385. package/resources/jobs.d.ts +1191 -0
  386. package/resources/jobs.d.ts.map +1 -0
  387. package/resources/jobs.js +31 -0
  388. package/resources/jobs.js.map +1 -0
  389. package/resources/jobs.mjs +27 -0
  390. package/resources/jobs.mjs.map +1 -0
  391. package/resources/models/description.d.mts +490 -0
  392. package/resources/models/description.d.mts.map +1 -0
  393. package/resources/models/description.d.ts +490 -0
  394. package/resources/models/description.d.ts.map +1 -0
  395. package/resources/models/description.js +27 -0
  396. package/resources/models/description.js.map +1 -0
  397. package/resources/models/description.mjs +23 -0
  398. package/resources/models/description.mjs.map +1 -0
  399. package/resources/models/examples.d.mts +2819 -0
  400. package/resources/models/examples.d.mts.map +1 -0
  401. package/resources/models/examples.d.ts +2819 -0
  402. package/resources/models/examples.d.ts.map +1 -0
  403. package/resources/models/examples.js +27 -0
  404. package/resources/models/examples.js.map +1 -0
  405. package/resources/models/examples.mjs +23 -0
  406. package/resources/models/examples.mjs.map +1 -0
  407. package/resources/models/index.d.mts +6 -0
  408. package/resources/models/index.d.mts.map +1 -0
  409. package/resources/models/index.d.ts +6 -0
  410. package/resources/models/index.d.ts.map +1 -0
  411. package/resources/models/index.js +15 -0
  412. package/resources/models/index.js.map +1 -0
  413. package/resources/models/index.mjs +7 -0
  414. package/resources/models/index.mjs.map +1 -0
  415. package/resources/models/models.d.mts +6676 -0
  416. package/resources/models/models.d.mts.map +1 -0
  417. package/resources/models/models.d.ts +6676 -0
  418. package/resources/models/models.d.ts.map +1 -0
  419. package/resources/models/models.js +107 -0
  420. package/resources/models/models.js.map +1 -0
  421. package/resources/models/models.mjs +102 -0
  422. package/resources/models/models.mjs.map +1 -0
  423. package/resources/models/train.d.mts +2334 -0
  424. package/resources/models/train.d.mts.map +1 -0
  425. package/resources/models/train.d.ts +2334 -0
  426. package/resources/models/train.d.ts.map +1 -0
  427. package/resources/models/train.js +27 -0
  428. package/resources/models/train.js.map +1 -0
  429. package/resources/models/train.mjs +23 -0
  430. package/resources/models/train.mjs.map +1 -0
  431. package/resources/models/training-images.d.mts +214 -0
  432. package/resources/models/training-images.d.mts.map +1 -0
  433. package/resources/models/training-images.d.ts +214 -0
  434. package/resources/models/training-images.d.ts.map +1 -0
  435. package/resources/models/training-images.js +46 -0
  436. package/resources/models/training-images.js.map +1 -0
  437. package/resources/models/training-images.mjs +42 -0
  438. package/resources/models/training-images.mjs.map +1 -0
  439. package/resources/models.d.mts +2 -0
  440. package/resources/models.d.mts.map +1 -0
  441. package/resources/models.d.ts +2 -0
  442. package/resources/models.d.ts.map +1 -0
  443. package/resources/models.js +6 -0
  444. package/resources/models.js.map +1 -0
  445. package/resources/models.mjs +3 -0
  446. package/resources/models.mjs.map +1 -0
  447. package/resources/oscu.d.mts +25 -0
  448. package/resources/oscu.d.mts.map +1 -0
  449. package/resources/oscu.d.ts +25 -0
  450. package/resources/oscu.d.ts.map +1 -0
  451. package/resources/oscu.js +16 -0
  452. package/resources/oscu.js.map +1 -0
  453. package/resources/oscu.mjs +12 -0
  454. package/resources/oscu.mjs.map +1 -0
  455. package/resources/search.d.mts +595 -0
  456. package/resources/search.d.mts.map +1 -0
  457. package/resources/search.d.ts +595 -0
  458. package/resources/search.d.ts.map +1 -0
  459. package/resources/search.js +29 -0
  460. package/resources/search.js.map +1 -0
  461. package/resources/search.mjs +25 -0
  462. package/resources/search.mjs.map +1 -0
  463. package/resources/tags.d.mts +55 -0
  464. package/resources/tags.d.mts.map +1 -0
  465. package/resources/tags.d.ts +55 -0
  466. package/resources/tags.d.ts.map +1 -0
  467. package/resources/tags.js +15 -0
  468. package/resources/tags.js.map +1 -0
  469. package/resources/tags.mjs +11 -0
  470. package/resources/tags.mjs.map +1 -0
  471. package/resources/uploads.d.mts +250 -0
  472. package/resources/uploads.d.mts.map +1 -0
  473. package/resources/uploads.d.ts +250 -0
  474. package/resources/uploads.d.ts.map +1 -0
  475. package/resources/uploads.js +29 -0
  476. package/resources/uploads.js.map +1 -0
  477. package/resources/uploads.mjs +25 -0
  478. package/resources/uploads.mjs.map +1 -0
  479. package/resources/usages.d.mts +760 -0
  480. package/resources/usages.d.mts.map +1 -0
  481. package/resources/usages.d.ts +760 -0
  482. package/resources/usages.d.ts.map +1 -0
  483. package/resources/usages.js +17 -0
  484. package/resources/usages.js.map +1 -0
  485. package/resources/usages.mjs +13 -0
  486. package/resources/usages.mjs.map +1 -0
  487. package/resources/workflows.d.mts +4539 -0
  488. package/resources/workflows.d.mts.map +1 -0
  489. package/resources/workflows.d.ts +4539 -0
  490. package/resources/workflows.d.ts.map +1 -0
  491. package/resources/workflows.js +64 -0
  492. package/resources/workflows.js.map +1 -0
  493. package/resources/workflows.mjs +60 -0
  494. package/resources/workflows.mjs.map +1 -0
  495. package/resources.d.mts +2 -0
  496. package/resources.d.mts.map +1 -0
  497. package/resources.d.ts +2 -0
  498. package/resources.d.ts.map +1 -0
  499. package/resources.js +5 -0
  500. package/resources.js.map +1 -0
  501. package/resources.mjs +2 -0
  502. package/resources.mjs.map +1 -0
  503. package/src/api-promise.ts +2 -0
  504. package/src/client.ts +999 -0
  505. package/src/core/README.md +3 -0
  506. package/src/core/api-promise.ts +92 -0
  507. package/src/core/error.ts +130 -0
  508. package/src/core/resource.ts +11 -0
  509. package/src/core/uploads.ts +2 -0
  510. package/src/error.ts +2 -0
  511. package/src/index.ts +22 -0
  512. package/src/internal/README.md +3 -0
  513. package/src/internal/builtin-types.ts +93 -0
  514. package/src/internal/detect-platform.ts +196 -0
  515. package/src/internal/errors.ts +33 -0
  516. package/src/internal/headers.ts +97 -0
  517. package/src/internal/parse.ts +56 -0
  518. package/src/internal/qs/LICENSE.md +13 -0
  519. package/src/internal/qs/README.md +3 -0
  520. package/src/internal/qs/formats.ts +10 -0
  521. package/src/internal/qs/index.ts +13 -0
  522. package/src/internal/qs/stringify.ts +385 -0
  523. package/src/internal/qs/types.ts +71 -0
  524. package/src/internal/qs/utils.ts +265 -0
  525. package/src/internal/request-options.ts +91 -0
  526. package/src/internal/shim-types.ts +26 -0
  527. package/src/internal/shims.ts +107 -0
  528. package/src/internal/to-file.ts +154 -0
  529. package/src/internal/types.ts +95 -0
  530. package/src/internal/uploads.ts +187 -0
  531. package/src/internal/utils/base64.ts +40 -0
  532. package/src/internal/utils/bytes.ts +32 -0
  533. package/src/internal/utils/env.ts +18 -0
  534. package/src/internal/utils/log.ts +126 -0
  535. package/src/internal/utils/path.ts +88 -0
  536. package/src/internal/utils/query.ts +7 -0
  537. package/src/internal/utils/sleep.ts +3 -0
  538. package/src/internal/utils/uuid.ts +17 -0
  539. package/src/internal/utils/values.ts +105 -0
  540. package/src/internal/utils.ts +9 -0
  541. package/src/lib/.keep +4 -0
  542. package/src/resource.ts +2 -0
  543. package/src/resources/assets/assets.ts +9939 -0
  544. package/src/resources/assets/download.ts +138 -0
  545. package/src/resources/assets/index.ts +41 -0
  546. package/src/resources/assets/public.ts +2329 -0
  547. package/src/resources/assets.ts +3 -0
  548. package/src/resources/collections/assets.ts +163 -0
  549. package/src/resources/collections/collections.ts +357 -0
  550. package/src/resources/collections/index.ts +27 -0
  551. package/src/resources/collections/models.ts +163 -0
  552. package/src/resources/collections.ts +3 -0
  553. package/src/resources/generate.ts +5478 -0
  554. package/src/resources/index.ts +122 -0
  555. package/src/resources/jobs.ts +1712 -0
  556. package/src/resources/models/description.ts +800 -0
  557. package/src/resources/models/examples.ts +4125 -0
  558. package/src/resources/models/index.ts +58 -0
  559. package/src/resources/models/models.ts +8619 -0
  560. package/src/resources/models/train.ts +3034 -0
  561. package/src/resources/models/training-images.ts +304 -0
  562. package/src/resources/models.ts +3 -0
  563. package/src/resources/oscu.ts +35 -0
  564. package/src/resources/search.ts +731 -0
  565. package/src/resources/tags.ts +69 -0
  566. package/src/resources/uploads.ts +369 -0
  567. package/src/resources/usages.ts +1242 -0
  568. package/src/resources/workflows.ts +6019 -0
  569. package/src/resources.ts +1 -0
  570. package/src/tsconfig.json +11 -0
  571. package/src/uploads.ts +2 -0
  572. package/src/version.ts +1 -0
  573. package/uploads.d.mts +2 -0
  574. package/uploads.d.mts.map +1 -0
  575. package/uploads.d.ts +2 -0
  576. package/uploads.d.ts.map +1 -0
  577. package/uploads.js +6 -0
  578. package/uploads.js.map +1 -0
  579. package/uploads.mjs +2 -0
  580. package/uploads.mjs.map +1 -0
  581. package/version.d.mts +2 -0
  582. package/version.d.mts.map +1 -0
  583. package/version.d.ts +2 -0
  584. package/version.d.ts.map +1 -0
  585. package/version.js +5 -0
  586. package/version.js.map +1 -0
  587. package/version.mjs +2 -0
  588. package/version.mjs.map +1 -0
@@ -0,0 +1,1535 @@
1
+ import { APIResource } from "../../core/resource.js";
2
+ import { APIPromise } from "../../core/api-promise.js";
3
+ import { RequestOptions } from "../../internal/request-options.js";
4
+ export declare class Public extends APIResource {
5
+ /**
6
+ * Get the details of an asset. @deprecated Use GET /assets/{assetId} with
7
+ * Authorization: public-auth-token header instead.
8
+ *
9
+ * @deprecated
10
+ */
11
+ retrieve(assetID: string, options?: RequestOptions): APIPromise<PublicRetrieveResponse>;
12
+ /**
13
+ * List all public assets. @deprecated Use GET /assets with Authorization:
14
+ * public-auth-token header instead.
15
+ *
16
+ * @deprecated
17
+ */
18
+ list(query?: PublicListParams | null | undefined, options?: RequestOptions): APIPromise<PublicListResponse>;
19
+ }
20
+ export interface PublicRetrieveResponse {
21
+ asset: PublicRetrieveResponse.Asset;
22
+ }
23
+ export declare namespace PublicRetrieveResponse {
24
+ interface Asset {
25
+ /**
26
+ * The asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
27
+ */
28
+ id: string;
29
+ /**
30
+ * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
31
+ */
32
+ authorId: string;
33
+ /**
34
+ * A list of CollectionId this asset belongs to
35
+ */
36
+ collectionIds: Array<string>;
37
+ /**
38
+ * The asset creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
39
+ */
40
+ createdAt: string;
41
+ /**
42
+ * List of edit capabilities
43
+ */
44
+ editCapabilities: Array<'DETECTION' | 'GENERATIVE_FILL' | 'PIXELATE' | 'PROMPT_EDITING' | 'REFINE' | 'REFRAME' | 'REMOVE_BACKGROUND' | 'SEGMENTATION' | 'UPSCALE' | 'UPSCALE_360' | 'VECTORIZATION'>;
45
+ /**
46
+ * The kind of asset
47
+ */
48
+ kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
49
+ /**
50
+ * Metadata of the asset with some additional information
51
+ */
52
+ metadata: Asset.Metadata;
53
+ /**
54
+ * The mime type of the asset (example: "image/png")
55
+ */
56
+ mimeType: string;
57
+ /**
58
+ * The owner (project) ID (example: "proj_23tlk332lkht3kl2" or
59
+ * "team_dlkhgs23tlk3hlkth32lkht3kl2" for old teams)
60
+ */
61
+ ownerId: string;
62
+ /**
63
+ * The privacy of the asset
64
+ */
65
+ privacy: 'private' | 'public' | 'unlisted';
66
+ /**
67
+ * The properties of the asset, content may depend on the kind of asset returned
68
+ */
69
+ properties: Asset.Properties;
70
+ /**
71
+ * source of the asset
72
+ */
73
+ source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video2img' | 'video2video';
74
+ /**
75
+ * The actual status
76
+ */
77
+ status: 'error' | 'pending' | 'success';
78
+ /**
79
+ * The associated tags (example: ["sci-fi", "landscape"])
80
+ */
81
+ tags: Array<string>;
82
+ /**
83
+ * The asset last update date as an ISO string (example:
84
+ * "2023-02-03T11:19:41.579Z")
85
+ */
86
+ updatedAt: string;
87
+ /**
88
+ * Signed URL to get the asset content
89
+ */
90
+ url: string;
91
+ /**
92
+ * Automatic captioning of the asset
93
+ */
94
+ automaticCaptioning?: string;
95
+ /**
96
+ * The description, it will contain in priority:
97
+ *
98
+ * - the manual description
99
+ * - the advanced captioning when the asset is used in training flow
100
+ * - the automatic captioning
101
+ */
102
+ description?: string;
103
+ /**
104
+ * The embedding of the asset when requested.
105
+ *
106
+ * Only available when an asset can be embedded (ie: not Detection maps)
107
+ */
108
+ embedding?: Array<number>;
109
+ /**
110
+ * The video asset's first frame.
111
+ *
112
+ * Contains the assetId and the url of the first frame.
113
+ */
114
+ firstFrame?: Asset.FirstFrame;
115
+ /**
116
+ * Whether the asset is hidden.
117
+ */
118
+ isHidden?: boolean;
119
+ /**
120
+ * The video asset's last frame.
121
+ *
122
+ * Contains the assetId and the url of the last frame.
123
+ */
124
+ lastFrame?: Asset.LastFrame;
125
+ /**
126
+ * The NSFW labels
127
+ */
128
+ nsfw?: Array<string>;
129
+ /**
130
+ * The original file url.
131
+ *
132
+ * Contains the url of the original file. without any conversion. Only available
133
+ * for some specific video, audio and threeD assets. Is only specified if the given
134
+ * asset data has been replaced with a new file during the creation of the asset.
135
+ */
136
+ originalFileUrl?: string;
137
+ /**
138
+ * The output index of the asset within a job This index is an positive integer
139
+ * that starts at 0 It is used to differentiate between multiple outputs of the
140
+ * same job If the job has only one output, this index is 0
141
+ */
142
+ outputIndex?: number;
143
+ /**
144
+ * The asset's preview.
145
+ *
146
+ * Contains the assetId and the url of the preview.
147
+ */
148
+ preview?: Asset.Preview;
149
+ /**
150
+ * The asset's thumbnail.
151
+ *
152
+ * Contains the assetId and the url of the thumbnail.
153
+ */
154
+ thumbnail?: Asset.Thumbnail;
155
+ }
156
+ namespace Asset {
157
+ /**
158
+ * Metadata of the asset with some additional information
159
+ */
160
+ interface Metadata {
161
+ kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
162
+ /**
163
+ * The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
164
+ * from a text to image model
165
+ */
166
+ type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video2img' | 'video2video';
167
+ /**
168
+ * How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
169
+ */
170
+ angular?: number;
171
+ /**
172
+ * The optional aspect ratio given for the generation, only applicable for some
173
+ * models
174
+ */
175
+ aspectRatio?: string;
176
+ /**
177
+ * Int to set between 0 and 255 for the opacity of the background in the result
178
+ * images.
179
+ */
180
+ backgroundOpacity?: number;
181
+ /**
182
+ * The baseModelId that maybe changed at inference time
183
+ */
184
+ baseModelId?: string;
185
+ /**
186
+ * A bounding box around the object of interest, in the format [x1, y1, x2, y2].
187
+ */
188
+ bbox?: Array<unknown>;
189
+ /**
190
+ * Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
191
+ */
192
+ betterQuality?: boolean;
193
+ /**
194
+ * The control image already processed by canny detector. Must reference an
195
+ * existing AssetId.
196
+ */
197
+ cannyStructureImage?: string;
198
+ /**
199
+ * Activate clustering.
200
+ */
201
+ clustering?: boolean;
202
+ /**
203
+ * Ensure upscaled tile have the same color histogram as original tile.
204
+ */
205
+ colorCorrection?: boolean;
206
+ colorMode?: string;
207
+ colorPrecision?: number;
208
+ /**
209
+ * Flux Kontext LoRA to style the image. For Flux Kontext Prompt Editing.
210
+ */
211
+ concepts?: Array<Metadata.Concept>;
212
+ contours?: Array<Array<Array<Array<number>>>>;
213
+ /**
214
+ * End step for control.
215
+ */
216
+ controlEnd?: number;
217
+ /**
218
+ * The date when the asset was copied to a project
219
+ */
220
+ copiedAt?: string;
221
+ cornerThreshold?: number;
222
+ /**
223
+ * Allow the generation of "hallucinations" during the upscale process, which adds
224
+ * additional details and deviates from the original image. Default: optimized for
225
+ * your preset and style.
226
+ */
227
+ creativity?: number;
228
+ /**
229
+ * Amount of decay in creativity over the upscale process. The lowest the value,
230
+ * the less the creativity will be preserved over the upscale process.
231
+ */
232
+ creativityDecay?: number;
233
+ /**
234
+ * If true, use the default parameters
235
+ */
236
+ defaultParameters?: boolean;
237
+ /**
238
+ * The depth fidelity if a depth image provided
239
+ */
240
+ depthFidelity?: number;
241
+ /**
242
+ * The control image processed by depth estimator. Must reference an existing
243
+ * AssetId.
244
+ */
245
+ depthImage?: string;
246
+ /**
247
+ * Amount of details to remove or add
248
+ */
249
+ detailsLevel?: number;
250
+ /**
251
+ * The number of pixels to dilate the result masks.
252
+ */
253
+ dilate?: number;
254
+ /**
255
+ * Contrast factor for Grayscale detector
256
+ */
257
+ factor?: number;
258
+ filterSpeckle?: number;
259
+ /**
260
+ * Determine the scale at which the upscale process works.
261
+ *
262
+ * - With a small value, the upscale works at the largest scale, resulting in fewer
263
+ * added details and more coherent images. Ideal for portraits, for example.
264
+ * - With a large value, the upscale works at the smallest scale, resulting in more
265
+ * added details and more hallucinations. Ideal for landscapes, for example.
266
+ *
267
+ * (info): A small value is slower and more expensive to run.
268
+ */
269
+ fractality?: number;
270
+ /**
271
+ * Apply extra control to the Skybox 360 geometry. The higher the value, the more
272
+ * the 360 geometry will influence the generated skybox image.
273
+ *
274
+ * Use with caution. Default is adapted to the other parameters.
275
+ */
276
+ geometryEnforcement?: number;
277
+ /**
278
+ * The guidance used to generate this asset
279
+ */
280
+ guidance?: number;
281
+ halfMode?: boolean;
282
+ hdr?: number;
283
+ height?: number;
284
+ /**
285
+ * High threshold for Canny detector
286
+ */
287
+ highThreshold?: number;
288
+ /**
289
+ * (deprecated) Horizontal expansion ratio.
290
+ */
291
+ horizontalExpansionRatio?: number;
292
+ /**
293
+ * The input image to process. Must reference an existing AssetId or be a data URL.
294
+ */
295
+ image?: string;
296
+ /**
297
+ * Strengthen the similarity to the original image during the upscale. Default:
298
+ * optimized for your preset and style.
299
+ */
300
+ imageFidelity?: number;
301
+ /**
302
+ * Preserve the seamless properties of skybox or texture images. Input has to be of
303
+ * same type (seamless).
304
+ */
305
+ imageType?: 'seamfull' | 'skybox' | 'texture';
306
+ /**
307
+ * The id of the Inference describing how this image was generated
308
+ */
309
+ inferenceId?: string;
310
+ /**
311
+ * When set to `high`, allows to better preserve details from the input images in
312
+ * the output. This is especially useful when using images that contain elements
313
+ * like faces or logos that require accurate preservation in the generated image.
314
+ *
315
+ * You can provide multiple input images that will all be preserved with high
316
+ * fidelity, but keep in mind that the first image will be preserved with richer
317
+ * textures and finer details, so if you include elements such as faces, consider
318
+ * placing them in the first image.
319
+ *
320
+ * Only available for the `gpt-image-1` model.
321
+ */
322
+ inputFidelity?: 'high' | 'low';
323
+ /**
324
+ * Location of the input image in the output.
325
+ */
326
+ inputLocation?: 'bottom' | 'left' | 'middle' | 'right' | 'top';
327
+ /**
328
+ * To invert the relief
329
+ */
330
+ invert?: boolean;
331
+ /**
332
+ * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
333
+ */
334
+ keypointThreshold?: number;
335
+ layerDifference?: number;
336
+ lengthThreshold?: number;
337
+ /**
338
+ * The ISO timestamp when the lock on the canvas will expire
339
+ */
340
+ lockExpiresAt?: string;
341
+ /**
342
+ * Low threshold for Canny detector
343
+ */
344
+ lowThreshold?: number;
345
+ /**
346
+ * The mask used for the asset generation or editing
347
+ */
348
+ mask?: string;
349
+ maxIterations?: number;
350
+ /**
351
+ * Maximum threshold for Grayscale conversion
352
+ */
353
+ maxThreshold?: number;
354
+ /**
355
+ * Minimum threshold for Grayscale conversion
356
+ */
357
+ minThreshold?: number;
358
+ /**
359
+ * Modality to detect
360
+ */
361
+ modality?: 'canny' | 'depth' | 'grayscale' | 'lineart_anime' | 'mlsd' | 'normal' | 'pose' | 'scribble' | 'segmentation' | 'sketch';
362
+ mode?: string;
363
+ /**
364
+ * The modelId used to generate this asset
365
+ */
366
+ modelId?: string;
367
+ /**
368
+ * The type of the generator used
369
+ */
370
+ modelType?: 'custom' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux1.1-pro' | 'gpt-image-1' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora';
371
+ name?: string;
372
+ nbMasks?: number;
373
+ /**
374
+ * The negative prompt used to generate this asset
375
+ */
376
+ negativePrompt?: string;
377
+ /**
378
+ * Controls the influence of the negative prompt. Default 0 means the negative
379
+ * prompt has no effect. Higher values increase negative prompt influence. Must
380
+ * be > 0 if negativePrompt is provided.
381
+ */
382
+ negativePromptStrength?: number;
383
+ /**
384
+ * The number of denoising steps for each image generation.
385
+ */
386
+ numInferenceSteps?: number;
387
+ /**
388
+ * The number of outputs to generate.
389
+ */
390
+ numOutputs?: number;
391
+ originalAssetId?: string;
392
+ outputIndex?: number;
393
+ /**
394
+ * Overlap percentage for the output image.
395
+ */
396
+ overlapPercentage?: number;
397
+ /**
398
+ * Override the embeddings of the model. Only your prompt and negativePrompt will
399
+ * be used. Use with caution.
400
+ */
401
+ overrideEmbeddings?: boolean;
402
+ parentId?: string;
403
+ parentJobId?: string;
404
+ pathPrecision?: number;
405
+ /**
406
+ * List of points (label, x, y) in the image where label = 0 for background and 1
407
+ * for object.
408
+ */
409
+ points?: Array<Array<unknown>>;
410
+ /**
411
+ * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
412
+ */
413
+ polished?: number;
414
+ preset?: string;
415
+ progressPercent?: number;
416
+ /**
417
+ * The prompt that guided the asset generation or editing
418
+ */
419
+ prompt?: string;
420
+ /**
421
+ * Increase the fidelity to the prompt during upscale. Default: optimized for your
422
+ * preset and style.
423
+ */
424
+ promptFidelity?: number;
425
+ /**
426
+ * How raised is the surface? 0 is flat like water, 1 is like a very rough rock
427
+ */
428
+ raised?: number;
429
+ /**
430
+ * The reference images used for the asset generation or editing
431
+ */
432
+ referenceImages?: Array<string>;
433
+ /**
434
+ * Additional refinement steps before scaling.
435
+ *
436
+ * If scalingFactor == 1, the refinement process will be applied (1 +
437
+ * refinementSteps) times. If scalingFactor > 1, the refinement process will be
438
+ * applied refinementSteps times.
439
+ */
440
+ refinementSteps?: number;
441
+ /**
442
+ * Remove background for Grayscale detector
443
+ */
444
+ removeBackground?: boolean;
445
+ /**
446
+ * Size proportion of the input image in the output.
447
+ */
448
+ resizeOption?: number;
449
+ /**
450
+ * Boolean to output the contours.
451
+ */
452
+ resultContours?: boolean;
453
+ /**
454
+ * Boolean to able output the cut out object.
455
+ */
456
+ resultImage?: boolean;
457
+ /**
458
+ * Boolean to able return the masks (binary image) in the response.
459
+ */
460
+ resultMask?: boolean;
461
+ rootParentId?: string;
462
+ /**
463
+ * Save a flipbook of the texture. Deactivated when the input texture is larger
464
+ * than 2048x2048px
465
+ */
466
+ saveFlipbook?: boolean;
467
+ /**
468
+ * Scaling factor (when `targetWidth` not specified)
469
+ */
470
+ scalingFactor?: number;
471
+ /**
472
+ * The scheduler used to generate this asset
473
+ */
474
+ scheduler?: string;
475
+ /**
476
+ * The seed used to generate this asset
477
+ */
478
+ seed?: string;
479
+ /**
480
+ * Sharpen tiles.
481
+ */
482
+ sharpen?: boolean;
483
+ /**
484
+ * How shiny is the surface? 0 is like a matte surface, 1 is like a diamond
485
+ */
486
+ shiny?: number;
487
+ size?: number;
488
+ /**
489
+ * Activate sketch detection instead of canny.
490
+ */
491
+ sketch?: boolean;
492
+ sourceProjectId?: string;
493
+ spliceThreshold?: number;
494
+ /**
495
+ * The strength
496
+ *
497
+ * Only available for the `flux-kontext` LoRA model.
498
+ */
499
+ strength?: number;
500
+ /**
501
+ * Strength for the input image structure preservation
502
+ */
503
+ structureFidelity?: number;
504
+ /**
505
+ * The control image for structure. A canny detector will be applied to this image.
506
+ * Must reference an existing AssetId.
507
+ */
508
+ structureImage?: string;
509
+ style?: '3d-cartoon' | '3d-rendered' | 'anime' | 'cartoon' | 'cinematic' | 'claymation' | 'cloud-skydome' | 'comic' | 'cyberpunk' | 'enchanted' | 'fantasy' | 'ink' | 'manga' | 'manga-color' | 'minimalist' | 'neon-tron' | 'oil-painting' | 'pastel' | 'photo' | 'photography' | 'psychedelic' | 'retro-fantasy' | 'scifi-concept-art' | 'space' | 'standard' | 'whimsical';
510
+ /**
511
+ * The higher the value the more it will look like the style image(s)
512
+ */
513
+ styleFidelity?: number;
514
+ /**
515
+ * List of style images. Most of the time, only one image is enough. It must be
516
+ * existing AssetIds.
517
+ */
518
+ styleImages?: Array<string>;
519
+ /**
520
+ * Condition the influence of the style image(s). The higher the value, the more
521
+ * the style images will influence the upscaled image.
522
+ */
523
+ styleImagesFidelity?: number;
524
+ /**
525
+ * The target height of the output image.
526
+ */
527
+ targetHeight?: number;
528
+ /**
529
+ * Target width for the upscaled image, take priority over scaling factor
530
+ */
531
+ targetWidth?: number;
532
+ /**
533
+ * A textual description / keywords describing the object of interest.
534
+ */
535
+ text?: string;
536
+ /**
537
+ * The asset to convert in texture maps. Must reference an existing AssetId.
538
+ */
539
+ texture?: string;
540
+ /**
541
+ * The thumbnail of the canvas
542
+ */
543
+ thumbnail?: Metadata.Thumbnail;
544
+ /**
545
+ * If set to true, during the upscaling process, the model will match tiles of the
546
+ * source image with tiles of the style image(s). This will result in a more
547
+ * coherent restyle. Works best with style images that have a similar composition.
548
+ */
549
+ tileStyle?: boolean;
550
+ trainingImage?: boolean;
551
+ /**
552
+ * (deprecated) Vertical expansion ratio.
553
+ */
554
+ verticalExpansionRatio?: number;
555
+ /**
556
+ * The width of the rendered image.
557
+ */
558
+ width?: number;
559
+ }
560
+ namespace Metadata {
561
+ interface Concept {
562
+ /**
563
+ * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
564
+ */
565
+ modelId: string;
566
+ /**
567
+ * The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale
568
+ * is between 0 and 2.
569
+ */
570
+ scale: number;
571
+ /**
572
+ * The epoch of the model (example: "000001") Only available for Flux Lora Trained
573
+ * models
574
+ */
575
+ modelEpoch?: string;
576
+ }
577
+ /**
578
+ * The thumbnail of the canvas
579
+ */
580
+ interface Thumbnail {
581
+ /**
582
+ * The AssetId of the image used as a thumbnail for the canvas (example:
583
+ * "asset_GTrL3mq4SXWyMxkOHRxlpw")
584
+ */
585
+ assetId: string;
586
+ /**
587
+ * The url of the image used as a thumbnail for the canvas
588
+ */
589
+ url: string;
590
+ }
591
+ }
592
+ /**
593
+ * The properties of the asset, content may depend on the kind of asset returned
594
+ */
595
+ interface Properties {
596
+ size: number;
597
+ /**
598
+ * Number of animation frames if animations exist
599
+ */
600
+ animationFrameCount?: number;
601
+ /**
602
+ * Bitrate of the media in bits per second
603
+ */
604
+ bitrate?: number;
605
+ /**
606
+ * Number of bones if skeleton exists
607
+ */
608
+ boneCount?: number;
609
+ /**
610
+ * Number of channels of the audio
611
+ */
612
+ channels?: number;
613
+ /**
614
+ * Classification of the audio
615
+ */
616
+ classification?: 'effect' | 'interview' | 'music' | 'other' | 'sound' | 'speech' | 'text' | 'unknown';
617
+ /**
618
+ * Codec name of the media
619
+ */
620
+ codecName?: string;
621
+ /**
622
+ * Description of the audio
623
+ */
624
+ description?: string;
625
+ /**
626
+ * Bounding box dimensions [width, height, depth]
627
+ */
628
+ dimensions?: Array<unknown>;
629
+ /**
630
+ * Duration of the media in seconds
631
+ */
632
+ duration?: number;
633
+ /**
634
+ * Number of faces/triangles in the mesh
635
+ */
636
+ faceCount?: number;
637
+ /**
638
+ * Format of the mesh file (e.g. 'glb', etc.)
639
+ */
640
+ format?: string;
641
+ /**
642
+ * Frame rate of the video in frames per second
643
+ */
644
+ frameRate?: number;
645
+ /**
646
+ * Whether the mesh has animations
647
+ */
648
+ hasAnimations?: boolean;
649
+ /**
650
+ * Whether the mesh has normal vectors
651
+ */
652
+ hasNormals?: boolean;
653
+ /**
654
+ * Whether the mesh has bones/skeleton
655
+ */
656
+ hasSkeleton?: boolean;
657
+ /**
658
+ * Whether the mesh has UV coordinates
659
+ */
660
+ hasUVs?: boolean;
661
+ height?: number;
662
+ /**
663
+ * Number of frames in the video
664
+ */
665
+ nbFrames?: number;
666
+ /**
667
+ * Sample rate of the media in Hz
668
+ */
669
+ sampleRate?: number;
670
+ /**
671
+ * Transcription of the audio
672
+ */
673
+ transcription?: Properties.Transcription;
674
+ /**
675
+ * Number of vertices in the mesh
676
+ */
677
+ vertexCount?: number;
678
+ width?: number;
679
+ }
680
+ namespace Properties {
681
+ /**
682
+ * Transcription of the audio
683
+ */
684
+ interface Transcription {
685
+ text: string;
686
+ }
687
+ }
688
+ /**
689
+ * The video asset's first frame.
690
+ *
691
+ * Contains the assetId and the url of the first frame.
692
+ */
693
+ interface FirstFrame {
694
+ assetId: string;
695
+ url: string;
696
+ }
697
+ /**
698
+ * The video asset's last frame.
699
+ *
700
+ * Contains the assetId and the url of the last frame.
701
+ */
702
+ interface LastFrame {
703
+ assetId: string;
704
+ url: string;
705
+ }
706
+ /**
707
+ * The asset's preview.
708
+ *
709
+ * Contains the assetId and the url of the preview.
710
+ */
711
+ interface Preview {
712
+ assetId: string;
713
+ url: string;
714
+ }
715
+ /**
716
+ * The asset's thumbnail.
717
+ *
718
+ * Contains the assetId and the url of the thumbnail.
719
+ */
720
+ interface Thumbnail {
721
+ assetId: string;
722
+ url: string;
723
+ }
724
+ }
725
+ }
726
+ export interface PublicListResponse {
727
+ assets: Array<PublicListResponse.Asset>;
728
+ /**
729
+ * A token to query the next page of assets
730
+ */
731
+ nextPaginationToken?: string;
732
+ }
733
+ export declare namespace PublicListResponse {
734
+ interface Asset {
735
+ /**
736
+ * The asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
737
+ */
738
+ id: string;
739
+ /**
740
+ * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
741
+ */
742
+ authorId: string;
743
+ /**
744
+ * A list of CollectionId this asset belongs to
745
+ */
746
+ collectionIds: Array<string>;
747
+ /**
748
+ * The asset creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
749
+ */
750
+ createdAt: string;
751
+ /**
752
+ * List of edit capabilities
753
+ */
754
+ editCapabilities: Array<'DETECTION' | 'GENERATIVE_FILL' | 'PIXELATE' | 'PROMPT_EDITING' | 'REFINE' | 'REFRAME' | 'REMOVE_BACKGROUND' | 'SEGMENTATION' | 'UPSCALE' | 'UPSCALE_360' | 'VECTORIZATION'>;
755
+ /**
756
+ * The kind of asset
757
+ */
758
+ kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
759
+ /**
760
+ * Metadata of the asset with some additional information
761
+ */
762
+ metadata: Asset.Metadata;
763
+ /**
764
+ * The mime type of the asset (example: "image/png")
765
+ */
766
+ mimeType: string;
767
+ /**
768
+ * The owner (project) ID (example: "proj_23tlk332lkht3kl2" or
769
+ * "team_dlkhgs23tlk3hlkth32lkht3kl2" for old teams)
770
+ */
771
+ ownerId: string;
772
+ /**
773
+ * The privacy of the asset
774
+ */
775
+ privacy: 'private' | 'public' | 'unlisted';
776
+ /**
777
+ * The properties of the asset, content may depend on the kind of asset returned
778
+ */
779
+ properties: Asset.Properties;
780
+ /**
781
+ * source of the asset
782
+ */
783
+ source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video2img' | 'video2video';
784
+ /**
785
+ * The actual status
786
+ */
787
+ status: 'error' | 'pending' | 'success';
788
+ /**
789
+ * The associated tags (example: ["sci-fi", "landscape"])
790
+ */
791
+ tags: Array<string>;
792
+ /**
793
+ * The asset last update date as an ISO string (example:
794
+ * "2023-02-03T11:19:41.579Z")
795
+ */
796
+ updatedAt: string;
797
+ /**
798
+ * Signed URL to get the asset content
799
+ */
800
+ url: string;
801
+ /**
802
+ * Automatic captioning of the asset
803
+ */
804
+ automaticCaptioning?: string;
805
+ /**
806
+ * The description, it will contain in priority:
807
+ *
808
+ * - the manual description
809
+ * - the advanced captioning when the asset is used in training flow
810
+ * - the automatic captioning
811
+ */
812
+ description?: string;
813
+ /**
814
+ * The embedding of the asset when requested.
815
+ *
816
+ * Only available when an asset can be embedded (ie: not Detection maps)
817
+ */
818
+ embedding?: Array<number>;
819
+ /**
820
+ * The video asset's first frame.
821
+ *
822
+ * Contains the assetId and the url of the first frame.
823
+ */
824
+ firstFrame?: Asset.FirstFrame;
825
+ /**
826
+ * Whether the asset is hidden.
827
+ */
828
+ isHidden?: boolean;
829
+ /**
830
+ * The video asset's last frame.
831
+ *
832
+ * Contains the assetId and the url of the last frame.
833
+ */
834
+ lastFrame?: Asset.LastFrame;
835
+ /**
836
+ * The NSFW labels
837
+ */
838
+ nsfw?: Array<string>;
839
+ /**
840
+ * The original file url.
841
+ *
842
+ * Contains the url of the original file. without any conversion. Only available
843
+ * for some specific video, audio and threeD assets. Is only specified if the given
844
+ * asset data has been replaced with a new file during the creation of the asset.
845
+ */
846
+ originalFileUrl?: string;
847
+ /**
848
+ * The output index of the asset within a job This index is an positive integer
849
+ * that starts at 0 It is used to differentiate between multiple outputs of the
850
+ * same job If the job has only one output, this index is 0
851
+ */
852
+ outputIndex?: number;
853
+ /**
854
+ * The asset's preview.
855
+ *
856
+ * Contains the assetId and the url of the preview.
857
+ */
858
+ preview?: Asset.Preview;
859
+ /**
860
+ * The asset's thumbnail.
861
+ *
862
+ * Contains the assetId and the url of the thumbnail.
863
+ */
864
+ thumbnail?: Asset.Thumbnail;
865
+ }
866
+ namespace Asset {
867
+ /**
868
+ * Metadata of the asset with some additional information
869
+ */
870
+ interface Metadata {
871
+ kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
872
+ /**
873
+ * The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
874
+ * from a text to image model
875
+ */
876
+ type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video2img' | 'video2video';
877
+ /**
878
+ * How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
879
+ */
880
+ angular?: number;
881
+ /**
882
+ * The optional aspect ratio given for the generation, only applicable for some
883
+ * models
884
+ */
885
+ aspectRatio?: string;
886
+ /**
887
+ * Int to set between 0 and 255 for the opacity of the background in the result
888
+ * images.
889
+ */
890
+ backgroundOpacity?: number;
891
+ /**
892
+ * The baseModelId that maybe changed at inference time
893
+ */
894
+ baseModelId?: string;
895
+ /**
896
+ * A bounding box around the object of interest, in the format [x1, y1, x2, y2].
897
+ */
898
+ bbox?: Array<unknown>;
899
+ /**
900
+ * Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
901
+ */
902
+ betterQuality?: boolean;
903
+ /**
904
+ * The control image already processed by canny detector. Must reference an
905
+ * existing AssetId.
906
+ */
907
+ cannyStructureImage?: string;
908
+ /**
909
+ * Activate clustering.
910
+ */
911
+ clustering?: boolean;
912
+ /**
913
+ * Ensure upscaled tile have the same color histogram as original tile.
914
+ */
915
+ colorCorrection?: boolean;
916
+ colorMode?: string;
917
+ colorPrecision?: number;
918
+ /**
919
+ * Flux Kontext LoRA to style the image. For Flux Kontext Prompt Editing.
920
+ */
921
+ concepts?: Array<Metadata.Concept>;
922
+ contours?: Array<Array<Array<Array<number>>>>;
923
+ /**
924
+ * End step for control.
925
+ */
926
+ controlEnd?: number;
927
+ /**
928
+ * The date when the asset was copied to a project
929
+ */
930
+ copiedAt?: string;
931
+ cornerThreshold?: number;
932
+ /**
933
+ * Allow the generation of "hallucinations" during the upscale process, which adds
934
+ * additional details and deviates from the original image. Default: optimized for
935
+ * your preset and style.
936
+ */
937
+ creativity?: number;
938
+ /**
939
+ * Amount of decay in creativity over the upscale process. The lowest the value,
940
+ * the less the creativity will be preserved over the upscale process.
941
+ */
942
+ creativityDecay?: number;
943
+ /**
944
+ * If true, use the default parameters
945
+ */
946
+ defaultParameters?: boolean;
947
+ /**
948
+ * The depth fidelity if a depth image provided
949
+ */
950
+ depthFidelity?: number;
951
+ /**
952
+ * The control image processed by depth estimator. Must reference an existing
953
+ * AssetId.
954
+ */
955
+ depthImage?: string;
956
+ /**
957
+ * Amount of details to remove or add
958
+ */
959
+ detailsLevel?: number;
960
+ /**
961
+ * The number of pixels to dilate the result masks.
962
+ */
963
+ dilate?: number;
964
+ /**
965
+ * Contrast factor for Grayscale detector
966
+ */
967
+ factor?: number;
968
+ filterSpeckle?: number;
969
+ /**
970
+ * Determine the scale at which the upscale process works.
971
+ *
972
+ * - With a small value, the upscale works at the largest scale, resulting in fewer
973
+ * added details and more coherent images. Ideal for portraits, for example.
974
+ * - With a large value, the upscale works at the smallest scale, resulting in more
975
+ * added details and more hallucinations. Ideal for landscapes, for example.
976
+ *
977
+ * (info): A small value is slower and more expensive to run.
978
+ */
979
+ fractality?: number;
980
+ /**
981
+ * Apply extra control to the Skybox 360 geometry. The higher the value, the more
982
+ * the 360 geometry will influence the generated skybox image.
983
+ *
984
+ * Use with caution. Default is adapted to the other parameters.
985
+ */
986
+ geometryEnforcement?: number;
987
+ /**
988
+ * The guidance used to generate this asset
989
+ */
990
+ guidance?: number;
991
+ halfMode?: boolean;
992
+ hdr?: number;
993
+ height?: number;
994
+ /**
995
+ * High threshold for Canny detector
996
+ */
997
+ highThreshold?: number;
998
+ /**
999
+ * (deprecated) Horizontal expansion ratio.
1000
+ */
1001
+ horizontalExpansionRatio?: number;
1002
+ /**
1003
+ * The input image to process. Must reference an existing AssetId or be a data URL.
1004
+ */
1005
+ image?: string;
1006
+ /**
1007
+ * Strengthen the similarity to the original image during the upscale. Default:
1008
+ * optimized for your preset and style.
1009
+ */
1010
+ imageFidelity?: number;
1011
+ /**
1012
+ * Preserve the seamless properties of skybox or texture images. Input has to be of
1013
+ * same type (seamless).
1014
+ */
1015
+ imageType?: 'seamfull' | 'skybox' | 'texture';
1016
+ /**
1017
+ * The id of the Inference describing how this image was generated
1018
+ */
1019
+ inferenceId?: string;
1020
+ /**
1021
+ * When set to `high`, allows to better preserve details from the input images in
1022
+ * the output. This is especially useful when using images that contain elements
1023
+ * like faces or logos that require accurate preservation in the generated image.
1024
+ *
1025
+ * You can provide multiple input images that will all be preserved with high
1026
+ * fidelity, but keep in mind that the first image will be preserved with richer
1027
+ * textures and finer details, so if you include elements such as faces, consider
1028
+ * placing them in the first image.
1029
+ *
1030
+ * Only available for the `gpt-image-1` model.
1031
+ */
1032
+ inputFidelity?: 'high' | 'low';
1033
+ /**
1034
+ * Location of the input image in the output.
1035
+ */
1036
+ inputLocation?: 'bottom' | 'left' | 'middle' | 'right' | 'top';
1037
+ /**
1038
+ * To invert the relief
1039
+ */
1040
+ invert?: boolean;
1041
+ /**
1042
+ * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
1043
+ */
1044
+ keypointThreshold?: number;
1045
+ layerDifference?: number;
1046
+ lengthThreshold?: number;
1047
+ /**
1048
+ * The ISO timestamp when the lock on the canvas will expire
1049
+ */
1050
+ lockExpiresAt?: string;
1051
+ /**
1052
+ * Low threshold for Canny detector
1053
+ */
1054
+ lowThreshold?: number;
1055
+ /**
1056
+ * The mask used for the asset generation or editing
1057
+ */
1058
+ mask?: string;
1059
+ maxIterations?: number;
1060
+ /**
1061
+ * Maximum threshold for Grayscale conversion
1062
+ */
1063
+ maxThreshold?: number;
1064
+ /**
1065
+ * Minimum threshold for Grayscale conversion
1066
+ */
1067
+ minThreshold?: number;
1068
+ /**
1069
+ * Modality to detect
1070
+ */
1071
+ modality?: 'canny' | 'depth' | 'grayscale' | 'lineart_anime' | 'mlsd' | 'normal' | 'pose' | 'scribble' | 'segmentation' | 'sketch';
1072
+ mode?: string;
1073
+ /**
1074
+ * The modelId used to generate this asset
1075
+ */
1076
+ modelId?: string;
1077
+ /**
1078
+ * The type of the generator used
1079
+ */
1080
+ modelType?: 'custom' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux1.1-pro' | 'gpt-image-1' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora';
1081
+ name?: string;
1082
+ nbMasks?: number;
1083
+ /**
1084
+ * The negative prompt used to generate this asset
1085
+ */
1086
+ negativePrompt?: string;
1087
+ /**
1088
+ * Controls the influence of the negative prompt. Default 0 means the negative
1089
+ * prompt has no effect. Higher values increase negative prompt influence. Must
1090
+ * be > 0 if negativePrompt is provided.
1091
+ */
1092
+ negativePromptStrength?: number;
1093
+ /**
1094
+ * The number of denoising steps for each image generation.
1095
+ */
1096
+ numInferenceSteps?: number;
1097
+ /**
1098
+ * The number of outputs to generate.
1099
+ */
1100
+ numOutputs?: number;
1101
+ originalAssetId?: string;
1102
+ outputIndex?: number;
1103
+ /**
1104
+ * Overlap percentage for the output image.
1105
+ */
1106
+ overlapPercentage?: number;
1107
+ /**
1108
+ * Override the embeddings of the model. Only your prompt and negativePrompt will
1109
+ * be used. Use with caution.
1110
+ */
1111
+ overrideEmbeddings?: boolean;
1112
+ parentId?: string;
1113
+ parentJobId?: string;
1114
+ pathPrecision?: number;
1115
+ /**
1116
+ * List of points (label, x, y) in the image where label = 0 for background and 1
1117
+ * for object.
1118
+ */
1119
+ points?: Array<Array<unknown>>;
1120
+ /**
1121
+ * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
1122
+ */
1123
+ polished?: number;
1124
+ preset?: string;
1125
+ progressPercent?: number;
1126
+ /**
1127
+ * The prompt that guided the asset generation or editing
1128
+ */
1129
+ prompt?: string;
1130
+ /**
1131
+ * Increase the fidelity to the prompt during upscale. Default: optimized for your
1132
+ * preset and style.
1133
+ */
1134
+ promptFidelity?: number;
1135
+ /**
1136
+ * How raised is the surface? 0 is flat like water, 1 is like a very rough rock
1137
+ */
1138
+ raised?: number;
1139
+ /**
1140
+ * The reference images used for the asset generation or editing
1141
+ */
1142
+ referenceImages?: Array<string>;
1143
+ /**
1144
+ * Additional refinement steps before scaling.
1145
+ *
1146
+ * If scalingFactor == 1, the refinement process will be applied (1 +
1147
+ * refinementSteps) times. If scalingFactor > 1, the refinement process will be
1148
+ * applied refinementSteps times.
1149
+ */
1150
+ refinementSteps?: number;
1151
+ /**
1152
+ * Remove background for Grayscale detector
1153
+ */
1154
+ removeBackground?: boolean;
1155
+ /**
1156
+ * Size proportion of the input image in the output.
1157
+ */
1158
+ resizeOption?: number;
1159
+ /**
1160
+ * Boolean to output the contours.
1161
+ */
1162
+ resultContours?: boolean;
1163
+ /**
1164
+ * Boolean to able output the cut out object.
1165
+ */
1166
+ resultImage?: boolean;
1167
+ /**
1168
+ * Boolean to able return the masks (binary image) in the response.
1169
+ */
1170
+ resultMask?: boolean;
1171
+ rootParentId?: string;
1172
+ /**
1173
+ * Save a flipbook of the texture. Deactivated when the input texture is larger
1174
+ * than 2048x2048px
1175
+ */
1176
+ saveFlipbook?: boolean;
1177
+ /**
1178
+ * Scaling factor (when `targetWidth` not specified)
1179
+ */
1180
+ scalingFactor?: number;
1181
+ /**
1182
+ * The scheduler used to generate this asset
1183
+ */
1184
+ scheduler?: string;
1185
+ /**
1186
+ * The seed used to generate this asset
1187
+ */
1188
+ seed?: string;
1189
+ /**
1190
+ * Sharpen tiles.
1191
+ */
1192
+ sharpen?: boolean;
1193
+ /**
1194
+ * How shiny is the surface? 0 is like a matte surface, 1 is like a diamond
1195
+ */
1196
+ shiny?: number;
1197
+ size?: number;
1198
+ /**
1199
+ * Activate sketch detection instead of canny.
1200
+ */
1201
+ sketch?: boolean;
1202
+ sourceProjectId?: string;
1203
+ spliceThreshold?: number;
1204
+ /**
1205
+ * The strength
1206
+ *
1207
+ * Only available for the `flux-kontext` LoRA model.
1208
+ */
1209
+ strength?: number;
1210
+ /**
1211
+ * Strength for the input image structure preservation
1212
+ */
1213
+ structureFidelity?: number;
1214
+ /**
1215
+ * The control image for structure. A canny detector will be applied to this image.
1216
+ * Must reference an existing AssetId.
1217
+ */
1218
+ structureImage?: string;
1219
+ style?: '3d-cartoon' | '3d-rendered' | 'anime' | 'cartoon' | 'cinematic' | 'claymation' | 'cloud-skydome' | 'comic' | 'cyberpunk' | 'enchanted' | 'fantasy' | 'ink' | 'manga' | 'manga-color' | 'minimalist' | 'neon-tron' | 'oil-painting' | 'pastel' | 'photo' | 'photography' | 'psychedelic' | 'retro-fantasy' | 'scifi-concept-art' | 'space' | 'standard' | 'whimsical';
1220
+ /**
1221
+ * The higher the value the more it will look like the style image(s)
1222
+ */
1223
+ styleFidelity?: number;
1224
+ /**
1225
+ * List of style images. Most of the time, only one image is enough. It must be
1226
+ * existing AssetIds.
1227
+ */
1228
+ styleImages?: Array<string>;
1229
+ /**
1230
+ * Condition the influence of the style image(s). The higher the value, the more
1231
+ * the style images will influence the upscaled image.
1232
+ */
1233
+ styleImagesFidelity?: number;
1234
+ /**
1235
+ * The target height of the output image.
1236
+ */
1237
+ targetHeight?: number;
1238
+ /**
1239
+ * Target width for the upscaled image, take priority over scaling factor
1240
+ */
1241
+ targetWidth?: number;
1242
+ /**
1243
+ * A textual description / keywords describing the object of interest.
1244
+ */
1245
+ text?: string;
1246
+ /**
1247
+ * The asset to convert in texture maps. Must reference an existing AssetId.
1248
+ */
1249
+ texture?: string;
1250
+ /**
1251
+ * The thumbnail of the canvas
1252
+ */
1253
+ thumbnail?: Metadata.Thumbnail;
1254
+ /**
1255
+ * If set to true, during the upscaling process, the model will match tiles of the
1256
+ * source image with tiles of the style image(s). This will result in a more
1257
+ * coherent restyle. Works best with style images that have a similar composition.
1258
+ */
1259
+ tileStyle?: boolean;
1260
+ trainingImage?: boolean;
1261
+ /**
1262
+ * (deprecated) Vertical expansion ratio.
1263
+ */
1264
+ verticalExpansionRatio?: number;
1265
+ /**
1266
+ * The width of the rendered image.
1267
+ */
1268
+ width?: number;
1269
+ }
1270
+ namespace Metadata {
1271
+ interface Concept {
1272
+ /**
1273
+ * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
1274
+ */
1275
+ modelId: string;
1276
+ /**
1277
+ * The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale
1278
+ * is between 0 and 2.
1279
+ */
1280
+ scale: number;
1281
+ /**
1282
+ * The epoch of the model (example: "000001") Only available for Flux Lora Trained
1283
+ * models
1284
+ */
1285
+ modelEpoch?: string;
1286
+ }
1287
+ /**
1288
+ * The thumbnail of the canvas
1289
+ */
1290
+ interface Thumbnail {
1291
+ /**
1292
+ * The AssetId of the image used as a thumbnail for the canvas (example:
1293
+ * "asset_GTrL3mq4SXWyMxkOHRxlpw")
1294
+ */
1295
+ assetId: string;
1296
+ /**
1297
+ * The url of the image used as a thumbnail for the canvas
1298
+ */
1299
+ url: string;
1300
+ }
1301
+ }
1302
+ /**
1303
+ * The properties of the asset, content may depend on the kind of asset returned
1304
+ */
1305
+ interface Properties {
1306
+ size: number;
1307
+ /**
1308
+ * Number of animation frames if animations exist
1309
+ */
1310
+ animationFrameCount?: number;
1311
+ /**
1312
+ * Bitrate of the media in bits per second
1313
+ */
1314
+ bitrate?: number;
1315
+ /**
1316
+ * Number of bones if skeleton exists
1317
+ */
1318
+ boneCount?: number;
1319
+ /**
1320
+ * Number of channels of the audio
1321
+ */
1322
+ channels?: number;
1323
+ /**
1324
+ * Classification of the audio
1325
+ */
1326
+ classification?: 'effect' | 'interview' | 'music' | 'other' | 'sound' | 'speech' | 'text' | 'unknown';
1327
+ /**
1328
+ * Codec name of the media
1329
+ */
1330
+ codecName?: string;
1331
+ /**
1332
+ * Description of the audio
1333
+ */
1334
+ description?: string;
1335
+ /**
1336
+ * Bounding box dimensions [width, height, depth]
1337
+ */
1338
+ dimensions?: Array<unknown>;
1339
+ /**
1340
+ * Duration of the media in seconds
1341
+ */
1342
+ duration?: number;
1343
+ /**
1344
+ * Number of faces/triangles in the mesh
1345
+ */
1346
+ faceCount?: number;
1347
+ /**
1348
+ * Format of the mesh file (e.g. 'glb', etc.)
1349
+ */
1350
+ format?: string;
1351
+ /**
1352
+ * Frame rate of the video in frames per second
1353
+ */
1354
+ frameRate?: number;
1355
+ /**
1356
+ * Whether the mesh has animations
1357
+ */
1358
+ hasAnimations?: boolean;
1359
+ /**
1360
+ * Whether the mesh has normal vectors
1361
+ */
1362
+ hasNormals?: boolean;
1363
+ /**
1364
+ * Whether the mesh has bones/skeleton
1365
+ */
1366
+ hasSkeleton?: boolean;
1367
+ /**
1368
+ * Whether the mesh has UV coordinates
1369
+ */
1370
+ hasUVs?: boolean;
1371
+ height?: number;
1372
+ /**
1373
+ * Number of frames in the video
1374
+ */
1375
+ nbFrames?: number;
1376
+ /**
1377
+ * Sample rate of the media in Hz
1378
+ */
1379
+ sampleRate?: number;
1380
+ /**
1381
+ * Transcription of the audio
1382
+ */
1383
+ transcription?: Properties.Transcription;
1384
+ /**
1385
+ * Number of vertices in the mesh
1386
+ */
1387
+ vertexCount?: number;
1388
+ width?: number;
1389
+ }
1390
+ namespace Properties {
1391
+ /**
1392
+ * Transcription of the audio
1393
+ */
1394
+ interface Transcription {
1395
+ text: string;
1396
+ }
1397
+ }
1398
+ /**
1399
+ * The video asset's first frame.
1400
+ *
1401
+ * Contains the assetId and the url of the first frame.
1402
+ */
1403
+ interface FirstFrame {
1404
+ assetId: string;
1405
+ url: string;
1406
+ }
1407
+ /**
1408
+ * The video asset's last frame.
1409
+ *
1410
+ * Contains the assetId and the url of the last frame.
1411
+ */
1412
+ interface LastFrame {
1413
+ assetId: string;
1414
+ url: string;
1415
+ }
1416
+ /**
1417
+ * The asset's preview.
1418
+ *
1419
+ * Contains the assetId and the url of the preview.
1420
+ */
1421
+ interface Preview {
1422
+ assetId: string;
1423
+ url: string;
1424
+ }
1425
+ /**
1426
+ * The asset's thumbnail.
1427
+ *
1428
+ * Contains the assetId and the url of the thumbnail.
1429
+ */
1430
+ interface Thumbnail {
1431
+ assetId: string;
1432
+ url: string;
1433
+ }
1434
+ }
1435
+ }
1436
+ export interface PublicListParams {
1437
+ /**
1438
+ * Filter results to only return assets created after the specified ISO string date
1439
+ * (exclusive). Requires the sortBy parameter to be "createdAt"
1440
+ */
1441
+ createdAfter?: string;
1442
+ /**
1443
+ * Filter results to only return assets created before the specified ISO string
1444
+ * date (exclusive). Requires the sortBy parameter to be "createdAt"
1445
+ */
1446
+ createdBefore?: string;
1447
+ /**
1448
+ * List assets generated from all inferences coming from a specific model (this is
1449
+ * not the training images)
1450
+ */
1451
+ modelId?: string;
1452
+ /**
1453
+ * If set to true, returns the original asset without transformation
1454
+ */
1455
+ originalAssets?: string;
1456
+ /**
1457
+ * The number of items to return in the response. The default value is 50, maximum
1458
+ * value is 100, minimum value is 1
1459
+ */
1460
+ pageSize?: string;
1461
+ /**
1462
+ * A token you received in a previous request to query the next page of items
1463
+ */
1464
+ paginationToken?: string;
1465
+ /**
1466
+ * Sort results by the createdAt or updatedAt
1467
+ */
1468
+ sortBy?: string;
1469
+ /**
1470
+ * Sort results in ascending (asc) or descending (desc) order
1471
+ */
1472
+ sortDirection?: string;
1473
+ /**
1474
+ * List of tags, comma separated. Only for public assets on all teams.
1475
+ */
1476
+ tags?: string;
1477
+ /**
1478
+ * List all the assets of a specific type. The parameter "type" and "types" cannot
1479
+ * be used together. Can be any of the following values: inference-txt2img,
1480
+ * inference-txt2img-ip-adapter, inference-txt2img-texture, inference-img2img,
1481
+ * inference-img2img-ip-adapter, inference-img2img-texture, inference-inpaint,
1482
+ * inference-inpaint-ip-adapter, inference-reference, inference-reference-texture,
1483
+ * inference-controlnet, inference-controlnet-ip-adapter,
1484
+ * inference-controlnet-img2img, inference-controlnet-reference,
1485
+ * inference-controlnet-inpaint, inference-controlnet-inpaint-ip-adapter,
1486
+ * inference-controlnet-texture, background-removal, canvas, canvas-export,
1487
+ * canvas-drawing, detection, patch, pixelization, upscale, upscale-texture,
1488
+ * upscale-skybox, vectorization, segment, segmentation-image, segmentation-mask,
1489
+ * skybox-base-360, skybox-hdri, skybox-3d, restyle, reframe, generative-fill,
1490
+ * texture, texture-height, texture-normal, texture-smoothness, texture-metallic,
1491
+ * texture-edge, texture-ao, texture-albedo, image-prompt-editing, unknown, img23d,
1492
+ * txt23d, 3d23d, 3d23d-texture, 3d-texture, 3d-texture-mtl, 3d-texture-albedo,
1493
+ * 3d-texture-normal, 3d-texture-roughness, 3d-texture-metallic, img2video,
1494
+ * txt2audio, audio2audio, video2video, video2img, txt2img, img2img, txt2video,
1495
+ * uploaded, uploaded-video, uploaded-audio, uploaded-3d, uploaded-avatar,
1496
+ * upscale-video, assets with a type starting with "inference-" will be returned
1497
+ */
1498
+ type?: string;
1499
+ /**
1500
+ * List of the asset types to request. The parameter "type" and "types" cannot be
1501
+ * used together. Can be any of the following values: inference-txt2img,
1502
+ * inference-txt2img-ip-adapter, inference-txt2img-texture, inference-img2img,
1503
+ * inference-img2img-ip-adapter, inference-img2img-texture, inference-inpaint,
1504
+ * inference-inpaint-ip-adapter, inference-reference, inference-reference-texture,
1505
+ * inference-controlnet, inference-controlnet-ip-adapter,
1506
+ * inference-controlnet-img2img, inference-controlnet-reference,
1507
+ * inference-controlnet-inpaint, inference-controlnet-inpaint-ip-adapter,
1508
+ * inference-controlnet-texture, background-removal, canvas, canvas-export,
1509
+ * canvas-drawing, detection, patch, pixelization, upscale, upscale-texture,
1510
+ * upscale-skybox, vectorization, segment, segmentation-image, segmentation-mask,
1511
+ * skybox-base-360, skybox-hdri, skybox-3d, restyle, reframe, generative-fill,
1512
+ * texture, texture-height, texture-normal, texture-smoothness, texture-metallic,
1513
+ * texture-edge, texture-ao, texture-albedo, image-prompt-editing, unknown, img23d,
1514
+ * txt23d, 3d23d, 3d23d-texture, 3d-texture, 3d-texture-mtl, 3d-texture-albedo,
1515
+ * 3d-texture-normal, 3d-texture-roughness, 3d-texture-metallic, img2video,
1516
+ * txt2audio, audio2audio, video2video, video2img, txt2img, img2img, txt2video,
1517
+ * uploaded, uploaded-video, uploaded-audio, uploaded-3d, uploaded-avatar,
1518
+ * upscale-video
1519
+ */
1520
+ types?: string;
1521
+ /**
1522
+ * Filter results to only return assets updated after the specified ISO string date
1523
+ * (exclusive). Requires the sortBy parameter to be "updatedAt"
1524
+ */
1525
+ updatedAfter?: string;
1526
+ /**
1527
+ * Filter results to only return assets updated before the specified ISO string
1528
+ * date (exclusive). Requires the sortBy parameter to be "updatedAt"
1529
+ */
1530
+ updatedBefore?: string;
1531
+ }
1532
+ export declare namespace Public {
1533
+ export { type PublicRetrieveResponse as PublicRetrieveResponse, type PublicListResponse as PublicListResponse, type PublicListParams as PublicListParams, };
1534
+ }
1535
+ //# sourceMappingURL=public.d.ts.map