Web and news · Firecrawl

web.read

Scrapes a single page and returns its main content as markdown (or plain text), truncated to max_chars. One record per call.

Operation: POST /v1/capabilities/web.read/execute
operationId: executeWebRead
Typical credits: 5
Search deadline: 15 s server-side
Paging: single result
Availability: ConfiguredChecked 2026-09-23 21:02 UTC

Cost basis: $0.005 per scrape. Availability is reported per deployment by GET /v1/catalog (available). The timestamped snapshot describes configuration, not provider uptime or your account's enabled choices. Check the catalog with your own key before a call. Credits are explained under credits and limits.

Request

Body of POST /v1/capabilities/web.read/execute, JSON, validated against the WebReadRequest component of the public OpenAPI document. Defaults are applied server-side, so an omitted optional field behaves exactly as its default.

Request fields of web.read
Field	Type	Required	Default	Constraints and description
url	string (uri)	yes		min length 1, format uri
format	"markdown" \| "text"	no	"markdown"
max_chars	integer	no	20000	min 500, max 200000 Truncate the page content to this many characters.

Unknown keys are rejected with 400 invalid_request.

Examples

Read a docs page

curl

curl -s -X POST https://api.powerups-ai.store/v1/capabilities/web.read/execute \
  -H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
  -d '{"url":"https://fastify.dev/docs/latest/","max_chars":8000}'

No recorded response is published for this capability yet. The envelope is the ExecuteResponse component (see sessions and records); the record keys below are what the adapter emits. A first call with the example above returns search_id, the records and the charge.

Result record

Every item in results[] carries record_id and title (contract, always present) and usually url and snippet. The keys below are the documented tier: produced deterministically by this capability, omitted when the source has no value, checked against recorded source fixtures in our test suite, and published as the WebReadRecord component (all optional, extra keys allowed) so generated clients type them. The wire schema itself still validates only the base keys. See stability tiers.

Record keys of web.read
Key	Type	Presence	Note
content	string	always	Markdown or plain text, truncated to `max_chars`.
chars	integer	always
truncated	boolean	always
format	"markdown" \| "text"	always

Follow-ups

Paging: Single result; more is refused with 400 invalid_request.
Update: not offered.
Record actions: none.
Detail behaviour: No record actions.

Record detail objects of this capability are provider-shaped: documented by observation, not by schema. Full follow-up semantics: follow-up.

Typed client

With types generated from the public document (see types, client and samples) the call is path-keyed and the body is checked at compile time:

TypeScript (openapi-fetch)

const { data, error } = await client.POST("/v1/capabilities/web.read/execute", {
  body: {
    "url": "https://fastify.dev/docs/latest/",
    "max_chars": 8000
  },
});
if (error) throw new Error(`${error.error.code}: ${error.error.message}`);
for (const record of data.results) console.log(record.record_id, record.title);