diff --git a/docs/reference/assets/search.js b/docs/reference/assets/search.js index 17433e7..3e46323 100644 --- a/docs/reference/assets/search.js +++ b/docs/reference/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE72cWY/bRhKA/wv9KsvTJ8l5WwQJYmCDzSa72QfBGHAkzpiIhlRIyl7D8H9fNA+xilUtNjXGPo0tdh1d/VX1weNrVFefm+h+9zX6sygP0b2Sm6jMXvLoPnrKjtEmOtfH6D76lNVF9njMm3dP2XH7sX1xl/bHrGnyJrqPom+bUYHVFwX7Os/a/Kfs+MOxyMv2ouzpXO7boiqbd7MWVxVLYy+aqc6ibPP6KdvnzbswdeJOTp7+dc7P+bKuN2M7oHETnbLaeQK98pip8+zYFi8hlkDTG401bVVnzyG2ppY3m6rz7KUon4OMTW3Dzck7nUxhPJchEexa3WiiOT82+7p4DAofaPuqAAZHb5Uha4yaMufhof1yCoPCWdpe2i8Y3A6esYXgc9F+/KU4HI7556zOmTqAG4TWFyf1a13994tHY3ftek25S2NhppL3W/7XOW9axlcXheYduX7d1WuRv6bwzULUqZt8mfynK1f+QgkuL0QJZ8ZLEaTuzaUp3wvonc9Ym7XnJszY2PQVxhzBv68xiQRuNzwWkH9Va6wzUje7UOfN+Rg2qpemNxvbZ+U+PwYZuzRdZQykwG/DPOrPAtwiPBH2VVnm+1CVb6bmvpxGjoKJQk42/3Yqfqzrqr4YHXS9Gy9cdd8ICb1v2vq8b5eUvcEteecvfnnnN4Q1b2ghg5dsPFaHLwsWXJO3cpUFEPw/smNxyNz0wo/B7Pp3GQpOZ9CIzJ0FEFsp9BS2pyI/Hro2dHxY61hgtXWYQs95+9Na80RmrQchYLKWGT7b5vC2aN4W5ce8Ltr8cIMHLLas/aHla63TNU9zqsom/zkrD8e8JgsUdPX16x2qbnm1gx3kC/3v/SbGX+dRg/Ct4fl0rLJDmMI3l8Z8T7CP65foXovDMv1KbcOig5+eLrd1VjZPVf3yvjydA2P5hgj930KALS/tWLCCmdd84f8pO/6ON2hjnl6ufJdij7UFlfnJNc9Y7qvyqXgOMNW3utFKXh5OVVG27w9LllDLG605Awtm+iY36q9O3R5yycbULNwOmv6qctHE1SOM69oPVZkv6R/a3Gghe6zqdsnE2GiFDbxAaYrnMlsc8EurG/uyy5ov5f59m9dZW9Uflsw9oOYP6+yiWWs4Dbs2b6EmK3bq3kMlTuXS0dLcU/+CotuUzTay/ewPrqw6lpktZt6XT9VMM9PitUsVn8ql5QrnrKfQvDTP64xue4lgw+Nk6LF/rPYr7fcS38v++qhv14aeejCH6z/5489V9ee4ypz5M7saejR5yuom/5HOitMB5axFqOKi4dJrUouuhyv9oXo5HfM2Pyxp5xquPGJFJ02XbcH5eL20hW0uRi0BewrnhYfLQ9Zmi7q3Q6trBhb4r/tzXMCH1xhsus4iGYBz+Y/ZAmewernw6oHAmhYHY/LIE6gCbUSuGdl2Td+KAGMLg/OStx8rMjK80Uvb9Tbnw/Pv+sgPz3ThtcMz07Q0PMAj3ynK+fFQvWRFGWRoC5svmVwYpL/Oef0lzOrY9JUWT1n7Mczg0HK9Pc9dqb9X89XCdOE73YcaNQXegHIeebOnaeDd52tmtlPjJXNLC5r8E7ixcNXm2PSVFpvqXO8Du3lp+0qb7jZB02YvpzCzsPl6y3MYf8nbutjPi9Pw62sxhGqWGBwd8U4ZT3mdl/v8AT1x4bWzJQJXzTKBAtu692W3POIWU2AbRluFH0v674x6tC7dXmFcvvawzMOpagpXv9a4QCRf60o9LMsf4JFQgCMzude70eXPQ8GeE/udAFJhp/pXXcIA/lpXz3XesNsF5BzT8Ptg6FO8TCLn+80EeN0IhGCFM8fqeW0sBpHvEonrEF6Jww0cXncMonh1awk8XL2zDATRq3eJQ9bxGzH0OxFE4RpXfBD6XbjK4BrTL7O1QZD1Seh7DMO1HLg2CKtTgHfrwyYqykP+3+j+a/Qprxs3zd1Hcqu2abTp77W7p217fzfRvnp56Y99D9X+3P3zw9Dsj9zd+HGN+9bv7qLN7m6j5Vam6sOHzW4U7i50P4w6pl86QRFtdoITFERQIEEZbXaSE5REUCJBFW12ihNURFAhQR1tdpoT1ERQI0ETbXaGEzRE0CBBG212lhO0RNAiwTja7GJOMCaCMRJMos0u4QQTIpggwTTa7NKNirci0UgwJYIpBsDxIO42UmxTiUUFhUfM6Onw4flhAMIECceFYBkSFCKBKRKODcFyJChIApMktL/PFCaBaRKOEcGCKChQAhMlHCeChVFQqASmSjhWhN3IeGtlioUpWAKTJRwvgoVSULgEpks4ZgQLpqCACUyY7Ahj4ZSUMIkJk44ZyZY2SQmTsxrVFSkWT8mUKUyYdMxIvsRRwiQmTDpmJIunpIRJTJh0zEi9UWqbSCxLAZMYMGm9jEgKmMSASYeMNOxIUcAkBkw6ZCRbLiUFTGLAZOrtMuVLYr6UI0ayZCvKl8J8qY4vlmxF+VKYLyW9wVaULzWbB5U32IqZCjFfquMrZd2mfCnMlzLe8qcoYAoDphwyik1IRQFTGDDlkFFsQioKmMKAqcTvNgVMYcCUY0ax2awoYQoTpv1zpKaEaUyYdswothRoSpjGhGnpywtNAdMYMN2ttPgVEwVMzxZbDhnFTlSaWW9hwLRDRrGlQFPANAZMd4Cx6awpYBoDpjvA2HTWFDCNAdMOGcUmlaaAaQyYdshoNi80BUxjwIxDRrN5YShgBgNmHDKaRdtQwAwGzDhmNEunoYQZTJhRvlWnoYAZDJjplvMsnYYCZmYreoeM5tf0zKIeA2asN5sNBcxgwIxDRrNoGwqYwYAZh4xm0TYUMIMBMx1gLNqGAmYwYLYDjEXbUsAsBsw6ZAyLtqWAWQyYdcgYFm1LAbMYMOuYMSzalhJmMWFWe9edlhJmMWHWP0daSpid7RsdM4ZNKstsHTFh1jFj2MSwlDCLCbOOGcMmhqWEWUyYTf19poRZTFjsmDFsYsSUsBgTFneE8TtmSliMCYs7wtjEiClhMSYsVt4+x5SwGBMWO2YMm1UxJSzGhMWOGctmVUwJizFhcXc0wWZVTAmLZ6cTjhnLZlXMHFBgwmL/KiymhMWYsNgxY9nEiClhMSYsccxYNjESSliCCUscM5ZNjIQSlmDCEseMZdlOKGEJJixxzNiYK0MJJSzBhCX+k4qEEpZgwpKOMP44iRKWYMKSjjCW7YQSlmDCEv9JRUIJS2ZnYI6ZmE2MhDkGw4QljplYMAvmhAKWYMBSh0wsGdmU8pVivlJHTMySnVK+UsxX6t9HppSvFPOVKl+PU4pXivFKHTCxZs8NKV4pxis13nBRulJMV+p4idl0TCldKaYr9dOVUrpSTFeaeMNF4Upnh6ypP1zMOev8oPXOWwj6a1gc/DbIC1+8+0tz8f637qbDp7xu88P7/ubDbnd5vuJr9DDckRB3432Sr5G4i+6/fttEQvd/lRn+Jv1fPVw3tv9rh+s27f/Gavg7tE86Pd+mOxrdr5ebGu6ac314GWDySQOfdBqm41Tk/fuXkxqpJjUy0BX3AH8xPMCPXJKTLiOCdPVv5gF3DHAnHiKrglSNLzwDZSBEMsyf/XhvqnvgYrzNOamMgX+pDVTZvyE0KVEaDF1g58Z3oEHvQLRlsJbpvSigCfgjB1zlgKuWYZq7z9E8Zcf98DYGSB6QO0G6+qeDJwUGIGrDYt6/nQMinoKIJ0Eqxtet3I1NoAiMvw5Ll+5jQJMGwORdqDwNKhz7UC3jayqgNyCyOmxwujus+fAGMfAnnjSpsH49561PWQKUhbk1fwRtUmaBssQEKjsNz2j4qgCIWxrqYPccNqDaTjrisIgVZeePxykLGE/C0qRoluqdAaDZsCJT+KJmQCWwYdQOj5qCToJSlYRFrXvxBkxSgFQTVgr6pzzA8AMn0mEZkIZNwZfndUGXAExxqJb+oXkQW9CrOIzIy9MjwBWgJRnWKW6lFaSuQXOcBnibOEiDe64R1CaQtzpQwfj0P9ACeqTDkqJ7vYiv/gYUbxsW5f5RdhBikARxmEPD4/dAB3AjDitpw+fXQGBAiQ3XAJ5ABekA3EnCMqpTxiwVQGKJFR2jtUYDTSZsnp6+GwfUAHpWKWFmbDDwMqz6wWerQLhBSU6HzUZqxmQNo3LQPKMb9NaGZdyg51ih3LfAw3iVohfw+TCABYBVhNGKnw0EwQOjkAxL3HSodGkYu6Pqj+NXP8AYgylYhQLTv9QHeguUyGF8baCyM05MMAyh8kwNNWDNa8NiNL5TDjIJBN6EzSjjSx8ALOBJEkY6LQ0CzExi2GLKYbOuZP83GX5Ph/+nYfG7fA4SBA90e40OWkAUKLMqbOagK37A1kC/CUso8PFJMB4AjHVaaPc0SHITVh97bcwIA/BFILDTi3Vg7EC04rAMHD/cB5wBBIjAKE2fxZz0wG3MOi1txYQIqBNhi07wMhQgACCQhI3a5cMxZEukwLyhAp2andRp0C8TpmL88hDwA9QqFZb5s2lGgbDosLw/10eu9oL+xGHx/XR5lZ8e9gG3ZBhFM21F9wEJEG9Y38I6+jl//FhVf9aXrwYAbSDhbNgk4b5W6lk1wIOnsMnCKTv1n0UFegCVImAIPmyiU3HKj0WZR/e7D9++/Q9DldaaKloAAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAE72cWY/bRhKA/wv9KsvDvkjO2yJIEAMbbDbezT4IgwFH4swQkUiFpOwYhv970DzEKna1WJQG+yR72HV09VfVB49vQVV+qYP7zbfgj7zYBfdSrIIiPWTBffCc7oNVcKr2wX3wOa3y9Gmf1R+e0/36tTnYS9t9WtdZHdwHwffVoMCos4JtlaVN9lO6/2GfZ0VzVvZ8KrZNXhb1h0mLi4qFNmfNrs68aLLqOd1m9QeeuvBOjJ7+ecpO2byud0M7oHEVHNPKegK98pipsnTf5AeOJdD0SmN1U1bpC8fW2PJqU1WWHvLihWVsbMs3J+5UPIbxVHAi2La60kR9eqq3Vf7ECh9oe1MA2dFbZMhoLcfMeXxsvh55UFhL63P7GYPr3jOyEHzJm9df8t1un31Jq4yoA7gBt75YqV+r8q+vHo3ttcs15S6JQj2WvN+yP09Z3RC+2ijUH5zrl129FPlLCt/NRN11ky6T/7blyl8oweWZKOHMOOQsde/OTeleQO98xpq0OdU8Y0PTG4xZgj8tMYkErjc8FJD/lEusE1JXu1Bl9WnPG9Vz06uNbdNim+1Zxs5NFxkDKfBbP4/6swC34CfCtiyKbMtV+W5s7stp5CiYKMRo8x/H/MeqKquz0V7Xh+HCRfd1KKD3dVOdts2csne4Je382S/v/Iawpg3NZPCcjady93XGgm3yXiyyAIL/e7rPd6mdXugxmFx/k6GgdLJGZOosgNiIUI1he86z/a5t444PaR0LLLYOU+gla35aat6RWeoBB0zSMsFnU+/e5/X7vHjNqrzJdld4QGJL2u9b3mrdXfPUx7Kos5/TYrfPKmeBgq7evt5x1c2vdrCDdKH/1G1i/HUeNeBvDU/HfZnueArfnRvTPcE+Ll+iey32y/QLtQ2L9n56utxUaVE/l9XhY3E8MWP5zhH6v4UAW57bsWAFE6/pwv9Tuv+EN2hDnp6vvEmxx9pYZX50zTOW27J4zl8YprpWV1rJit2xzIvm427OEmp5pTVrYMZM1+RK/eWx3UPO2Rib8e2g6a8sZk1cPMK4rH1XFtmc/r7NlRbSp7Jq5kwMjRbYwAuUOn8p0tkBP7e6si+btP5abD82WZU2ZfUwZ+4RNX9cZhfNWv1p2KV5CzVZsFP3HipRKueOlqae+hcU7aZsspHtZn9wZdGxzGQx87F4LieaiRa3LlV8KueWK5SznkJzqF+WGV13EmzDw2Tosb8vtwvtdxJvZX951NdLQ+96MIXrf9nTz2X5x7DKnPgzuco9mjymVZ396M6K4wHlpAVXcV5T6TWqRdf5Sn8oD8d91mS7Oe1Uw4VHrOik6bwtOO0vlzbe5mLQwthTWC88XO7SJp3Vve5bXTIww3/VneMCPrzGYNNlFp0BOBX/mixweqvnCzcPBNY0OxijR55A5WgjcsnIum36PmQYmxmcQ9a8ls7I0EbPbW+02S6WPuEFz0XDWGC59Skc/632NBzjhVvhmGiagwN45DvDOT3tykOaFyxDa9h8zuTMcP15yqqvPKtD0xstHtPmlWewb7ncnuee2D/L6VplvPBGd8EGTczbX9Yjb+7WNbz3fcnMemw8Z25uOZV9zpy8pW0OTW+0WJenasvs5rntjTbtTYq6SQ9HnlnYfLnlKYy/ZE2Vb6fFqf/rrRhCNXMMDo54J6znrMqKbfaInvfw2lk7AhfNEoECm8qPRbs4o5ZyYBPotuIfivrvy3q0zt3cIVy+9KjO47Gsc1u/lrjgSN7qStVvCh7hgRTDkYnc7W60+fOYk6fUfieAFO+ewkWXMIC/VuVLldXkZgU5RzR8Gwx9iudJpHy/mgCvG0wIFjizL1+WxqIXeZNIXIbwQhyu4PCyYxDFixtb4OHifS0TRK/eOQ5Jx6/E0O8Ei8Ilrvgg9LtwkcElpg+TtQHL+ij0FsNwKQcuDcLiFKDdelgFebHL/gruvwWfs6q209x9INZynQSr7k6/fda383cVbMvDoTt03pXbU/vPh77Z75m97WQbd60/3AWrzd1KibWMk4eH1WYQbi+0fxh0jH9pBcNgtQkpwdARDJGgCFYbQQkKR1AgQRmsNpISlI6gRIIqWG0UJagcQYUEdbDaaEpQO4IaCZpgtTGUoHEEDRKMgtUmogQjRzBCgnGw2sSUYOwIxkgwCVabZCWjtYhDJJg4ggkGwPIQ3q2EWN8JTIDLTjiBp6WHxofgBwMUWixCEqHQZSjEEIUWjZDEKHQ5CjFIofJ22UUpxCyFlpCQxDB0cQoxT6GlJCRRDF2kQsxUaEkJzUpE60gYLOxiFWKuQktLSCIZumiFmK3QEhOSWIYuXiHmS7R8kWgKFzCBARMWGUEWNuECJiYVqi1RJJ2CKFIYMGGREXSBcwETGDBhmREkncIlTGDChGVGqJWU6yTE4yxcwgQmTBgvJMIlTGDChGVGaHKoXMIEJkxYZgRZLYVLmMCEicTfZ5cwgQmTlhlBsi1dwiQmTLaEkWxLlzCJCZPCG23pEiYn86D0RlsSUyEmTLaEJaTbLmESEya1r/5JFzCJAZMWGUlmpHQBkxgwaZGRZEZKFzCJAZOx12uXL4n5kpYYSWazdPmSmC/lnSGVi5fCeCkLjCQrgXLxUhgvJbxZoVy8FMZLtesser3k4qUmSy0LjCQnKkWstjBeyhIjyUqgXL4U5ku1fJHJrFy+FOZLtXyRyaxcvhTmS1lkJJlSygVMYcCURUaRaaFcwBQGTFtmFJkW2iVMY8K0ZUaRaGuXMI0J05YZReKpXcI0JkxL35pTu4BpDJhuF/MkndoFTE/W8xYZRa/oiSU9BkwbXzZrly+N+dKWGEWSrV2+NOZLW2IUSbZ2+dKYL93yRZKtXb405su0fJFkG5cvg/kylhhNkm1cvgzmy1hiNEm2cfkymC9jkdEk2cYFzGDAjPIuO40LmMGAGe8EaVy+zGTPaJHRZEoZYtuIATMWGU2mhXEBMxgwY5HRZFoYFzCDATOJt8suXwbzFVliNJkWkctXhPmKWr7ozbLLV4T5ilq+yLSIXL4izFfU8kWmReTyFWG+Iu8eMnLxijBekSXGkCkVuXxFmK+oPZQgUypy+Yom5xKWGEOmVEQcTWC+IkuMIcmOXL4izFfk5Sty+YowX7ElxpBZEbt8xZiv2BJjyKyIXb5izFdsiTEk2bHLV4z5ii0xhiQ7dvmKMV+xRcbEVP2KXcBiDFjsrV+xy1eM+YpbvsisiF2+YsxX3B58kWTHLl/x5Owr9u6mYuL4C/MVW2QiMi1iF7AYA5ZYZCJBLbQTF7AEA5ZYZCJJCruAJRiwxCITkWgnLmAJBiyR3oAlLmAJBixR/j67gCUYsMQyE5F718QlLMGEJcYfMJewBBOWtISRGZm4hCWYsMRPWOISlkxOWBN/wIhD1ukp6503Yt01LA7+1suH3nrQXZvKTw5b74Q36N21qXz3t/aWxeesarLdx+7WxWZzfjrjW/DY388I74a7LN+C8C64//Z9FYSq+5W6/427X9Vf16b7Nf11k3S/US8X9f+P2+vfx/sh7V/Pt0TsNet6/yLD6JMCPqmEr2N4VWHUpONRUyR4mo551r2FOqoRclQjFE+NfY0h719jQJ0Toy4dsnR17ycCdzRwJ+rHSLJUDa99A2Ug2ILnz3a4R9Y++DHcbh1VRmZUmURMld17UqMSqQAEzM4Nb4KD3oFoC7aW8e0woAn4I3rwRQ+64qHVfZTnOd1v+3dSQBqCLGTp6p6RBqQDRI3hqWjfUQIRT0DEY5aK4aUze4MVKAJ8Kl66POO8BUzeceXdoMKx52oZXtYBvQGRVbzBae/0Zv171MCfaNQkef16yRqfMlDaJM+t6aNwozIDhj7m0ZMXx/5ZEV8VAAmT8OLfP40OqAaVJOJFLC9af3xOAbJiXmnK67l6pwFohldkcl/UNKgEhhe1/pFXMJog/2IeGu3rR2CSAqRqXinonjYBkQZOJH29tGsjjq7zg8OgT4CmmKule3cABBd0K+IF5vwYC3AFZF6shp4x1dVoklOAb83D0T5gCYoT8EUxFQyvIQAtIC6Kl/7tW1Z0+dcgxwwvLN0z9SDEIKMiXrf69wCADpBJEa9T/VfoQGBAjeVrAI/CgnwA7sS8RW2rjFgrgFQIeUtsT7FRQJPmTdTj5/OAGkDPIiXElA2iJHjlDz7kBcINhi4JO9HEDMm6SPOEbtBbw0Oz17MvUe4b4GHEq7G9ogP4ihrAAugLebTihxRB8ED6Jf2mL+krXcJjd1D9Onz8BIwxWGxILjDdu42gt0CJ6F00TGUnnJhgGLjyRA3VYL4zvOF096sK4K95s9zw9gkAC0wqMY90tzSEQEnY7zFFnz9SdL9xfy6QyP6X2e3hq5ggeKDbS3S4BUSCyUfyqr675Ads9Ts8zUso8A1OMB4AjGVa3O4pkOSaO7ZWGzHCAPyQOXLjG36geyDiEXP0+u8XAmcAASEzSuPXQUc9cGm2TEtTEiEC6kJe3QNvZYEQgVDHPJLO389x9kQSFGfJdGpy6KdAvzRPxfABJuAHqFWSVzkn04wEmaF45JyqPVV7QcJGvPh+Pn/RwD3tA24JHkUTbXn7HQ0Qb1jfeB39kj29luUf1fnjCUAb6K3hTRL2o62eVQM8eeIt1q2yY/d1WKAHUBkyCtPDKjjmx2yfF1lwv3n4/v1vOY/qJzFbAAA="; \ No newline at end of file diff --git a/docs/reference/classes/ApiError.html b/docs/reference/classes/ApiError.html index 3c4e232..78109c0 100644 --- a/docs/reference/classes/ApiError.html +++ b/docs/reference/classes/ApiError.html @@ -1,4 +1,4 @@ -ApiError | @fal-ai/client

Class ApiError<Body>

Type Parameters

  • Body

Hierarchy (view full)

Constructors

constructor +ApiError | @fal-ai/client

Class ApiError<Body>

Type Parameters

  • Body

Hierarchy (view full)

Constructors

constructor

Properties

body status -

Constructors

constructor

Properties

Readonlybody

body: Body

Readonlystatus

status: number

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Readonlybody

body: Body

Readonlystatus

status: number

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/reference/classes/FalStream.html b/docs/reference/classes/FalStream.html index 25a7f73..da6aaaa 100644 --- a/docs/reference/classes/FalStream.html +++ b/docs/reference/classes/FalStream.html @@ -1,5 +1,5 @@ FalStream | @fal-ai/client

Class FalStream<Input, Output>

The class representing a streaming response. With t

-

Type Parameters

  • Input
  • Output

Constructors

constructor +

Type Parameters

  • Input
  • Output

Constructors

constructor

Properties

config endpointId options @@ -9,16 +9,18 @@ abort done on -

Constructors

constructor

Properties

config

config: Required<Config>

endpointId

endpointId: string

options

options: StreamOptions<Input>

url

url: string

Accessors

signal

  • get signal(): AbortSignal

  • Gets the AbortSignal instance that can be used to listen for abort events.

    +

Constructors

constructor

Properties

config

config: Required<Config>

endpointId

endpointId: string

options

options: StreamOptions<Input>

url

url: string

Accessors

signal

Methods

[asyncIterator]

abort

Methods

[asyncIterator]

abort

  • abort(reason?): void

  • Aborts the streaming request.

    Note: This method is noop in case the request is already done.

    Parameters

    • Optionalreason: string | Error

      optional cause for aborting the request.

      -

    Returns void

done

  • done(): Promise<Output>

  • Gets a reference to the Promise that indicates whether the streaming +

Returns void

done

on

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

on

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/reference/classes/ValidationError.html b/docs/reference/classes/ValidationError.html index cd3bb5a..886a5f6 100644 --- a/docs/reference/classes/ValidationError.html +++ b/docs/reference/classes/ValidationError.html @@ -1,6 +1,6 @@ -ValidationError | @fal-ai/client

Class ValidationError

Hierarchy (view full)

  • ApiError<ValidationErrorBody>
    • ValidationError

Constructors

constructor +ValidationError | @fal-ai/client

Class ValidationError

Hierarchy (view full)

  • ApiError<ValidationErrorBody>
    • ValidationError

Constructors

constructor

Properties

body status

Accessors

fieldErrors

Methods

getFieldErrors -

Constructors

constructor

Properties

Readonlybody

body: ValidationErrorBody

Readonlystatus

status: number

Accessors

fieldErrors

Methods

getFieldErrors

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Constructors

constructor

Properties

Readonlybody

body: ValidationErrorBody

Readonlystatus

status: number

Accessors

fieldErrors

Methods

getFieldErrors

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/reference/functions/createFalClient.html b/docs/reference/functions/createFalClient.html index b4b3915..f82a8d9 100644 --- a/docs/reference/functions/createFalClient.html +++ b/docs/reference/functions/createFalClient.html @@ -1,4 +1,4 @@ createFalClient | @fal-ai/client

Function createFalClient

  • createFalClient(userConfig?): FalClient

  • Creates a new reference of the FalClient.

    Parameters

    • userConfig: Config = {}

      Optional configuration to override the default settings.

    Returns FalClient

    a new instance of the FalClient.

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/reference/functions/isCompletedQueueStatus.html b/docs/reference/functions/isCompletedQueueStatus.html index a5dfc4f..b017fb4 100644 --- a/docs/reference/functions/isCompletedQueueStatus.html +++ b/docs/reference/functions/isCompletedQueueStatus.html @@ -1 +1 @@ -isCompletedQueueStatus | @fal-ai/client

Function isCompletedQueueStatus

Settings

Member Visibility
+isCompletedQueueStatus | @fal-ai/client

Function isCompletedQueueStatus

Settings

Member Visibility
diff --git a/docs/reference/functions/isQueueStatus.html b/docs/reference/functions/isQueueStatus.html index f0e801f..14446b1 100644 --- a/docs/reference/functions/isQueueStatus.html +++ b/docs/reference/functions/isQueueStatus.html @@ -1 +1 @@ -isQueueStatus | @fal-ai/client

Function isQueueStatus

Settings

Member Visibility
+isQueueStatus | @fal-ai/client

Function isQueueStatus

Settings

Member Visibility
diff --git a/docs/reference/functions/parseEndpointId.html b/docs/reference/functions/parseEndpointId.html index 5c38a2c..45903b6 100644 --- a/docs/reference/functions/parseEndpointId.html +++ b/docs/reference/functions/parseEndpointId.html @@ -1 +1 @@ -parseEndpointId | @fal-ai/client

Function parseEndpointId

  • parseEndpointId(id): EndpointId

  • Parameters

    • id: string

    Returns EndpointId

Settings

Member Visibility
+parseEndpointId | @fal-ai/client

Function parseEndpointId

  • parseEndpointId(id): EndpointId

  • Parameters

    • id: string

    Returns EndpointId

Settings

Member Visibility
diff --git a/docs/reference/functions/withMiddleware.html b/docs/reference/functions/withMiddleware.html index 720f734..bdb5588 100644 --- a/docs/reference/functions/withMiddleware.html +++ b/docs/reference/functions/withMiddleware.html @@ -1,4 +1,4 @@ withMiddleware | @fal-ai/client

Function withMiddleware

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/reference/functions/withProxy.html b/docs/reference/functions/withProxy.html index 7ba52c4..23068e1 100644 --- a/docs/reference/functions/withProxy.html +++ b/docs/reference/functions/withProxy.html @@ -1 +1 @@ -withProxy | @fal-ai/client

Function withProxy

Settings

Member Visibility
+withProxy | @fal-ai/client

Function withProxy

Settings

Member Visibility
diff --git a/docs/reference/interfaces/CompletedQueueStatus.html b/docs/reference/interfaces/CompletedQueueStatus.html index b1e2156..591920d 100644 --- a/docs/reference/interfaces/CompletedQueueStatus.html +++ b/docs/reference/interfaces/CompletedQueueStatus.html @@ -1,6 +1,6 @@ -CompletedQueueStatus | @fal-ai/client

Interface CompletedQueueStatus

interface CompletedQueueStatus {
    logs: RequestLog[];
    metrics?: Metrics;
    request_id: string;
    response_url: string;
    status: "COMPLETED";
}

Hierarchy

  • BaseQueueStatus
    • CompletedQueueStatus

Properties

logs +CompletedQueueStatus | @fal-ai/client

Interface CompletedQueueStatus

interface CompletedQueueStatus {
    logs: RequestLog[];
    metrics?: Metrics;
    request_id: string;
    response_url: string;
    status: "COMPLETED";
}

Hierarchy

  • BaseQueueStatus
    • CompletedQueueStatus

Properties

logs metrics? request_id response_url status -

Properties

logs

logs: RequestLog[]

Optionalmetrics

metrics?: Metrics

request_id

request_id: string

response_url

response_url: string

status

status: "COMPLETED"

Settings

Member Visibility

On This Page

Properties
+

Properties

logs

logs: RequestLog[]

Optionalmetrics

metrics?: Metrics

request_id

request_id: string

response_url

response_url: string

status

status: "COMPLETED"

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/FalClient.html b/docs/reference/interfaces/FalClient.html index 9a658e2..58461e3 100644 --- a/docs/reference/interfaces/FalClient.html +++ b/docs/reference/interfaces/FalClient.html @@ -1,7 +1,7 @@ FalClient | @fal-ai/client

Interface FalClient

The main client type, it provides access to simple API model usage, as well as access to the queue and storage APIs.

See

createFalClient

-
interface FalClient {
    queue: QueueClient;
    realtime: RealtimeClient;
    storage: StorageClient;
    stream: (<Id>(endpointId: Id, options: StreamOptions<InputType<Id>>) => Promise<FalStream<InputType<Id>, OutputType<Id>>>);
    streaming: StreamingClient;
    run<Id>(endpointId: Id, options: RunOptions<InputType<Id>>): Promise<Result<OutputType<Id>>>;
    subscribe<Id>(endpointId: Id, options: RunOptions<InputType<Id>> & QueueSubscribeOptions): Promise<Result<OutputType<Id>>>;
}

Properties

queue +
interface FalClient {
    queue: QueueClient;
    realtime: RealtimeClient;
    storage: StorageClient;
    stream: (<Id>(endpointId: Id, options: StreamOptions<InputType<Id>>) => Promise<FalStream<InputType<Id>, OutputType<Id>>>);
    streaming: StreamingClient;
    run<Id>(endpointId: Id, options: RunOptions<InputType<Id>>): Promise<Result<OutputType<Id>>>;
    subscribe<Id>(endpointId: Id, options: RunOptions<InputType<Id>> & QueueSubscribeOptions): Promise<Result<OutputType<Id>>>;
}

Properties

queue realtime storage stream @@ -9,14 +9,14 @@ as well as access to the queue and storage APIs.

Methods

run subscribe

Properties

Readonlyqueue

queue: QueueClient

The queue client to interact with the queue API.

-

Readonlyrealtime

realtime: RealtimeClient

The realtime client to interact with the realtime API +

Readonlyrealtime

realtime: RealtimeClient

The realtime client to interact with the realtime API and receive updates in real-time.

See

  • #RealtimeClient
  • #RealtimeClient.connect
-

Readonlystorage

storage: StorageClient

The storage client to interact with the storage API.

-

stream

stream: (<Id>(endpointId: Id, options: StreamOptions<InputType<Id>>) => Promise<FalStream<InputType<Id>, OutputType<Id>>>)

Calls a fal app that supports streaming and provides a streaming-capable +

Readonlystorage

storage: StorageClient

The storage client to interact with the storage API.

+

stream

stream: (<Id>(endpointId: Id, options: StreamOptions<InputType<Id>>) => Promise<FalStream<InputType<Id>, OutputType<Id>>>)

Calls a fal app that supports streaming and provides a streaming-capable object as a result, that can be used to get partial results through either AsyncIterator or through an event listener.

Type declaration

    • <Id>(endpointId, options): Promise<FalStream<InputType<Id>, OutputType<Id>>>

    • Calls a fal app that supports streaming and provides a streaming-capable @@ -28,13 +28,13 @@ object as a result, that can be used to get partial results through either

Param: endpointId

the endpoint id, e.g. fal-ai/llavav15-13b.

Param: options

the request options, including the input payload.

Returns

the FalStream instance.

-

Readonlystreaming

streaming: StreamingClient

The streaming client to interact with the streaming API.

+

Readonlystreaming

streaming: StreamingClient

The streaming client to interact with the streaming API.

See

#stream

-

Methods

run

Methods

run

  • run<Id>(endpointId, options): Promise<Result<OutputType<Id>>>

  • Runs a fal endpoints identified by its endpointId.

    Type Parameters

    • Id extends EndpointType

    Parameters

    • endpointId: Id

      the registered function revision id or alias.

    • options: RunOptions<InputType<Id>>

    Returns Promise<Result<OutputType<Id>>>

    the remote function output

    -

subscribe

  • subscribe<Id>(endpointId, options): Promise<Result<OutputType<Id>>>

  • Subscribes to updates for a specific request in the queue.

    +

subscribe

  • subscribe<Id>(endpointId, options): Promise<Result<OutputType<Id>>>

  • Subscribes to updates for a specific request in the queue.

    Type Parameters

    • Id extends EndpointType

    Parameters

    • endpointId: Id

      The ID of the API endpoint.

    • options: RunOptions<InputType<Id>> & QueueSubscribeOptions

      Options to configure how the request is run and how updates are received.

    Returns Promise<Result<OutputType<Id>>>

    A promise that resolves to the result of the request once it's completed.

    -

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/reference/interfaces/InProgressQueueStatus.html b/docs/reference/interfaces/InProgressQueueStatus.html index 8542465..08af9bf 100644 --- a/docs/reference/interfaces/InProgressQueueStatus.html +++ b/docs/reference/interfaces/InProgressQueueStatus.html @@ -1,5 +1,5 @@ -InProgressQueueStatus | @fal-ai/client

Interface InProgressQueueStatus

interface InProgressQueueStatus {
    logs: RequestLog[];
    request_id: string;
    response_url: string;
    status: "IN_PROGRESS";
}

Hierarchy

  • BaseQueueStatus
    • InProgressQueueStatus

Properties

logs +InProgressQueueStatus | @fal-ai/client

Interface InProgressQueueStatus

interface InProgressQueueStatus {
    logs: RequestLog[];
    request_id: string;
    response_url: string;
    status: "IN_PROGRESS";
}

Hierarchy

  • BaseQueueStatus
    • InProgressQueueStatus

Properties

logs request_id response_url status -

Properties

logs

logs: RequestLog[]

request_id

request_id: string

response_url

response_url: string

status

status: "IN_PROGRESS"

Settings

Member Visibility

On This Page

Properties
+

Properties

logs

logs: RequestLog[]

request_id

request_id: string

response_url

response_url: string

status

status: "IN_PROGRESS"

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/InQueueQueueStatus.html b/docs/reference/interfaces/InQueueQueueStatus.html index afa5f4d..71562b7 100644 --- a/docs/reference/interfaces/InQueueQueueStatus.html +++ b/docs/reference/interfaces/InQueueQueueStatus.html @@ -1,5 +1,5 @@ -InQueueQueueStatus | @fal-ai/client

Interface InQueueQueueStatus

interface InQueueQueueStatus {
    queue_position: number;
    request_id: string;
    response_url: string;
    status: "IN_QUEUE";
}

Hierarchy

  • BaseQueueStatus
    • InQueueQueueStatus

Properties

queue_position +InQueueQueueStatus | @fal-ai/client

Interface InQueueQueueStatus

interface InQueueQueueStatus {
    queue_position: number;
    request_id: string;
    response_url: string;
    status: "IN_QUEUE";
}

Hierarchy

  • BaseQueueStatus
    • InQueueQueueStatus

Properties

queue_position request_id response_url status -

Properties

queue_position

queue_position: number

request_id

request_id: string

response_url

response_url: string

status

status: "IN_QUEUE"

Settings

Member Visibility

On This Page

Properties
+

Properties

queue_position

queue_position: number

request_id

request_id: string

response_url

response_url: string

status

status: "IN_QUEUE"

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/QueueClient.html b/docs/reference/interfaces/QueueClient.html index 25d79fa..a30ed77 100644 --- a/docs/reference/interfaces/QueueClient.html +++ b/docs/reference/interfaces/QueueClient.html @@ -1,6 +1,6 @@ QueueClient | @fal-ai/client

Interface QueueClient

Represents a request queue with methods for submitting requests, checking their status, retrieving results, and subscribing to updates.

-
interface QueueClient {
    cancel(endpointId: string, options: BaseQueueOptions): Promise<void>;
    result<Id>(endpointId: Id, options: BaseQueueOptions): Promise<Result<any>>;
    status(endpointId: string, options: QueueStatusOptions): Promise<QueueStatus>;
    streamStatus(endpointId: string, options: QueueStatusStreamOptions): Promise<FalStream<unknown, QueueStatus>>;
    submit<Id>(endpointId: Id, options: SubmitOptions<InputType<Id>>): Promise<InQueueQueueStatus>;
    subscribeToStatus(endpointId: string, options: QueueStatusSubscriptionOptions): Promise<CompletedQueueStatus>;
}

Methods

cancel +
interface QueueClient {
    cancel(endpointId: string, options: BaseQueueOptions): Promise<void>;
    result<Id>(endpointId: Id, options: BaseQueueOptions): Promise<Result<any>>;
    status(endpointId: string, options: QueueStatusOptions): Promise<QueueStatus>;
    streamStatus(endpointId: string, options: QueueStatusStreamOptions): Promise<FalStream<unknown, QueueStatus>>;
    submit<Id>(endpointId: Id, options: SubmitOptions<InputType<Id>>): Promise<InQueueQueueStatus>;
    subscribeToStatus(endpointId: string, options: QueueStatusSubscriptionOptions): Promise<CompletedQueueStatus>;
}

Methods

cancel result status streamStatus @@ -12,25 +12,25 @@ checking their status, retrieving results, and subscribing to updates.

is run and how updates are received.

Returns Promise<void>

A promise that resolves once the request is cancelled.

Throws

If the request cannot be cancelled.

-

result

  • result<Id>(endpointId, options): Promise<Result<any>>

  • Retrieves the result of a specific request from the queue.

    +

result

  • result<Id>(endpointId, options): Promise<Result<any>>

  • Retrieves the result of a specific request from the queue.

    Type Parameters

    • Id extends EndpointType

    Parameters

    • endpointId: Id

      The ID of the function web endpoint.

    • options: BaseQueueOptions

      Options to configure how the request is run.

    Returns Promise<Result<any>>

    A promise that resolves to the result of the request.

    -

status

status

  • status(endpointId, options): Promise<QueueStatus>

  • Retrieves the status of a specific request in the queue.

    Parameters

    • endpointId: string

      The ID of the function web endpoint.

    • options: QueueStatusOptions

      Options to configure how the request is run.

    Returns Promise<QueueStatus>

    A promise that resolves to the status of the request.

    -

streamStatus

streamStatus

  • streamStatus(endpointId, options): Promise<FalStream<unknown, QueueStatus>>

  • Subscribes to updates for a specific request in the queue using HTTP streaming events.

    Parameters

    • endpointId: string

      The ID of the function web endpoint.

    • options: QueueStatusStreamOptions

      Options to configure how the request is run and how updates are received.

    Returns Promise<FalStream<unknown, QueueStatus>>

    The streaming object that can be used to listen for updates.

    -

submit

submit

  • submit<Id>(endpointId, options): Promise<InQueueQueueStatus>

  • Submits a request to the queue.

    Type Parameters

    • Id extends EndpointType

    Parameters

    • endpointId: Id

      The ID of the function web endpoint.

    • options: SubmitOptions<InputType<Id>>

      Options to configure how the request is run.

    Returns Promise<InQueueQueueStatus>

    A promise that resolves to the result of enqueuing the request.

    -

subscribeToStatus

subscribeToStatus

  • subscribeToStatus(endpointId, options): Promise<CompletedQueueStatus>

  • Subscribes to updates for a specific request in the queue using polling or streaming. See options.mode for more details.

    Parameters

    • endpointId: string

      The ID of the function web endpoint.

    • options: QueueStatusSubscriptionOptions

      Options to configure how the request is run and how updates are received.

    Returns Promise<CompletedQueueStatus>

    A promise that resolves to the final status of the request.

    -

Settings

Member Visibility

On This Page

Methods
+

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/reference/interfaces/RealtimeClient.html b/docs/reference/interfaces/RealtimeClient.html index 7add32e..f34c463 100644 --- a/docs/reference/interfaces/RealtimeClient.html +++ b/docs/reference/interfaces/RealtimeClient.html @@ -1,6 +1,6 @@ -RealtimeClient | @fal-ai/client

Interface RealtimeClient

interface RealtimeClient {
    connect<Input, Output>(app: string, handler: RealtimeConnectionHandler<Output>): RealtimeConnection<Input>;
}

Methods

connect +RealtimeClient | @fal-ai/client

Interface RealtimeClient

interface RealtimeClient {
    connect<Input, Output>(app: string, handler: RealtimeConnectionHandler<Output>): RealtimeConnection<Input>;
}

Methods

connect

Methods

connect

  • connect<Input, Output>(app, handler): RealtimeConnection<Input>

  • Connect to the realtime endpoint. The default implementation uses WebSockets to connect to fal function endpoints that support WSS.

    Type Parameters

    • Input = any
    • Output = any

    Parameters

    • app: string

      the app alias or identifier.

    • handler: RealtimeConnectionHandler<Output>

      the connection handler.

      -

    Returns RealtimeConnection<Input>

Settings

Member Visibility

On This Page

Methods
+

Returns RealtimeConnection<Input>

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/reference/interfaces/StorageClient.html b/docs/reference/interfaces/StorageClient.html index 7df7e7c..15644a9 100644 --- a/docs/reference/interfaces/StorageClient.html +++ b/docs/reference/interfaces/StorageClient.html @@ -1,14 +1,14 @@ StorageClient | @fal-ai/client

Interface StorageClient

File support for the client. This interface establishes the contract for uploading files to the server and transforming the input to replace file objects with URLs.

-
interface StorageClient {
    transformInput: ((input: Record<string, any>) => Promise<Record<string, any>>);
    upload: ((file: Blob) => Promise<string>);
}

Properties

transformInput +
interface StorageClient {
    transformInput: ((input: Record<string, any>) => Promise<Record<string, any>>);
    upload: ((file: Blob) => Promise<string>);
}

Properties

transformInput upload

Properties

transformInput

transformInput: ((input: Record<string, any>) => Promise<Record<string, any>>)

Transform the input to replace file objects with URLs. This is used to transform the input before sending it to the server and ensures that the server receives URLs instead of file objects.

Type declaration

upload

upload: ((file: Blob) => Promise<string>)

Upload a file to the server. Returns the URL of the uploaded file.

+

upload

upload: ((file: Blob) => Promise<string>)

Upload a file to the server. Returns the URL of the uploaded file.

Type declaration

    • (file): Promise<string>

    • Parameters

      • file: Blob

        the file to upload

      Returns Promise<string>

      the URL of the uploaded file

      -

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/StreamingClient.html b/docs/reference/interfaces/StreamingClient.html index e7b176f..5224458 100644 --- a/docs/reference/interfaces/StreamingClient.html +++ b/docs/reference/interfaces/StreamingClient.html @@ -1,9 +1,9 @@ StreamingClient | @fal-ai/client

Interface StreamingClient

The streaming client interface.

-
interface StreamingClient {
    stream<Id>(endpointId: Id, options: StreamOptions<InputType<Id>>): Promise<FalStream<InputType<Id>, OutputType<Id>>>;
}

Methods

stream +
interface StreamingClient {
    stream<Id>(endpointId: Id, options: StreamOptions<InputType<Id>>): Promise<FalStream<InputType<Id>, OutputType<Id>>>;
}

Methods

stream

Methods

stream

  • stream<Id>(endpointId, options): Promise<FalStream<InputType<Id>, OutputType<Id>>>

  • Calls a fal app that supports streaming and provides a streaming-capable object as a result, that can be used to get partial results through either AsyncIterator or through an event listener.

    Type Parameters

    • Id extends EndpointType

    Parameters

    • endpointId: Id

      the endpoint id, e.g. fal-ai/llavav15-13b.

    • options: StreamOptions<InputType<Id>>

      the request options, including the input payload.

    Returns Promise<FalStream<InputType<Id>, OutputType<Id>>>

    the FalStream instance.

    -

Settings

Member Visibility

On This Page

Methods
+

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/reference/types/Metrics.html b/docs/reference/types/Metrics.html index 960f373..760d0a3 100644 --- a/docs/reference/types/Metrics.html +++ b/docs/reference/types/Metrics.html @@ -1 +1 @@ -Metrics | @fal-ai/client

Type Alias Metrics

Metrics: {
    inference_time: number | null;
}

Settings

Member Visibility
+Metrics | @fal-ai/client

Type Alias Metrics

Metrics: {
    inference_time: number | null;
}

Settings

Member Visibility
diff --git a/docs/reference/types/QueueStatus.html b/docs/reference/types/QueueStatus.html index e8f5a80..462a163 100644 --- a/docs/reference/types/QueueStatus.html +++ b/docs/reference/types/QueueStatus.html @@ -1 +1 @@ -QueueStatus | @fal-ai/client

Type Alias QueueStatus

QueueStatus: InProgressQueueStatus | CompletedQueueStatus | InQueueQueueStatus

Settings

Member Visibility
+QueueStatus | @fal-ai/client

Type Alias QueueStatus

QueueStatus: InProgressQueueStatus | CompletedQueueStatus | InQueueQueueStatus

Settings

Member Visibility
diff --git a/docs/reference/types/RequestLog.html b/docs/reference/types/RequestLog.html index 8df4036..6dcd2e9 100644 --- a/docs/reference/types/RequestLog.html +++ b/docs/reference/types/RequestLog.html @@ -1 +1 @@ -RequestLog | @fal-ai/client

Type Alias RequestLog

RequestLog: {
    level:
        | "STDERR"
        | "STDOUT"
        | "ERROR"
        | "INFO"
        | "WARN"
        | "DEBUG";
    message: string;
    source: "USER";
    timestamp: string;
}

Settings

Member Visibility
+RequestLog | @fal-ai/client

Type Alias RequestLog

RequestLog: {
    level:
        | "STDERR"
        | "STDOUT"
        | "ERROR"
        | "INFO"
        | "WARN"
        | "DEBUG";
    message: string;
    source: "USER";
    timestamp: string;
}

Settings

Member Visibility
diff --git a/docs/reference/types/RequestMiddleware.html b/docs/reference/types/RequestMiddleware.html index 3a2b0a9..da157e0 100644 --- a/docs/reference/types/RequestMiddleware.html +++ b/docs/reference/types/RequestMiddleware.html @@ -1 +1 @@ -RequestMiddleware | @fal-ai/client

Type Alias RequestMiddleware

RequestMiddleware: ((request: RequestConfig) => Promise<RequestConfig>)

Settings

Member Visibility
+RequestMiddleware | @fal-ai/client

Type Alias RequestMiddleware

RequestMiddleware: ((request: RequestConfig) => Promise<RequestConfig>)

Settings

Member Visibility
diff --git a/docs/reference/types/ResponseHandler.html b/docs/reference/types/ResponseHandler.html index aa911e3..78595ab 100644 --- a/docs/reference/types/ResponseHandler.html +++ b/docs/reference/types/ResponseHandler.html @@ -1 +1 @@ -ResponseHandler | @fal-ai/client

Type Alias ResponseHandler<Output>

ResponseHandler<Output>: ((response: Response) => Promise<Output>)

Type Parameters

  • Output

Settings

Member Visibility
+ResponseHandler | @fal-ai/client

Type Alias ResponseHandler<Output>

ResponseHandler<Output>: ((response: Response) => Promise<Output>)

Type Parameters

  • Output

Settings

Member Visibility
diff --git a/docs/reference/types/Result.html b/docs/reference/types/Result.html index 2bb0300..7427fd2 100644 --- a/docs/reference/types/Result.html +++ b/docs/reference/types/Result.html @@ -1,3 +1,3 @@ Result | @fal-ai/client

Type Alias Result<T>

Result<T>: {
    data: T;
    requestId: string;
}

Represents an API result, containing the data, the request ID and any other relevant information.

-

Type Parameters

  • T

Settings

Member Visibility
+

Type Parameters

Settings

Member Visibility
diff --git a/docs/reference/types/RunOptions.html b/docs/reference/types/RunOptions.html index 46eb0fa..1d63f94 100644 --- a/docs/reference/types/RunOptions.html +++ b/docs/reference/types/RunOptions.html @@ -1,6 +1,7 @@ -RunOptions | @fal-ai/client

Type Alias RunOptions<Input>

RunOptions<Input>: {
    input?: Input;
    method?:
        | "get"
        | "post"
        | "put"
        | "delete"
        | string;
}

The function input and other configuration when running +RunOptions | @fal-ai/client

Type Alias RunOptions<Input>

RunOptions<Input>: {
    abortSignal?: AbortSignal;
    input?: Input;
    method?:
        | "get"
        | "post"
        | "put"
        | "delete"
        | string;
}

The function input and other configuration when running the function, such as the HTTP method to use.

-

Type Parameters

  • Input

Type declaration

  • Optional Readonlyinput?: Input

    The function input. It will be submitted either as query params +

    Type Parameters

    • Input

    Type declaration

    • Optional ReadonlyabortSignal?: AbortSignal

      The abort signal to cancel the request.

      +
    • Optional Readonlyinput?: Input

      The function input. It will be submitted either as query params or the body payload, depending on the method.

    • Optional Readonlymethod?:
          | "get"
          | "post"
          | "put"
          | "delete"
          | string

      The HTTP method, defaults to post;

      -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/reference/types/UrlOptions.html b/docs/reference/types/UrlOptions.html index 603ae9c..b9b5901 100644 --- a/docs/reference/types/UrlOptions.html +++ b/docs/reference/types/UrlOptions.html @@ -3,4 +3,4 @@
  • Optional Readonlysubdomain?: string

    If true, the function will use the queue to run the function asynchronously and return the result in a separate call. This influences how the URL is built.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/reference/types/ValidationErrorInfo.html b/docs/reference/types/ValidationErrorInfo.html index 2420031..1103224 100644 --- a/docs/reference/types/ValidationErrorInfo.html +++ b/docs/reference/types/ValidationErrorInfo.html @@ -1 +1 @@ -ValidationErrorInfo | @fal-ai/client

    Type Alias ValidationErrorInfo

    ValidationErrorInfo: {
        loc: (string | number)[];
        msg: string;
        type: string;
    }

    Settings

    Member Visibility
    +ValidationErrorInfo | @fal-ai/client

    Type Alias ValidationErrorInfo

    ValidationErrorInfo: {
        loc: (string | number)[];
        msg: string;
        type: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/reference/types/WebHookResponse.html b/docs/reference/types/WebHookResponse.html index d0bae15..29be8c6 100644 --- a/docs/reference/types/WebHookResponse.html +++ b/docs/reference/types/WebHookResponse.html @@ -10,4 +10,4 @@ allowing for flexibility in specifying the structure of the payload.

  • payload: Payload

    The payload of the response, structure determined by the Payload type.

  • request_id: string

    The unique identifier for the request.

  • status: "ERROR"

    Indicates an unsuccessful response.

    -

    • Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/reference/variables/fal.html b/docs/reference/variables/fal.html index 46e85a9..6dac02b 100644 --- a/docs/reference/variables/fal.html +++ b/docs/reference/variables/fal.html @@ -1,3 +1,3 @@ fal | @fal-ai/client

    Variable falConst

    fal: SingletonFalClient = ...

    Creates a singleton instance of the client. This is useful as a compatibility layer for existing code that uses the clients version prior to 1.0.0.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/libs/client/package.json b/libs/client/package.json index d13b58b..1818bcc 100644 --- a/libs/client/package.json +++ b/libs/client/package.json @@ -1,7 +1,7 @@ { "name": "@fal-ai/client", "description": "The fal.ai client for JavaScript and TypeScript", - "version": "1.2.0-alpha.6", + "version": "1.2.0", "license": "MIT", "repository": { "type": "git",