Agent: document partial results on credit-limit stops

[rakshith48]

Merge only after firecrawl/firecrawl#4812 is deployed. Until then the public status endpoint and SDKs don't return these fields.

Source PRs:

• Agent: expose incomplete results in status and threads firecrawl#4812: status and thread responses, JS and Python SDK types
• firecrawl/extract-v3#186: stores the partial and restores it on thread follow-ups
• firecrawl/extract-v3#187: recovers the partial at the credit limit, adds the fields to agent.failed webhooks

What changed

• Agent guide (features/agent.mdx): new "Handling credit-limit stops" section. It explains that a run that hits maxCredits reports status: "failed" with stopReason: "credit_limit_reached". data is still only set on completed runs. The run may carry a best-effort partial, partialSchemaValid (only when a schema was sent) and message. Users should check stopReason rather than the error text, treat partial with care, and continue the thread with a follow-up to finish the work. Includes Python, Node and cURL samples, an example response, and short notes on the thread endpoint and the webhook. The failed state row and the maxCredits parameter row now point to this section.
• API reference: GET /agent/{jobId} in v2-openapi.json gains partial, partialSchemaValid, stopReason and message. The agent.failed data entry in webhooks-openapi.json gains the same four fields.
• Errors page, webhook events page, Node and Python SDK pages: one or two sentences each, linking to the new section.
• No localized files touched.

The docs say these fields "may be present". Credit-limit recovery is behind a server flag that starts off, so not every credit stop returns a partial.

Checks

• scripts/check-extraction-hostile-markdown.sh passes.
• scripts/check-locale-api-literals.sh has the same 15 findings as main, so this PR adds none. A JSON code example for the webhook was left out on purpose, because it would have added findings to every localized webhooks/events.mdx until the next translation sync.
• Both OpenAPI files pass swagger-cli validate.

🤖 Generated with Claude Code

[mintlify]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated
firecrawl	🟢 Ready	View Preview	Oct 2, 2026, 2:19 PM

💡 Tip: Enable Automations to automatically generate PRs for you.