@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,2329 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../core/resource';
4
+ import { APIPromise } from '../../core/api-promise';
5
+ import { RequestOptions } from '../../internal/request-options';
6
+ import { path } from '../../internal/utils/path';
7
+
8
+ export class Public extends APIResource {
9
+ /**
10
+ * Get the details of an asset. @deprecated Use GET /assets/{assetId} with
11
+ * Authorization: public-auth-token header instead.
12
+ *
13
+ * @deprecated
14
+ */
15
+ retrieve(assetID: string, options?: RequestOptions): APIPromise<PublicRetrieveResponse> {
16
+ return this._client.get(path`/assets/public/${assetID}`, options);
17
+ }
18
+
19
+ /**
20
+ * List all public assets. @deprecated Use GET /assets with Authorization:
21
+ * public-auth-token header instead.
22
+ *
23
+ * @deprecated
24
+ */
25
+ list(
26
+ query: PublicListParams | null | undefined = {},
27
+ options?: RequestOptions,
28
+ ): APIPromise<PublicListResponse> {
29
+ return this._client.get('/assets/public', { query, ...options });
30
+ }
31
+ }
32
+
33
+ export interface PublicRetrieveResponse {
34
+ asset: PublicRetrieveResponse.Asset;
35
+ }
36
+
37
+ export namespace PublicRetrieveResponse {
38
+ export interface Asset {
39
+ /**
40
+ * The asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
41
+ */
42
+ id: string;
43
+
44
+ /**
45
+ * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
46
+ */
47
+ authorId: string;
48
+
49
+ /**
50
+ * A list of CollectionId this asset belongs to
51
+ */
52
+ collectionIds: Array<string>;
53
+
54
+ /**
55
+ * The asset creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
56
+ */
57
+ createdAt: string;
58
+
59
+ /**
60
+ * List of edit capabilities
61
+ */
62
+ editCapabilities: Array<
63
+ | 'DETECTION'
64
+ | 'GENERATIVE_FILL'
65
+ | 'PIXELATE'
66
+ | 'PROMPT_EDITING'
67
+ | 'REFINE'
68
+ | 'REFRAME'
69
+ | 'REMOVE_BACKGROUND'
70
+ | 'SEGMENTATION'
71
+ | 'UPSCALE'
72
+ | 'UPSCALE_360'
73
+ | 'VECTORIZATION'
74
+ >;
75
+
76
+ /**
77
+ * The kind of asset
78
+ */
79
+ kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
80
+
81
+ /**
82
+ * Metadata of the asset with some additional information
83
+ */
84
+ metadata: Asset.Metadata;
85
+
86
+ /**
87
+ * The mime type of the asset (example: "image/png")
88
+ */
89
+ mimeType: string;
90
+
91
+ /**
92
+ * The owner (project) ID (example: "proj_23tlk332lkht3kl2" or
93
+ * "team_dlkhgs23tlk3hlkth32lkht3kl2" for old teams)
94
+ */
95
+ ownerId: string;
96
+
97
+ /**
98
+ * The privacy of the asset
99
+ */
100
+ privacy: 'private' | 'public' | 'unlisted';
101
+
102
+ /**
103
+ * The properties of the asset, content may depend on the kind of asset returned
104
+ */
105
+ properties: Asset.Properties;
106
+
107
+ /**
108
+ * source of the asset
109
+ */
110
+ source:
111
+ | '3d23d'
112
+ | '3d23d:texture'
113
+ | '3d:texture'
114
+ | '3d:texture:albedo'
115
+ | '3d:texture:metallic'
116
+ | '3d:texture:mtl'
117
+ | '3d:texture:normal'
118
+ | '3d:texture:roughness'
119
+ | 'audio2audio'
120
+ | 'background-removal'
121
+ | 'canvas'
122
+ | 'canvas-drawing'
123
+ | 'canvas-export'
124
+ | 'detection'
125
+ | 'generative-fill'
126
+ | 'image-prompt-editing'
127
+ | 'img23d'
128
+ | 'img2img'
129
+ | 'img2video'
130
+ | 'inference-control-net'
131
+ | 'inference-control-net-img'
132
+ | 'inference-control-net-inpainting'
133
+ | 'inference-control-net-inpainting-ip-adapter'
134
+ | 'inference-control-net-ip-adapter'
135
+ | 'inference-control-net-reference'
136
+ | 'inference-control-net-texture'
137
+ | 'inference-img'
138
+ | 'inference-img-ip-adapter'
139
+ | 'inference-img-texture'
140
+ | 'inference-in-paint'
141
+ | 'inference-in-paint-ip-adapter'
142
+ | 'inference-reference'
143
+ | 'inference-reference-texture'
144
+ | 'inference-txt'
145
+ | 'inference-txt-ip-adapter'
146
+ | 'inference-txt-texture'
147
+ | 'patch'
148
+ | 'pixelization'
149
+ | 'reframe'
150
+ | 'restyle'
151
+ | 'segment'
152
+ | 'segmentation-image'
153
+ | 'segmentation-mask'
154
+ | 'skybox-3d'
155
+ | 'skybox-base-360'
156
+ | 'skybox-hdri'
157
+ | 'texture'
158
+ | 'texture:albedo'
159
+ | 'texture:ao'
160
+ | 'texture:edge'
161
+ | 'texture:height'
162
+ | 'texture:metallic'
163
+ | 'texture:normal'
164
+ | 'texture:smoothness'
165
+ | 'txt23d'
166
+ | 'txt2audio'
167
+ | 'txt2img'
168
+ | 'txt2video'
169
+ | 'unknown'
170
+ | 'uploaded'
171
+ | 'uploaded-3d'
172
+ | 'uploaded-audio'
173
+ | 'uploaded-avatar'
174
+ | 'uploaded-video'
175
+ | 'upscale'
176
+ | 'upscale-skybox'
177
+ | 'upscale-texture'
178
+ | 'upscale-video'
179
+ | 'vectorization'
180
+ | 'video2img'
181
+ | 'video2video';
182
+
183
+ /**
184
+ * The actual status
185
+ */
186
+ status: 'error' | 'pending' | 'success';
187
+
188
+ /**
189
+ * The associated tags (example: ["sci-fi", "landscape"])
190
+ */
191
+ tags: Array<string>;
192
+
193
+ /**
194
+ * The asset last update date as an ISO string (example:
195
+ * "2023-02-03T11:19:41.579Z")
196
+ */
197
+ updatedAt: string;
198
+
199
+ /**
200
+ * Signed URL to get the asset content
201
+ */
202
+ url: string;
203
+
204
+ /**
205
+ * Automatic captioning of the asset
206
+ */
207
+ automaticCaptioning?: string;
208
+
209
+ /**
210
+ * The description, it will contain in priority:
211
+ *
212
+ * - the manual description
213
+ * - the advanced captioning when the asset is used in training flow
214
+ * - the automatic captioning
215
+ */
216
+ description?: string;
217
+
218
+ /**
219
+ * The embedding of the asset when requested.
220
+ *
221
+ * Only available when an asset can be embedded (ie: not Detection maps)
222
+ */
223
+ embedding?: Array<number>;
224
+
225
+ /**
226
+ * The video asset's first frame.
227
+ *
228
+ * Contains the assetId and the url of the first frame.
229
+ */
230
+ firstFrame?: Asset.FirstFrame;
231
+
232
+ /**
233
+ * Whether the asset is hidden.
234
+ */
235
+ isHidden?: boolean;
236
+
237
+ /**
238
+ * The video asset's last frame.
239
+ *
240
+ * Contains the assetId and the url of the last frame.
241
+ */
242
+ lastFrame?: Asset.LastFrame;
243
+
244
+ /**
245
+ * The NSFW labels
246
+ */
247
+ nsfw?: Array<string>;
248
+
249
+ /**
250
+ * The original file url.
251
+ *
252
+ * Contains the url of the original file. without any conversion. Only available
253
+ * for some specific video, audio and threeD assets. Is only specified if the given
254
+ * asset data has been replaced with a new file during the creation of the asset.
255
+ */
256
+ originalFileUrl?: string;
257
+
258
+ /**
259
+ * The output index of the asset within a job This index is an positive integer
260
+ * that starts at 0 It is used to differentiate between multiple outputs of the
261
+ * same job If the job has only one output, this index is 0
262
+ */
263
+ outputIndex?: number;
264
+
265
+ /**
266
+ * The asset's preview.
267
+ *
268
+ * Contains the assetId and the url of the preview.
269
+ */
270
+ preview?: Asset.Preview;
271
+
272
+ /**
273
+ * The asset's thumbnail.
274
+ *
275
+ * Contains the assetId and the url of the thumbnail.
276
+ */
277
+ thumbnail?: Asset.Thumbnail;
278
+ }
279
+
280
+ export namespace Asset {
281
+ /**
282
+ * Metadata of the asset with some additional information
283
+ */
284
+ export interface Metadata {
285
+ kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
286
+
287
+ /**
288
+ * The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
289
+ * from a text to image model
290
+ */
291
+ type:
292
+ | '3d-texture'
293
+ | '3d-texture-albedo'
294
+ | '3d-texture-metallic'
295
+ | '3d-texture-mtl'
296
+ | '3d-texture-normal'
297
+ | '3d-texture-roughness'
298
+ | '3d23d'
299
+ | '3d23d-texture'
300
+ | 'audio2audio'
301
+ | 'background-removal'
302
+ | 'canvas'
303
+ | 'canvas-drawing'
304
+ | 'canvas-export'
305
+ | 'detection'
306
+ | 'generative-fill'
307
+ | 'image-prompt-editing'
308
+ | 'img23d'
309
+ | 'img2img'
310
+ | 'img2video'
311
+ | 'inference-controlnet'
312
+ | 'inference-controlnet-img2img'
313
+ | 'inference-controlnet-inpaint'
314
+ | 'inference-controlnet-inpaint-ip-adapter'
315
+ | 'inference-controlnet-ip-adapter'
316
+ | 'inference-controlnet-reference'
317
+ | 'inference-controlnet-texture'
318
+ | 'inference-img2img'
319
+ | 'inference-img2img-ip-adapter'
320
+ | 'inference-img2img-texture'
321
+ | 'inference-inpaint'
322
+ | 'inference-inpaint-ip-adapter'
323
+ | 'inference-reference'
324
+ | 'inference-reference-texture'
325
+ | 'inference-txt2img'
326
+ | 'inference-txt2img-ip-adapter'
327
+ | 'inference-txt2img-texture'
328
+ | 'patch'
329
+ | 'pixelization'
330
+ | 'reframe'
331
+ | 'restyle'
332
+ | 'segment'
333
+ | 'segmentation-image'
334
+ | 'segmentation-mask'
335
+ | 'skybox-3d'
336
+ | 'skybox-base-360'
337
+ | 'skybox-hdri'
338
+ | 'texture'
339
+ | 'texture-albedo'
340
+ | 'texture-ao'
341
+ | 'texture-edge'
342
+ | 'texture-height'
343
+ | 'texture-metallic'
344
+ | 'texture-normal'
345
+ | 'texture-smoothness'
346
+ | 'txt23d'
347
+ | 'txt2audio'
348
+ | 'txt2img'
349
+ | 'txt2video'
350
+ | 'unknown'
351
+ | 'uploaded'
352
+ | 'uploaded-3d'
353
+ | 'uploaded-audio'
354
+ | 'uploaded-avatar'
355
+ | 'uploaded-video'
356
+ | 'upscale'
357
+ | 'upscale-skybox'
358
+ | 'upscale-texture'
359
+ | 'upscale-video'
360
+ | 'vectorization'
361
+ | 'video2img'
362
+ | 'video2video';
363
+
364
+ /**
365
+ * How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
366
+ */
367
+ angular?: number;
368
+
369
+ /**
370
+ * The optional aspect ratio given for the generation, only applicable for some
371
+ * models
372
+ */
373
+ aspectRatio?: string;
374
+
375
+ /**
376
+ * Int to set between 0 and 255 for the opacity of the background in the result
377
+ * images.
378
+ */
379
+ backgroundOpacity?: number;
380
+
381
+ /**
382
+ * The baseModelId that maybe changed at inference time
383
+ */
384
+ baseModelId?: string;
385
+
386
+ /**
387
+ * A bounding box around the object of interest, in the format [x1, y1, x2, y2].
388
+ */
389
+ bbox?: Array<unknown>;
390
+
391
+ /**
392
+ * Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
393
+ */
394
+ betterQuality?: boolean;
395
+
396
+ /**
397
+ * The control image already processed by canny detector. Must reference an
398
+ * existing AssetId.
399
+ */
400
+ cannyStructureImage?: string;
401
+
402
+ /**
403
+ * Activate clustering.
404
+ */
405
+ clustering?: boolean;
406
+
407
+ /**
408
+ * Ensure upscaled tile have the same color histogram as original tile.
409
+ */
410
+ colorCorrection?: boolean;
411
+
412
+ colorMode?: string;
413
+
414
+ colorPrecision?: number;
415
+
416
+ /**
417
+ * Flux Kontext LoRA to style the image. For Flux Kontext Prompt Editing.
418
+ */
419
+ concepts?: Array<Metadata.Concept>;
420
+
421
+ contours?: Array<Array<Array<Array<number>>>>;
422
+
423
+ /**
424
+ * End step for control.
425
+ */
426
+ controlEnd?: number;
427
+
428
+ /**
429
+ * The date when the asset was copied to a project
430
+ */
431
+ copiedAt?: string;
432
+
433
+ cornerThreshold?: number;
434
+
435
+ /**
436
+ * Allow the generation of "hallucinations" during the upscale process, which adds
437
+ * additional details and deviates from the original image. Default: optimized for
438
+ * your preset and style.
439
+ */
440
+ creativity?: number;
441
+
442
+ /**
443
+ * Amount of decay in creativity over the upscale process. The lowest the value,
444
+ * the less the creativity will be preserved over the upscale process.
445
+ */
446
+ creativityDecay?: number;
447
+
448
+ /**
449
+ * If true, use the default parameters
450
+ */
451
+ defaultParameters?: boolean;
452
+
453
+ /**
454
+ * The depth fidelity if a depth image provided
455
+ */
456
+ depthFidelity?: number;
457
+
458
+ /**
459
+ * The control image processed by depth estimator. Must reference an existing
460
+ * AssetId.
461
+ */
462
+ depthImage?: string;
463
+
464
+ /**
465
+ * Amount of details to remove or add
466
+ */
467
+ detailsLevel?: number;
468
+
469
+ /**
470
+ * The number of pixels to dilate the result masks.
471
+ */
472
+ dilate?: number;
473
+
474
+ /**
475
+ * Contrast factor for Grayscale detector
476
+ */
477
+ factor?: number;
478
+
479
+ filterSpeckle?: number;
480
+
481
+ /**
482
+ * Determine the scale at which the upscale process works.
483
+ *
484
+ * - With a small value, the upscale works at the largest scale, resulting in fewer
485
+ * added details and more coherent images. Ideal for portraits, for example.
486
+ * - With a large value, the upscale works at the smallest scale, resulting in more
487
+ * added details and more hallucinations. Ideal for landscapes, for example.
488
+ *
489
+ * (info): A small value is slower and more expensive to run.
490
+ */
491
+ fractality?: number;
492
+
493
+ /**
494
+ * Apply extra control to the Skybox 360 geometry. The higher the value, the more
495
+ * the 360 geometry will influence the generated skybox image.
496
+ *
497
+ * Use with caution. Default is adapted to the other parameters.
498
+ */
499
+ geometryEnforcement?: number;
500
+
501
+ /**
502
+ * The guidance used to generate this asset
503
+ */
504
+ guidance?: number;
505
+
506
+ halfMode?: boolean;
507
+
508
+ hdr?: number;
509
+
510
+ height?: number;
511
+
512
+ /**
513
+ * High threshold for Canny detector
514
+ */
515
+ highThreshold?: number;
516
+
517
+ /**
518
+ * (deprecated) Horizontal expansion ratio.
519
+ */
520
+ horizontalExpansionRatio?: number;
521
+
522
+ /**
523
+ * The input image to process. Must reference an existing AssetId or be a data URL.
524
+ */
525
+ image?: string;
526
+
527
+ /**
528
+ * Strengthen the similarity to the original image during the upscale. Default:
529
+ * optimized for your preset and style.
530
+ */
531
+ imageFidelity?: number;
532
+
533
+ /**
534
+ * Preserve the seamless properties of skybox or texture images. Input has to be of
535
+ * same type (seamless).
536
+ */
537
+ imageType?: 'seamfull' | 'skybox' | 'texture';
538
+
539
+ /**
540
+ * The id of the Inference describing how this image was generated
541
+ */
542
+ inferenceId?: string;
543
+
544
+ /**
545
+ * When set to `high`, allows to better preserve details from the input images in
546
+ * the output. This is especially useful when using images that contain elements
547
+ * like faces or logos that require accurate preservation in the generated image.
548
+ *
549
+ * You can provide multiple input images that will all be preserved with high
550
+ * fidelity, but keep in mind that the first image will be preserved with richer
551
+ * textures and finer details, so if you include elements such as faces, consider
552
+ * placing them in the first image.
553
+ *
554
+ * Only available for the `gpt-image-1` model.
555
+ */
556
+ inputFidelity?: 'high' | 'low';
557
+
558
+ /**
559
+ * Location of the input image in the output.
560
+ */
561
+ inputLocation?: 'bottom' | 'left' | 'middle' | 'right' | 'top';
562
+
563
+ /**
564
+ * To invert the relief
565
+ */
566
+ invert?: boolean;
567
+
568
+ /**
569
+ * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
570
+ */
571
+ keypointThreshold?: number;
572
+
573
+ layerDifference?: number;
574
+
575
+ lengthThreshold?: number;
576
+
577
+ /**
578
+ * The ISO timestamp when the lock on the canvas will expire
579
+ */
580
+ lockExpiresAt?: string;
581
+
582
+ /**
583
+ * Low threshold for Canny detector
584
+ */
585
+ lowThreshold?: number;
586
+
587
+ /**
588
+ * The mask used for the asset generation or editing
589
+ */
590
+ mask?: string;
591
+
592
+ maxIterations?: number;
593
+
594
+ /**
595
+ * Maximum threshold for Grayscale conversion
596
+ */
597
+ maxThreshold?: number;
598
+
599
+ /**
600
+ * Minimum threshold for Grayscale conversion
601
+ */
602
+ minThreshold?: number;
603
+
604
+ /**
605
+ * Modality to detect
606
+ */
607
+ modality?:
608
+ | 'canny'
609
+ | 'depth'
610
+ | 'grayscale'
611
+ | 'lineart_anime'
612
+ | 'mlsd'
613
+ | 'normal'
614
+ | 'pose'
615
+ | 'scribble'
616
+ | 'segmentation'
617
+ | 'sketch';
618
+
619
+ mode?: string;
620
+
621
+ /**
622
+ * The modelId used to generate this asset
623
+ */
624
+ modelId?: string;
625
+
626
+ /**
627
+ * The type of the generator used
628
+ */
629
+ modelType?:
630
+ | 'custom'
631
+ | 'flux.1'
632
+ | 'flux.1-composition'
633
+ | 'flux.1-kontext-dev'
634
+ | 'flux.1-kontext-lora'
635
+ | 'flux.1-krea-dev'
636
+ | 'flux.1-krea-lora'
637
+ | 'flux.1-lora'
638
+ | 'flux.1-pro'
639
+ | 'flux.1.1-pro-ultra'
640
+ | 'flux1.1-pro'
641
+ | 'gpt-image-1'
642
+ | 'sd-1_5'
643
+ | 'sd-1_5-composition'
644
+ | 'sd-1_5-lora'
645
+ | 'sd-xl'
646
+ | 'sd-xl-composition'
647
+ | 'sd-xl-lora';
648
+
649
+ name?: string;
650
+
651
+ nbMasks?: number;
652
+
653
+ /**
654
+ * The negative prompt used to generate this asset
655
+ */
656
+ negativePrompt?: string;
657
+
658
+ /**
659
+ * Controls the influence of the negative prompt. Default 0 means the negative
660
+ * prompt has no effect. Higher values increase negative prompt influence. Must
661
+ * be > 0 if negativePrompt is provided.
662
+ */
663
+ negativePromptStrength?: number;
664
+
665
+ /**
666
+ * The number of denoising steps for each image generation.
667
+ */
668
+ numInferenceSteps?: number;
669
+
670
+ /**
671
+ * The number of outputs to generate.
672
+ */
673
+ numOutputs?: number;
674
+
675
+ originalAssetId?: string;
676
+
677
+ outputIndex?: number;
678
+
679
+ /**
680
+ * Overlap percentage for the output image.
681
+ */
682
+ overlapPercentage?: number;
683
+
684
+ /**
685
+ * Override the embeddings of the model. Only your prompt and negativePrompt will
686
+ * be used. Use with caution.
687
+ */
688
+ overrideEmbeddings?: boolean;
689
+
690
+ parentId?: string;
691
+
692
+ parentJobId?: string;
693
+
694
+ pathPrecision?: number;
695
+
696
+ /**
697
+ * List of points (label, x, y) in the image where label = 0 for background and 1
698
+ * for object.
699
+ */
700
+ points?: Array<Array<unknown>>;
701
+
702
+ /**
703
+ * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
704
+ */
705
+ polished?: number;
706
+
707
+ preset?: string;
708
+
709
+ progressPercent?: number;
710
+
711
+ /**
712
+ * The prompt that guided the asset generation or editing
713
+ */
714
+ prompt?: string;
715
+
716
+ /**
717
+ * Increase the fidelity to the prompt during upscale. Default: optimized for your
718
+ * preset and style.
719
+ */
720
+ promptFidelity?: number;
721
+
722
+ /**
723
+ * How raised is the surface? 0 is flat like water, 1 is like a very rough rock
724
+ */
725
+ raised?: number;
726
+
727
+ /**
728
+ * The reference images used for the asset generation or editing
729
+ */
730
+ referenceImages?: Array<string>;
731
+
732
+ /**
733
+ * Additional refinement steps before scaling.
734
+ *
735
+ * If scalingFactor == 1, the refinement process will be applied (1 +
736
+ * refinementSteps) times. If scalingFactor > 1, the refinement process will be
737
+ * applied refinementSteps times.
738
+ */
739
+ refinementSteps?: number;
740
+
741
+ /**
742
+ * Remove background for Grayscale detector
743
+ */
744
+ removeBackground?: boolean;
745
+
746
+ /**
747
+ * Size proportion of the input image in the output.
748
+ */
749
+ resizeOption?: number;
750
+
751
+ /**
752
+ * Boolean to output the contours.
753
+ */
754
+ resultContours?: boolean;
755
+
756
+ /**
757
+ * Boolean to able output the cut out object.
758
+ */
759
+ resultImage?: boolean;
760
+
761
+ /**
762
+ * Boolean to able return the masks (binary image) in the response.
763
+ */
764
+ resultMask?: boolean;
765
+
766
+ rootParentId?: string;
767
+
768
+ /**
769
+ * Save a flipbook of the texture. Deactivated when the input texture is larger
770
+ * than 2048x2048px
771
+ */
772
+ saveFlipbook?: boolean;
773
+
774
+ /**
775
+ * Scaling factor (when `targetWidth` not specified)
776
+ */
777
+ scalingFactor?: number;
778
+
779
+ /**
780
+ * The scheduler used to generate this asset
781
+ */
782
+ scheduler?: string;
783
+
784
+ /**
785
+ * The seed used to generate this asset
786
+ */
787
+ seed?: string;
788
+
789
+ /**
790
+ * Sharpen tiles.
791
+ */
792
+ sharpen?: boolean;
793
+
794
+ /**
795
+ * How shiny is the surface? 0 is like a matte surface, 1 is like a diamond
796
+ */
797
+ shiny?: number;
798
+
799
+ size?: number;
800
+
801
+ /**
802
+ * Activate sketch detection instead of canny.
803
+ */
804
+ sketch?: boolean;
805
+
806
+ sourceProjectId?: string;
807
+
808
+ spliceThreshold?: number;
809
+
810
+ /**
811
+ * The strength
812
+ *
813
+ * Only available for the `flux-kontext` LoRA model.
814
+ */
815
+ strength?: number;
816
+
817
+ /**
818
+ * Strength for the input image structure preservation
819
+ */
820
+ structureFidelity?: number;
821
+
822
+ /**
823
+ * The control image for structure. A canny detector will be applied to this image.
824
+ * Must reference an existing AssetId.
825
+ */
826
+ structureImage?: string;
827
+
828
+ style?:
829
+ | '3d-cartoon'
830
+ | '3d-rendered'
831
+ | 'anime'
832
+ | 'cartoon'
833
+ | 'cinematic'
834
+ | 'claymation'
835
+ | 'cloud-skydome'
836
+ | 'comic'
837
+ | 'cyberpunk'
838
+ | 'enchanted'
839
+ | 'fantasy'
840
+ | 'ink'
841
+ | 'manga'
842
+ | 'manga-color'
843
+ | 'minimalist'
844
+ | 'neon-tron'
845
+ | 'oil-painting'
846
+ | 'pastel'
847
+ | 'photo'
848
+ | 'photography'
849
+ | 'psychedelic'
850
+ | 'retro-fantasy'
851
+ | 'scifi-concept-art'
852
+ | 'space'
853
+ | 'standard'
854
+ | 'whimsical';
855
+
856
+ /**
857
+ * The higher the value the more it will look like the style image(s)
858
+ */
859
+ styleFidelity?: number;
860
+
861
+ /**
862
+ * List of style images. Most of the time, only one image is enough. It must be
863
+ * existing AssetIds.
864
+ */
865
+ styleImages?: Array<string>;
866
+
867
+ /**
868
+ * Condition the influence of the style image(s). The higher the value, the more
869
+ * the style images will influence the upscaled image.
870
+ */
871
+ styleImagesFidelity?: number;
872
+
873
+ /**
874
+ * The target height of the output image.
875
+ */
876
+ targetHeight?: number;
877
+
878
+ /**
879
+ * Target width for the upscaled image, take priority over scaling factor
880
+ */
881
+ targetWidth?: number;
882
+
883
+ /**
884
+ * A textual description / keywords describing the object of interest.
885
+ */
886
+ text?: string;
887
+
888
+ /**
889
+ * The asset to convert in texture maps. Must reference an existing AssetId.
890
+ */
891
+ texture?: string;
892
+
893
+ /**
894
+ * The thumbnail of the canvas
895
+ */
896
+ thumbnail?: Metadata.Thumbnail;
897
+
898
+ /**
899
+ * If set to true, during the upscaling process, the model will match tiles of the
900
+ * source image with tiles of the style image(s). This will result in a more
901
+ * coherent restyle. Works best with style images that have a similar composition.
902
+ */
903
+ tileStyle?: boolean;
904
+
905
+ trainingImage?: boolean;
906
+
907
+ /**
908
+ * (deprecated) Vertical expansion ratio.
909
+ */
910
+ verticalExpansionRatio?: number;
911
+
912
+ /**
913
+ * The width of the rendered image.
914
+ */
915
+ width?: number;
916
+ }
917
+
918
+ export namespace Metadata {
919
+ export interface Concept {
920
+ /**
921
+ * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
922
+ */
923
+ modelId: string;
924
+
925
+ /**
926
+ * The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale
927
+ * is between 0 and 2.
928
+ */
929
+ scale: number;
930
+
931
+ /**
932
+ * The epoch of the model (example: "000001") Only available for Flux Lora Trained
933
+ * models
934
+ */
935
+ modelEpoch?: string;
936
+ }
937
+
938
+ /**
939
+ * The thumbnail of the canvas
940
+ */
941
+ export interface Thumbnail {
942
+ /**
943
+ * The AssetId of the image used as a thumbnail for the canvas (example:
944
+ * "asset_GTrL3mq4SXWyMxkOHRxlpw")
945
+ */
946
+ assetId: string;
947
+
948
+ /**
949
+ * The url of the image used as a thumbnail for the canvas
950
+ */
951
+ url: string;
952
+ }
953
+ }
954
+
955
+ /**
956
+ * The properties of the asset, content may depend on the kind of asset returned
957
+ */
958
+ export interface Properties {
959
+ size: number;
960
+
961
+ /**
962
+ * Number of animation frames if animations exist
963
+ */
964
+ animationFrameCount?: number;
965
+
966
+ /**
967
+ * Bitrate of the media in bits per second
968
+ */
969
+ bitrate?: number;
970
+
971
+ /**
972
+ * Number of bones if skeleton exists
973
+ */
974
+ boneCount?: number;
975
+
976
+ /**
977
+ * Number of channels of the audio
978
+ */
979
+ channels?: number;
980
+
981
+ /**
982
+ * Classification of the audio
983
+ */
984
+ classification?: 'effect' | 'interview' | 'music' | 'other' | 'sound' | 'speech' | 'text' | 'unknown';
985
+
986
+ /**
987
+ * Codec name of the media
988
+ */
989
+ codecName?: string;
990
+
991
+ /**
992
+ * Description of the audio
993
+ */
994
+ description?: string;
995
+
996
+ /**
997
+ * Bounding box dimensions [width, height, depth]
998
+ */
999
+ dimensions?: Array<unknown>;
1000
+
1001
+ /**
1002
+ * Duration of the media in seconds
1003
+ */
1004
+ duration?: number;
1005
+
1006
+ /**
1007
+ * Number of faces/triangles in the mesh
1008
+ */
1009
+ faceCount?: number;
1010
+
1011
+ /**
1012
+ * Format of the mesh file (e.g. 'glb', etc.)
1013
+ */
1014
+ format?: string;
1015
+
1016
+ /**
1017
+ * Frame rate of the video in frames per second
1018
+ */
1019
+ frameRate?: number;
1020
+
1021
+ /**
1022
+ * Whether the mesh has animations
1023
+ */
1024
+ hasAnimations?: boolean;
1025
+
1026
+ /**
1027
+ * Whether the mesh has normal vectors
1028
+ */
1029
+ hasNormals?: boolean;
1030
+
1031
+ /**
1032
+ * Whether the mesh has bones/skeleton
1033
+ */
1034
+ hasSkeleton?: boolean;
1035
+
1036
+ /**
1037
+ * Whether the mesh has UV coordinates
1038
+ */
1039
+ hasUVs?: boolean;
1040
+
1041
+ height?: number;
1042
+
1043
+ /**
1044
+ * Number of frames in the video
1045
+ */
1046
+ nbFrames?: number;
1047
+
1048
+ /**
1049
+ * Sample rate of the media in Hz
1050
+ */
1051
+ sampleRate?: number;
1052
+
1053
+ /**
1054
+ * Transcription of the audio
1055
+ */
1056
+ transcription?: Properties.Transcription;
1057
+
1058
+ /**
1059
+ * Number of vertices in the mesh
1060
+ */
1061
+ vertexCount?: number;
1062
+
1063
+ width?: number;
1064
+ }
1065
+
1066
+ export namespace Properties {
1067
+ /**
1068
+ * Transcription of the audio
1069
+ */
1070
+ export interface Transcription {
1071
+ text: string;
1072
+ }
1073
+ }
1074
+
1075
+ /**
1076
+ * The video asset's first frame.
1077
+ *
1078
+ * Contains the assetId and the url of the first frame.
1079
+ */
1080
+ export interface FirstFrame {
1081
+ assetId: string;
1082
+
1083
+ url: string;
1084
+ }
1085
+
1086
+ /**
1087
+ * The video asset's last frame.
1088
+ *
1089
+ * Contains the assetId and the url of the last frame.
1090
+ */
1091
+ export interface LastFrame {
1092
+ assetId: string;
1093
+
1094
+ url: string;
1095
+ }
1096
+
1097
+ /**
1098
+ * The asset's preview.
1099
+ *
1100
+ * Contains the assetId and the url of the preview.
1101
+ */
1102
+ export interface Preview {
1103
+ assetId: string;
1104
+
1105
+ url: string;
1106
+ }
1107
+
1108
+ /**
1109
+ * The asset's thumbnail.
1110
+ *
1111
+ * Contains the assetId and the url of the thumbnail.
1112
+ */
1113
+ export interface Thumbnail {
1114
+ assetId: string;
1115
+
1116
+ url: string;
1117
+ }
1118
+ }
1119
+ }
1120
+
1121
+ export interface PublicListResponse {
1122
+ assets: Array<PublicListResponse.Asset>;
1123
+
1124
+ /**
1125
+ * A token to query the next page of assets
1126
+ */
1127
+ nextPaginationToken?: string;
1128
+ }
1129
+
1130
+ export namespace PublicListResponse {
1131
+ export interface Asset {
1132
+ /**
1133
+ * The asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
1134
+ */
1135
+ id: string;
1136
+
1137
+ /**
1138
+ * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
1139
+ */
1140
+ authorId: string;
1141
+
1142
+ /**
1143
+ * A list of CollectionId this asset belongs to
1144
+ */
1145
+ collectionIds: Array<string>;
1146
+
1147
+ /**
1148
+ * The asset creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
1149
+ */
1150
+ createdAt: string;
1151
+
1152
+ /**
1153
+ * List of edit capabilities
1154
+ */
1155
+ editCapabilities: Array<
1156
+ | 'DETECTION'
1157
+ | 'GENERATIVE_FILL'
1158
+ | 'PIXELATE'
1159
+ | 'PROMPT_EDITING'
1160
+ | 'REFINE'
1161
+ | 'REFRAME'
1162
+ | 'REMOVE_BACKGROUND'
1163
+ | 'SEGMENTATION'
1164
+ | 'UPSCALE'
1165
+ | 'UPSCALE_360'
1166
+ | 'VECTORIZATION'
1167
+ >;
1168
+
1169
+ /**
1170
+ * The kind of asset
1171
+ */
1172
+ kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
1173
+
1174
+ /**
1175
+ * Metadata of the asset with some additional information
1176
+ */
1177
+ metadata: Asset.Metadata;
1178
+
1179
+ /**
1180
+ * The mime type of the asset (example: "image/png")
1181
+ */
1182
+ mimeType: string;
1183
+
1184
+ /**
1185
+ * The owner (project) ID (example: "proj_23tlk332lkht3kl2" or
1186
+ * "team_dlkhgs23tlk3hlkth32lkht3kl2" for old teams)
1187
+ */
1188
+ ownerId: string;
1189
+
1190
+ /**
1191
+ * The privacy of the asset
1192
+ */
1193
+ privacy: 'private' | 'public' | 'unlisted';
1194
+
1195
+ /**
1196
+ * The properties of the asset, content may depend on the kind of asset returned
1197
+ */
1198
+ properties: Asset.Properties;
1199
+
1200
+ /**
1201
+ * source of the asset
1202
+ */
1203
+ source:
1204
+ | '3d23d'
1205
+ | '3d23d:texture'
1206
+ | '3d:texture'
1207
+ | '3d:texture:albedo'
1208
+ | '3d:texture:metallic'
1209
+ | '3d:texture:mtl'
1210
+ | '3d:texture:normal'
1211
+ | '3d:texture:roughness'
1212
+ | 'audio2audio'
1213
+ | 'background-removal'
1214
+ | 'canvas'
1215
+ | 'canvas-drawing'
1216
+ | 'canvas-export'
1217
+ | 'detection'
1218
+ | 'generative-fill'
1219
+ | 'image-prompt-editing'
1220
+ | 'img23d'
1221
+ | 'img2img'
1222
+ | 'img2video'
1223
+ | 'inference-control-net'
1224
+ | 'inference-control-net-img'
1225
+ | 'inference-control-net-inpainting'
1226
+ | 'inference-control-net-inpainting-ip-adapter'
1227
+ | 'inference-control-net-ip-adapter'
1228
+ | 'inference-control-net-reference'
1229
+ | 'inference-control-net-texture'
1230
+ | 'inference-img'
1231
+ | 'inference-img-ip-adapter'
1232
+ | 'inference-img-texture'
1233
+ | 'inference-in-paint'
1234
+ | 'inference-in-paint-ip-adapter'
1235
+ | 'inference-reference'
1236
+ | 'inference-reference-texture'
1237
+ | 'inference-txt'
1238
+ | 'inference-txt-ip-adapter'
1239
+ | 'inference-txt-texture'
1240
+ | 'patch'
1241
+ | 'pixelization'
1242
+ | 'reframe'
1243
+ | 'restyle'
1244
+ | 'segment'
1245
+ | 'segmentation-image'
1246
+ | 'segmentation-mask'
1247
+ | 'skybox-3d'
1248
+ | 'skybox-base-360'
1249
+ | 'skybox-hdri'
1250
+ | 'texture'
1251
+ | 'texture:albedo'
1252
+ | 'texture:ao'
1253
+ | 'texture:edge'
1254
+ | 'texture:height'
1255
+ | 'texture:metallic'
1256
+ | 'texture:normal'
1257
+ | 'texture:smoothness'
1258
+ | 'txt23d'
1259
+ | 'txt2audio'
1260
+ | 'txt2img'
1261
+ | 'txt2video'
1262
+ | 'unknown'
1263
+ | 'uploaded'
1264
+ | 'uploaded-3d'
1265
+ | 'uploaded-audio'
1266
+ | 'uploaded-avatar'
1267
+ | 'uploaded-video'
1268
+ | 'upscale'
1269
+ | 'upscale-skybox'
1270
+ | 'upscale-texture'
1271
+ | 'upscale-video'
1272
+ | 'vectorization'
1273
+ | 'video2img'
1274
+ | 'video2video';
1275
+
1276
+ /**
1277
+ * The actual status
1278
+ */
1279
+ status: 'error' | 'pending' | 'success';
1280
+
1281
+ /**
1282
+ * The associated tags (example: ["sci-fi", "landscape"])
1283
+ */
1284
+ tags: Array<string>;
1285
+
1286
+ /**
1287
+ * The asset last update date as an ISO string (example:
1288
+ * "2023-02-03T11:19:41.579Z")
1289
+ */
1290
+ updatedAt: string;
1291
+
1292
+ /**
1293
+ * Signed URL to get the asset content
1294
+ */
1295
+ url: string;
1296
+
1297
+ /**
1298
+ * Automatic captioning of the asset
1299
+ */
1300
+ automaticCaptioning?: string;
1301
+
1302
+ /**
1303
+ * The description, it will contain in priority:
1304
+ *
1305
+ * - the manual description
1306
+ * - the advanced captioning when the asset is used in training flow
1307
+ * - the automatic captioning
1308
+ */
1309
+ description?: string;
1310
+
1311
+ /**
1312
+ * The embedding of the asset when requested.
1313
+ *
1314
+ * Only available when an asset can be embedded (ie: not Detection maps)
1315
+ */
1316
+ embedding?: Array<number>;
1317
+
1318
+ /**
1319
+ * The video asset's first frame.
1320
+ *
1321
+ * Contains the assetId and the url of the first frame.
1322
+ */
1323
+ firstFrame?: Asset.FirstFrame;
1324
+
1325
+ /**
1326
+ * Whether the asset is hidden.
1327
+ */
1328
+ isHidden?: boolean;
1329
+
1330
+ /**
1331
+ * The video asset's last frame.
1332
+ *
1333
+ * Contains the assetId and the url of the last frame.
1334
+ */
1335
+ lastFrame?: Asset.LastFrame;
1336
+
1337
+ /**
1338
+ * The NSFW labels
1339
+ */
1340
+ nsfw?: Array<string>;
1341
+
1342
+ /**
1343
+ * The original file url.
1344
+ *
1345
+ * Contains the url of the original file. without any conversion. Only available
1346
+ * for some specific video, audio and threeD assets. Is only specified if the given
1347
+ * asset data has been replaced with a new file during the creation of the asset.
1348
+ */
1349
+ originalFileUrl?: string;
1350
+
1351
+ /**
1352
+ * The output index of the asset within a job This index is an positive integer
1353
+ * that starts at 0 It is used to differentiate between multiple outputs of the
1354
+ * same job If the job has only one output, this index is 0
1355
+ */
1356
+ outputIndex?: number;
1357
+
1358
+ /**
1359
+ * The asset's preview.
1360
+ *
1361
+ * Contains the assetId and the url of the preview.
1362
+ */
1363
+ preview?: Asset.Preview;
1364
+
1365
+ /**
1366
+ * The asset's thumbnail.
1367
+ *
1368
+ * Contains the assetId and the url of the thumbnail.
1369
+ */
1370
+ thumbnail?: Asset.Thumbnail;
1371
+ }
1372
+
1373
+ export namespace Asset {
1374
+ /**
1375
+ * Metadata of the asset with some additional information
1376
+ */
1377
+ export interface Metadata {
1378
+ kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
1379
+
1380
+ /**
1381
+ * The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
1382
+ * from a text to image model
1383
+ */
1384
+ type:
1385
+ | '3d-texture'
1386
+ | '3d-texture-albedo'
1387
+ | '3d-texture-metallic'
1388
+ | '3d-texture-mtl'
1389
+ | '3d-texture-normal'
1390
+ | '3d-texture-roughness'
1391
+ | '3d23d'
1392
+ | '3d23d-texture'
1393
+ | 'audio2audio'
1394
+ | 'background-removal'
1395
+ | 'canvas'
1396
+ | 'canvas-drawing'
1397
+ | 'canvas-export'
1398
+ | 'detection'
1399
+ | 'generative-fill'
1400
+ | 'image-prompt-editing'
1401
+ | 'img23d'
1402
+ | 'img2img'
1403
+ | 'img2video'
1404
+ | 'inference-controlnet'
1405
+ | 'inference-controlnet-img2img'
1406
+ | 'inference-controlnet-inpaint'
1407
+ | 'inference-controlnet-inpaint-ip-adapter'
1408
+ | 'inference-controlnet-ip-adapter'
1409
+ | 'inference-controlnet-reference'
1410
+ | 'inference-controlnet-texture'
1411
+ | 'inference-img2img'
1412
+ | 'inference-img2img-ip-adapter'
1413
+ | 'inference-img2img-texture'
1414
+ | 'inference-inpaint'
1415
+ | 'inference-inpaint-ip-adapter'
1416
+ | 'inference-reference'
1417
+ | 'inference-reference-texture'
1418
+ | 'inference-txt2img'
1419
+ | 'inference-txt2img-ip-adapter'
1420
+ | 'inference-txt2img-texture'
1421
+ | 'patch'
1422
+ | 'pixelization'
1423
+ | 'reframe'
1424
+ | 'restyle'
1425
+ | 'segment'
1426
+ | 'segmentation-image'
1427
+ | 'segmentation-mask'
1428
+ | 'skybox-3d'
1429
+ | 'skybox-base-360'
1430
+ | 'skybox-hdri'
1431
+ | 'texture'
1432
+ | 'texture-albedo'
1433
+ | 'texture-ao'
1434
+ | 'texture-edge'
1435
+ | 'texture-height'
1436
+ | 'texture-metallic'
1437
+ | 'texture-normal'
1438
+ | 'texture-smoothness'
1439
+ | 'txt23d'
1440
+ | 'txt2audio'
1441
+ | 'txt2img'
1442
+ | 'txt2video'
1443
+ | 'unknown'
1444
+ | 'uploaded'
1445
+ | 'uploaded-3d'
1446
+ | 'uploaded-audio'
1447
+ | 'uploaded-avatar'
1448
+ | 'uploaded-video'
1449
+ | 'upscale'
1450
+ | 'upscale-skybox'
1451
+ | 'upscale-texture'
1452
+ | 'upscale-video'
1453
+ | 'vectorization'
1454
+ | 'video2img'
1455
+ | 'video2video';
1456
+
1457
+ /**
1458
+ * How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
1459
+ */
1460
+ angular?: number;
1461
+
1462
+ /**
1463
+ * The optional aspect ratio given for the generation, only applicable for some
1464
+ * models
1465
+ */
1466
+ aspectRatio?: string;
1467
+
1468
+ /**
1469
+ * Int to set between 0 and 255 for the opacity of the background in the result
1470
+ * images.
1471
+ */
1472
+ backgroundOpacity?: number;
1473
+
1474
+ /**
1475
+ * The baseModelId that maybe changed at inference time
1476
+ */
1477
+ baseModelId?: string;
1478
+
1479
+ /**
1480
+ * A bounding box around the object of interest, in the format [x1, y1, x2, y2].
1481
+ */
1482
+ bbox?: Array<unknown>;
1483
+
1484
+ /**
1485
+ * Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
1486
+ */
1487
+ betterQuality?: boolean;
1488
+
1489
+ /**
1490
+ * The control image already processed by canny detector. Must reference an
1491
+ * existing AssetId.
1492
+ */
1493
+ cannyStructureImage?: string;
1494
+
1495
+ /**
1496
+ * Activate clustering.
1497
+ */
1498
+ clustering?: boolean;
1499
+
1500
+ /**
1501
+ * Ensure upscaled tile have the same color histogram as original tile.
1502
+ */
1503
+ colorCorrection?: boolean;
1504
+
1505
+ colorMode?: string;
1506
+
1507
+ colorPrecision?: number;
1508
+
1509
+ /**
1510
+ * Flux Kontext LoRA to style the image. For Flux Kontext Prompt Editing.
1511
+ */
1512
+ concepts?: Array<Metadata.Concept>;
1513
+
1514
+ contours?: Array<Array<Array<Array<number>>>>;
1515
+
1516
+ /**
1517
+ * End step for control.
1518
+ */
1519
+ controlEnd?: number;
1520
+
1521
+ /**
1522
+ * The date when the asset was copied to a project
1523
+ */
1524
+ copiedAt?: string;
1525
+
1526
+ cornerThreshold?: number;
1527
+
1528
+ /**
1529
+ * Allow the generation of "hallucinations" during the upscale process, which adds
1530
+ * additional details and deviates from the original image. Default: optimized for
1531
+ * your preset and style.
1532
+ */
1533
+ creativity?: number;
1534
+
1535
+ /**
1536
+ * Amount of decay in creativity over the upscale process. The lowest the value,
1537
+ * the less the creativity will be preserved over the upscale process.
1538
+ */
1539
+ creativityDecay?: number;
1540
+
1541
+ /**
1542
+ * If true, use the default parameters
1543
+ */
1544
+ defaultParameters?: boolean;
1545
+
1546
+ /**
1547
+ * The depth fidelity if a depth image provided
1548
+ */
1549
+ depthFidelity?: number;
1550
+
1551
+ /**
1552
+ * The control image processed by depth estimator. Must reference an existing
1553
+ * AssetId.
1554
+ */
1555
+ depthImage?: string;
1556
+
1557
+ /**
1558
+ * Amount of details to remove or add
1559
+ */
1560
+ detailsLevel?: number;
1561
+
1562
+ /**
1563
+ * The number of pixels to dilate the result masks.
1564
+ */
1565
+ dilate?: number;
1566
+
1567
+ /**
1568
+ * Contrast factor for Grayscale detector
1569
+ */
1570
+ factor?: number;
1571
+
1572
+ filterSpeckle?: number;
1573
+
1574
+ /**
1575
+ * Determine the scale at which the upscale process works.
1576
+ *
1577
+ * - With a small value, the upscale works at the largest scale, resulting in fewer
1578
+ * added details and more coherent images. Ideal for portraits, for example.
1579
+ * - With a large value, the upscale works at the smallest scale, resulting in more
1580
+ * added details and more hallucinations. Ideal for landscapes, for example.
1581
+ *
1582
+ * (info): A small value is slower and more expensive to run.
1583
+ */
1584
+ fractality?: number;
1585
+
1586
+ /**
1587
+ * Apply extra control to the Skybox 360 geometry. The higher the value, the more
1588
+ * the 360 geometry will influence the generated skybox image.
1589
+ *
1590
+ * Use with caution. Default is adapted to the other parameters.
1591
+ */
1592
+ geometryEnforcement?: number;
1593
+
1594
+ /**
1595
+ * The guidance used to generate this asset
1596
+ */
1597
+ guidance?: number;
1598
+
1599
+ halfMode?: boolean;
1600
+
1601
+ hdr?: number;
1602
+
1603
+ height?: number;
1604
+
1605
+ /**
1606
+ * High threshold for Canny detector
1607
+ */
1608
+ highThreshold?: number;
1609
+
1610
+ /**
1611
+ * (deprecated) Horizontal expansion ratio.
1612
+ */
1613
+ horizontalExpansionRatio?: number;
1614
+
1615
+ /**
1616
+ * The input image to process. Must reference an existing AssetId or be a data URL.
1617
+ */
1618
+ image?: string;
1619
+
1620
+ /**
1621
+ * Strengthen the similarity to the original image during the upscale. Default:
1622
+ * optimized for your preset and style.
1623
+ */
1624
+ imageFidelity?: number;
1625
+
1626
+ /**
1627
+ * Preserve the seamless properties of skybox or texture images. Input has to be of
1628
+ * same type (seamless).
1629
+ */
1630
+ imageType?: 'seamfull' | 'skybox' | 'texture';
1631
+
1632
+ /**
1633
+ * The id of the Inference describing how this image was generated
1634
+ */
1635
+ inferenceId?: string;
1636
+
1637
+ /**
1638
+ * When set to `high`, allows to better preserve details from the input images in
1639
+ * the output. This is especially useful when using images that contain elements
1640
+ * like faces or logos that require accurate preservation in the generated image.
1641
+ *
1642
+ * You can provide multiple input images that will all be preserved with high
1643
+ * fidelity, but keep in mind that the first image will be preserved with richer
1644
+ * textures and finer details, so if you include elements such as faces, consider
1645
+ * placing them in the first image.
1646
+ *
1647
+ * Only available for the `gpt-image-1` model.
1648
+ */
1649
+ inputFidelity?: 'high' | 'low';
1650
+
1651
+ /**
1652
+ * Location of the input image in the output.
1653
+ */
1654
+ inputLocation?: 'bottom' | 'left' | 'middle' | 'right' | 'top';
1655
+
1656
+ /**
1657
+ * To invert the relief
1658
+ */
1659
+ invert?: boolean;
1660
+
1661
+ /**
1662
+ * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
1663
+ */
1664
+ keypointThreshold?: number;
1665
+
1666
+ layerDifference?: number;
1667
+
1668
+ lengthThreshold?: number;
1669
+
1670
+ /**
1671
+ * The ISO timestamp when the lock on the canvas will expire
1672
+ */
1673
+ lockExpiresAt?: string;
1674
+
1675
+ /**
1676
+ * Low threshold for Canny detector
1677
+ */
1678
+ lowThreshold?: number;
1679
+
1680
+ /**
1681
+ * The mask used for the asset generation or editing
1682
+ */
1683
+ mask?: string;
1684
+
1685
+ maxIterations?: number;
1686
+
1687
+ /**
1688
+ * Maximum threshold for Grayscale conversion
1689
+ */
1690
+ maxThreshold?: number;
1691
+
1692
+ /**
1693
+ * Minimum threshold for Grayscale conversion
1694
+ */
1695
+ minThreshold?: number;
1696
+
1697
+ /**
1698
+ * Modality to detect
1699
+ */
1700
+ modality?:
1701
+ | 'canny'
1702
+ | 'depth'
1703
+ | 'grayscale'
1704
+ | 'lineart_anime'
1705
+ | 'mlsd'
1706
+ | 'normal'
1707
+ | 'pose'
1708
+ | 'scribble'
1709
+ | 'segmentation'
1710
+ | 'sketch';
1711
+
1712
+ mode?: string;
1713
+
1714
+ /**
1715
+ * The modelId used to generate this asset
1716
+ */
1717
+ modelId?: string;
1718
+
1719
+ /**
1720
+ * The type of the generator used
1721
+ */
1722
+ modelType?:
1723
+ | 'custom'
1724
+ | 'flux.1'
1725
+ | 'flux.1-composition'
1726
+ | 'flux.1-kontext-dev'
1727
+ | 'flux.1-kontext-lora'
1728
+ | 'flux.1-krea-dev'
1729
+ | 'flux.1-krea-lora'
1730
+ | 'flux.1-lora'
1731
+ | 'flux.1-pro'
1732
+ | 'flux.1.1-pro-ultra'
1733
+ | 'flux1.1-pro'
1734
+ | 'gpt-image-1'
1735
+ | 'sd-1_5'
1736
+ | 'sd-1_5-composition'
1737
+ | 'sd-1_5-lora'
1738
+ | 'sd-xl'
1739
+ | 'sd-xl-composition'
1740
+ | 'sd-xl-lora';
1741
+
1742
+ name?: string;
1743
+
1744
+ nbMasks?: number;
1745
+
1746
+ /**
1747
+ * The negative prompt used to generate this asset
1748
+ */
1749
+ negativePrompt?: string;
1750
+
1751
+ /**
1752
+ * Controls the influence of the negative prompt. Default 0 means the negative
1753
+ * prompt has no effect. Higher values increase negative prompt influence. Must
1754
+ * be > 0 if negativePrompt is provided.
1755
+ */
1756
+ negativePromptStrength?: number;
1757
+
1758
+ /**
1759
+ * The number of denoising steps for each image generation.
1760
+ */
1761
+ numInferenceSteps?: number;
1762
+
1763
+ /**
1764
+ * The number of outputs to generate.
1765
+ */
1766
+ numOutputs?: number;
1767
+
1768
+ originalAssetId?: string;
1769
+
1770
+ outputIndex?: number;
1771
+
1772
+ /**
1773
+ * Overlap percentage for the output image.
1774
+ */
1775
+ overlapPercentage?: number;
1776
+
1777
+ /**
1778
+ * Override the embeddings of the model. Only your prompt and negativePrompt will
1779
+ * be used. Use with caution.
1780
+ */
1781
+ overrideEmbeddings?: boolean;
1782
+
1783
+ parentId?: string;
1784
+
1785
+ parentJobId?: string;
1786
+
1787
+ pathPrecision?: number;
1788
+
1789
+ /**
1790
+ * List of points (label, x, y) in the image where label = 0 for background and 1
1791
+ * for object.
1792
+ */
1793
+ points?: Array<Array<unknown>>;
1794
+
1795
+ /**
1796
+ * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
1797
+ */
1798
+ polished?: number;
1799
+
1800
+ preset?: string;
1801
+
1802
+ progressPercent?: number;
1803
+
1804
+ /**
1805
+ * The prompt that guided the asset generation or editing
1806
+ */
1807
+ prompt?: string;
1808
+
1809
+ /**
1810
+ * Increase the fidelity to the prompt during upscale. Default: optimized for your
1811
+ * preset and style.
1812
+ */
1813
+ promptFidelity?: number;
1814
+
1815
+ /**
1816
+ * How raised is the surface? 0 is flat like water, 1 is like a very rough rock
1817
+ */
1818
+ raised?: number;
1819
+
1820
+ /**
1821
+ * The reference images used for the asset generation or editing
1822
+ */
1823
+ referenceImages?: Array<string>;
1824
+
1825
+ /**
1826
+ * Additional refinement steps before scaling.
1827
+ *
1828
+ * If scalingFactor == 1, the refinement process will be applied (1 +
1829
+ * refinementSteps) times. If scalingFactor > 1, the refinement process will be
1830
+ * applied refinementSteps times.
1831
+ */
1832
+ refinementSteps?: number;
1833
+
1834
+ /**
1835
+ * Remove background for Grayscale detector
1836
+ */
1837
+ removeBackground?: boolean;
1838
+
1839
+ /**
1840
+ * Size proportion of the input image in the output.
1841
+ */
1842
+ resizeOption?: number;
1843
+
1844
+ /**
1845
+ * Boolean to output the contours.
1846
+ */
1847
+ resultContours?: boolean;
1848
+
1849
+ /**
1850
+ * Boolean to able output the cut out object.
1851
+ */
1852
+ resultImage?: boolean;
1853
+
1854
+ /**
1855
+ * Boolean to able return the masks (binary image) in the response.
1856
+ */
1857
+ resultMask?: boolean;
1858
+
1859
+ rootParentId?: string;
1860
+
1861
+ /**
1862
+ * Save a flipbook of the texture. Deactivated when the input texture is larger
1863
+ * than 2048x2048px
1864
+ */
1865
+ saveFlipbook?: boolean;
1866
+
1867
+ /**
1868
+ * Scaling factor (when `targetWidth` not specified)
1869
+ */
1870
+ scalingFactor?: number;
1871
+
1872
+ /**
1873
+ * The scheduler used to generate this asset
1874
+ */
1875
+ scheduler?: string;
1876
+
1877
+ /**
1878
+ * The seed used to generate this asset
1879
+ */
1880
+ seed?: string;
1881
+
1882
+ /**
1883
+ * Sharpen tiles.
1884
+ */
1885
+ sharpen?: boolean;
1886
+
1887
+ /**
1888
+ * How shiny is the surface? 0 is like a matte surface, 1 is like a diamond
1889
+ */
1890
+ shiny?: number;
1891
+
1892
+ size?: number;
1893
+
1894
+ /**
1895
+ * Activate sketch detection instead of canny.
1896
+ */
1897
+ sketch?: boolean;
1898
+
1899
+ sourceProjectId?: string;
1900
+
1901
+ spliceThreshold?: number;
1902
+
1903
+ /**
1904
+ * The strength
1905
+ *
1906
+ * Only available for the `flux-kontext` LoRA model.
1907
+ */
1908
+ strength?: number;
1909
+
1910
+ /**
1911
+ * Strength for the input image structure preservation
1912
+ */
1913
+ structureFidelity?: number;
1914
+
1915
+ /**
1916
+ * The control image for structure. A canny detector will be applied to this image.
1917
+ * Must reference an existing AssetId.
1918
+ */
1919
+ structureImage?: string;
1920
+
1921
+ style?:
1922
+ | '3d-cartoon'
1923
+ | '3d-rendered'
1924
+ | 'anime'
1925
+ | 'cartoon'
1926
+ | 'cinematic'
1927
+ | 'claymation'
1928
+ | 'cloud-skydome'
1929
+ | 'comic'
1930
+ | 'cyberpunk'
1931
+ | 'enchanted'
1932
+ | 'fantasy'
1933
+ | 'ink'
1934
+ | 'manga'
1935
+ | 'manga-color'
1936
+ | 'minimalist'
1937
+ | 'neon-tron'
1938
+ | 'oil-painting'
1939
+ | 'pastel'
1940
+ | 'photo'
1941
+ | 'photography'
1942
+ | 'psychedelic'
1943
+ | 'retro-fantasy'
1944
+ | 'scifi-concept-art'
1945
+ | 'space'
1946
+ | 'standard'
1947
+ | 'whimsical';
1948
+
1949
+ /**
1950
+ * The higher the value the more it will look like the style image(s)
1951
+ */
1952
+ styleFidelity?: number;
1953
+
1954
+ /**
1955
+ * List of style images. Most of the time, only one image is enough. It must be
1956
+ * existing AssetIds.
1957
+ */
1958
+ styleImages?: Array<string>;
1959
+
1960
+ /**
1961
+ * Condition the influence of the style image(s). The higher the value, the more
1962
+ * the style images will influence the upscaled image.
1963
+ */
1964
+ styleImagesFidelity?: number;
1965
+
1966
+ /**
1967
+ * The target height of the output image.
1968
+ */
1969
+ targetHeight?: number;
1970
+
1971
+ /**
1972
+ * Target width for the upscaled image, take priority over scaling factor
1973
+ */
1974
+ targetWidth?: number;
1975
+
1976
+ /**
1977
+ * A textual description / keywords describing the object of interest.
1978
+ */
1979
+ text?: string;
1980
+
1981
+ /**
1982
+ * The asset to convert in texture maps. Must reference an existing AssetId.
1983
+ */
1984
+ texture?: string;
1985
+
1986
+ /**
1987
+ * The thumbnail of the canvas
1988
+ */
1989
+ thumbnail?: Metadata.Thumbnail;
1990
+
1991
+ /**
1992
+ * If set to true, during the upscaling process, the model will match tiles of the
1993
+ * source image with tiles of the style image(s). This will result in a more
1994
+ * coherent restyle. Works best with style images that have a similar composition.
1995
+ */
1996
+ tileStyle?: boolean;
1997
+
1998
+ trainingImage?: boolean;
1999
+
2000
+ /**
2001
+ * (deprecated) Vertical expansion ratio.
2002
+ */
2003
+ verticalExpansionRatio?: number;
2004
+
2005
+ /**
2006
+ * The width of the rendered image.
2007
+ */
2008
+ width?: number;
2009
+ }
2010
+
2011
+ export namespace Metadata {
2012
+ export interface Concept {
2013
+ /**
2014
+ * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
2015
+ */
2016
+ modelId: string;
2017
+
2018
+ /**
2019
+ * The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale
2020
+ * is between 0 and 2.
2021
+ */
2022
+ scale: number;
2023
+
2024
+ /**
2025
+ * The epoch of the model (example: "000001") Only available for Flux Lora Trained
2026
+ * models
2027
+ */
2028
+ modelEpoch?: string;
2029
+ }
2030
+
2031
+ /**
2032
+ * The thumbnail of the canvas
2033
+ */
2034
+ export interface Thumbnail {
2035
+ /**
2036
+ * The AssetId of the image used as a thumbnail for the canvas (example:
2037
+ * "asset_GTrL3mq4SXWyMxkOHRxlpw")
2038
+ */
2039
+ assetId: string;
2040
+
2041
+ /**
2042
+ * The url of the image used as a thumbnail for the canvas
2043
+ */
2044
+ url: string;
2045
+ }
2046
+ }
2047
+
2048
+ /**
2049
+ * The properties of the asset, content may depend on the kind of asset returned
2050
+ */
2051
+ export interface Properties {
2052
+ size: number;
2053
+
2054
+ /**
2055
+ * Number of animation frames if animations exist
2056
+ */
2057
+ animationFrameCount?: number;
2058
+
2059
+ /**
2060
+ * Bitrate of the media in bits per second
2061
+ */
2062
+ bitrate?: number;
2063
+
2064
+ /**
2065
+ * Number of bones if skeleton exists
2066
+ */
2067
+ boneCount?: number;
2068
+
2069
+ /**
2070
+ * Number of channels of the audio
2071
+ */
2072
+ channels?: number;
2073
+
2074
+ /**
2075
+ * Classification of the audio
2076
+ */
2077
+ classification?: 'effect' | 'interview' | 'music' | 'other' | 'sound' | 'speech' | 'text' | 'unknown';
2078
+
2079
+ /**
2080
+ * Codec name of the media
2081
+ */
2082
+ codecName?: string;
2083
+
2084
+ /**
2085
+ * Description of the audio
2086
+ */
2087
+ description?: string;
2088
+
2089
+ /**
2090
+ * Bounding box dimensions [width, height, depth]
2091
+ */
2092
+ dimensions?: Array<unknown>;
2093
+
2094
+ /**
2095
+ * Duration of the media in seconds
2096
+ */
2097
+ duration?: number;
2098
+
2099
+ /**
2100
+ * Number of faces/triangles in the mesh
2101
+ */
2102
+ faceCount?: number;
2103
+
2104
+ /**
2105
+ * Format of the mesh file (e.g. 'glb', etc.)
2106
+ */
2107
+ format?: string;
2108
+
2109
+ /**
2110
+ * Frame rate of the video in frames per second
2111
+ */
2112
+ frameRate?: number;
2113
+
2114
+ /**
2115
+ * Whether the mesh has animations
2116
+ */
2117
+ hasAnimations?: boolean;
2118
+
2119
+ /**
2120
+ * Whether the mesh has normal vectors
2121
+ */
2122
+ hasNormals?: boolean;
2123
+
2124
+ /**
2125
+ * Whether the mesh has bones/skeleton
2126
+ */
2127
+ hasSkeleton?: boolean;
2128
+
2129
+ /**
2130
+ * Whether the mesh has UV coordinates
2131
+ */
2132
+ hasUVs?: boolean;
2133
+
2134
+ height?: number;
2135
+
2136
+ /**
2137
+ * Number of frames in the video
2138
+ */
2139
+ nbFrames?: number;
2140
+
2141
+ /**
2142
+ * Sample rate of the media in Hz
2143
+ */
2144
+ sampleRate?: number;
2145
+
2146
+ /**
2147
+ * Transcription of the audio
2148
+ */
2149
+ transcription?: Properties.Transcription;
2150
+
2151
+ /**
2152
+ * Number of vertices in the mesh
2153
+ */
2154
+ vertexCount?: number;
2155
+
2156
+ width?: number;
2157
+ }
2158
+
2159
+ export namespace Properties {
2160
+ /**
2161
+ * Transcription of the audio
2162
+ */
2163
+ export interface Transcription {
2164
+ text: string;
2165
+ }
2166
+ }
2167
+
2168
+ /**
2169
+ * The video asset's first frame.
2170
+ *
2171
+ * Contains the assetId and the url of the first frame.
2172
+ */
2173
+ export interface FirstFrame {
2174
+ assetId: string;
2175
+
2176
+ url: string;
2177
+ }
2178
+
2179
+ /**
2180
+ * The video asset's last frame.
2181
+ *
2182
+ * Contains the assetId and the url of the last frame.
2183
+ */
2184
+ export interface LastFrame {
2185
+ assetId: string;
2186
+
2187
+ url: string;
2188
+ }
2189
+
2190
+ /**
2191
+ * The asset's preview.
2192
+ *
2193
+ * Contains the assetId and the url of the preview.
2194
+ */
2195
+ export interface Preview {
2196
+ assetId: string;
2197
+
2198
+ url: string;
2199
+ }
2200
+
2201
+ /**
2202
+ * The asset's thumbnail.
2203
+ *
2204
+ * Contains the assetId and the url of the thumbnail.
2205
+ */
2206
+ export interface Thumbnail {
2207
+ assetId: string;
2208
+
2209
+ url: string;
2210
+ }
2211
+ }
2212
+ }
2213
+
2214
+ export interface PublicListParams {
2215
+ /**
2216
+ * Filter results to only return assets created after the specified ISO string date
2217
+ * (exclusive). Requires the sortBy parameter to be "createdAt"
2218
+ */
2219
+ createdAfter?: string;
2220
+
2221
+ /**
2222
+ * Filter results to only return assets created before the specified ISO string
2223
+ * date (exclusive). Requires the sortBy parameter to be "createdAt"
2224
+ */
2225
+ createdBefore?: string;
2226
+
2227
+ /**
2228
+ * List assets generated from all inferences coming from a specific model (this is
2229
+ * not the training images)
2230
+ */
2231
+ modelId?: string;
2232
+
2233
+ /**
2234
+ * If set to true, returns the original asset without transformation
2235
+ */
2236
+ originalAssets?: string;
2237
+
2238
+ /**
2239
+ * The number of items to return in the response. The default value is 50, maximum
2240
+ * value is 100, minimum value is 1
2241
+ */
2242
+ pageSize?: string;
2243
+
2244
+ /**
2245
+ * A token you received in a previous request to query the next page of items
2246
+ */
2247
+ paginationToken?: string;
2248
+
2249
+ /**
2250
+ * Sort results by the createdAt or updatedAt
2251
+ */
2252
+ sortBy?: string;
2253
+
2254
+ /**
2255
+ * Sort results in ascending (asc) or descending (desc) order
2256
+ */
2257
+ sortDirection?: string;
2258
+
2259
+ /**
2260
+ * List of tags, comma separated. Only for public assets on all teams.
2261
+ */
2262
+ tags?: string;
2263
+
2264
+ /**
2265
+ * List all the assets of a specific type. The parameter "type" and "types" cannot
2266
+ * be used together. Can be any of the following values: inference-txt2img,
2267
+ * inference-txt2img-ip-adapter, inference-txt2img-texture, inference-img2img,
2268
+ * inference-img2img-ip-adapter, inference-img2img-texture, inference-inpaint,
2269
+ * inference-inpaint-ip-adapter, inference-reference, inference-reference-texture,
2270
+ * inference-controlnet, inference-controlnet-ip-adapter,
2271
+ * inference-controlnet-img2img, inference-controlnet-reference,
2272
+ * inference-controlnet-inpaint, inference-controlnet-inpaint-ip-adapter,
2273
+ * inference-controlnet-texture, background-removal, canvas, canvas-export,
2274
+ * canvas-drawing, detection, patch, pixelization, upscale, upscale-texture,
2275
+ * upscale-skybox, vectorization, segment, segmentation-image, segmentation-mask,
2276
+ * skybox-base-360, skybox-hdri, skybox-3d, restyle, reframe, generative-fill,
2277
+ * texture, texture-height, texture-normal, texture-smoothness, texture-metallic,
2278
+ * texture-edge, texture-ao, texture-albedo, image-prompt-editing, unknown, img23d,
2279
+ * txt23d, 3d23d, 3d23d-texture, 3d-texture, 3d-texture-mtl, 3d-texture-albedo,
2280
+ * 3d-texture-normal, 3d-texture-roughness, 3d-texture-metallic, img2video,
2281
+ * txt2audio, audio2audio, video2video, video2img, txt2img, img2img, txt2video,
2282
+ * uploaded, uploaded-video, uploaded-audio, uploaded-3d, uploaded-avatar,
2283
+ * upscale-video, assets with a type starting with "inference-" will be returned
2284
+ */
2285
+ type?: string;
2286
+
2287
+ /**
2288
+ * List of the asset types to request. The parameter "type" and "types" cannot be
2289
+ * used together. Can be any of the following values: inference-txt2img,
2290
+ * inference-txt2img-ip-adapter, inference-txt2img-texture, inference-img2img,
2291
+ * inference-img2img-ip-adapter, inference-img2img-texture, inference-inpaint,
2292
+ * inference-inpaint-ip-adapter, inference-reference, inference-reference-texture,
2293
+ * inference-controlnet, inference-controlnet-ip-adapter,
2294
+ * inference-controlnet-img2img, inference-controlnet-reference,
2295
+ * inference-controlnet-inpaint, inference-controlnet-inpaint-ip-adapter,
2296
+ * inference-controlnet-texture, background-removal, canvas, canvas-export,
2297
+ * canvas-drawing, detection, patch, pixelization, upscale, upscale-texture,
2298
+ * upscale-skybox, vectorization, segment, segmentation-image, segmentation-mask,
2299
+ * skybox-base-360, skybox-hdri, skybox-3d, restyle, reframe, generative-fill,
2300
+ * texture, texture-height, texture-normal, texture-smoothness, texture-metallic,
2301
+ * texture-edge, texture-ao, texture-albedo, image-prompt-editing, unknown, img23d,
2302
+ * txt23d, 3d23d, 3d23d-texture, 3d-texture, 3d-texture-mtl, 3d-texture-albedo,
2303
+ * 3d-texture-normal, 3d-texture-roughness, 3d-texture-metallic, img2video,
2304
+ * txt2audio, audio2audio, video2video, video2img, txt2img, img2img, txt2video,
2305
+ * uploaded, uploaded-video, uploaded-audio, uploaded-3d, uploaded-avatar,
2306
+ * upscale-video
2307
+ */
2308
+ types?: string;
2309
+
2310
+ /**
2311
+ * Filter results to only return assets updated after the specified ISO string date
2312
+ * (exclusive). Requires the sortBy parameter to be "updatedAt"
2313
+ */
2314
+ updatedAfter?: string;
2315
+
2316
+ /**
2317
+ * Filter results to only return assets updated before the specified ISO string
2318
+ * date (exclusive). Requires the sortBy parameter to be "updatedAt"
2319
+ */
2320
+ updatedBefore?: string;
2321
+ }
2322
+
2323
+ export declare namespace Public {
2324
+ export {
2325
+ type PublicRetrieveResponse as PublicRetrieveResponse,
2326
+ type PublicListResponse as PublicListResponse,
2327
+ type PublicListParams as PublicListParams,
2328
+ };
2329
+ }