Skip to content

Supercharge your AI agents with data from the web and beyond. Building the library for superintelligence. 🔥

docs(php-sdk): note why assertSuccess covers only synchronous endpoints

Kris Oei82d74eb5415d
diff --git a/apps/php-sdk/src/Client/FirecrawlClient.php b/apps/php-sdk/src/Client/FirecrawlClient.php
index a0da68063..9437701d3 100644
--- a/apps/php-sdk/src/Client/FirecrawlClient.php
+++ b/apps/php-sdk/src/Client/FirecrawlClient.php
@@ -746,6 +746,11 @@ final class FirecrawlClient
* with a `success: false` body; the flag, not the status code, is the
* error signal for those.
*
+ * Only the synchronous endpoints (scrape, search, map) run this check.
+ * Async crawl responses skip it deliberately: a failed start yields a
+ * null job ID that callers guard (pollCrawl() throws on it), and status
+ * polling exposes `status` explicitly on CrawlJob.
+ *
* @param array<string, mixed> $response
* @return array<string, mixed> the same response, if it does not signal failure
*/