AGagentkey
web

Fetch one web page and return its readable text (markdown or plain text) with title and basic metadata.

Fetches a single URL through a scraping provider and returns the main content as markdown (default) or plain text, plus title, description, language, publish time and the target's HTTP status where the provider reports them. format=text routes to a provider that can deliver plain text.

Fixed price: 0.2 credits per successful call, whichever provider serves it. When firecrawl serves the call the fixed price is the floor: the provider meters the actual cost (per page / per document) and credits_charged reports it; describe carries the provider's note.

post/v2/ops/web.scrape

Request

  • Base URL
    https://api.agentkey.app
  • URL
    https://api.agentkey.app/v2/ops/web.scrape
  • Auth
    HTTP bearer

Request body

fieldsstring[]

Projection: keep only these dotted paths of data, e.g. ["items.id", "items.text"].

format'markdown' | 'text'

Format of the returned text. markdown keeps headings, lists and links; text is plain text.

include_rawboolean

Attach the raw upstream payload as raw (not a stable contract; truncated above 256 KB).

providerstring

Shorthand for routing.only = [provider].

urlstring required

Absolute http(s) URL to fetch.

Response

Success envelope

credits_chargednumber required

Credits charged for this call (the method's fixed price).

opstring required

Method name.

op_versioninteger required

Method version that served the call.

providerstring required

Provider that actually served the call.

rawunknown
raw_truncatedboolean
request_idstring required

Correlation id; quote it in support requests.

took_msinteger required
unsupported_fieldsstring[] required

Output paths this provider structurally does not supply; such fields are null for a different reason than 'missing on this record'.

Changes

No recorded changes to this operation across all 1 revision of this API.