Skip to content

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

docs(php-sdk): clarify success=false envelope is intentional API design

Kris Oei70788bbbb1ef
diff --git a/apps/php-sdk/src/Client/FirecrawlClient.php b/apps/php-sdk/src/Client/FirecrawlClient.php
index 251e65752..c33496656 100644
--- a/apps/php-sdk/src/Client/FirecrawlClient.php
+++ b/apps/php-sdk/src/Client/FirecrawlClient.php
@@ -730,9 +730,10 @@ final class FirecrawlClient
}
/**
- * The API reports some failures (for example DNS resolution errors) as
- * HTTP 200 with a `success: false` body, verified against production, so
- * status-code handling alone is not enough to detect them.
+ * The API intentionally reports some failures (for example DNS resolution
+ * errors) as HTTP 200 with a `success: false` body, so for those the flag,
+ * not the status code, is the error signal. The Python and JS SDKs raise
+ * on it the same way.
*
* @param array<string, mixed> $response
* @return array<string, mixed> the same response, if it does not signal failure