> ## Documentation Index > Fetch the complete documentation index at: https://docs.agentkey.app/llms.txt > Use this file to discover all available pages before exploring further. # web.scrape > Fetch one web page and return its readable text (markdown or plain text) with title and basic metadata. ## OpenAPI ````yaml api-reference/openapi/v2.yaml POST /v2/ops/web.scrape openapi: 3.1.0 info: description: >- Fixed, versioned, provider-independent methods over AgentKey's upstream catalog. Each method has a stable name, input schema and output schema; the server picks the upstream provider, fails over, normalizes fields and refunds failed attempts. Every response names the provider that served it, the credits charged and every attempt made. title: AgentKey Scenario Methods version: '2' servers: - url: https://api.agentkey.app security: [] paths: /v2/ops/web.scrape: post: tags: - web summary: >- Fetch one web page and return its readable text (markdown or plain text) with title and basic metadata. description: >- 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. operationId: web_scrape requestBody: content: application/json: schema: additionalProperties: false properties: fields: $ref: '#/components/schemas/FieldsProjection' format: default: markdown description: >- Format of the returned text. markdown keeps headings, lists and links; text is plain text. enum: - markdown - text type: string include_raw: $ref: '#/components/schemas/IncludeRaw' provider: $ref: '#/components/schemas/ProviderShorthand' routing: $ref: '#/components/schemas/Routing' url: description: Absolute http(s) URL to fetch. type: string required: - url type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/WebPageEnvelope' description: Success envelope '400': $ref: '#/components/responses/ValidationError' '402': $ref: '#/components/responses/InsufficientCredits' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' '502': $ref: '#/components/responses/UpstreamFailed' '504': $ref: '#/components/responses/Timeout' security: - ApiKeyAuth: [] components: schemas: FieldsProjection: description: >- Projection: keep only these dotted paths of data, e.g. ["items.id", "items.text"]. items: type: string type: array IncludeRaw: default: false description: >- Attach the raw upstream payload as `raw` (not a stable contract; truncated above 256 KB). type: boolean ProviderShorthand: description: Shorthand for routing.only = [provider]. type: string Routing: additionalProperties: false description: >- Provider routing override. order: try these providers first; only: restrict to these (equivalent to pinning); allow_fallbacks: false tries only the first eligible provider. properties: allow_fallbacks: default: true description: false = try only the first eligible provider. type: boolean only: description: Restrict to these providers. items: type: string type: array order: description: Providers to try first, in order. items: type: string type: array strategy: default: auto description: >- How eligible providers are ordered. auto = the method's curated order. fastest / stable / popular are specified but not implemented yet (400 until then). The price is fixed whatever the strategy; mutually exclusive with order. enum: - auto type: string type: object WebPageEnvelope: allOf: - $ref: '#/components/schemas/Envelope' - properties: data: $ref: '#/components/schemas/WebPage' type: object description: Success envelope whose data is a WebPage. Envelope: description: Success envelope. `data` is the method's output object. properties: attempts: items: $ref: '#/components/schemas/Attempt' type: array credits_charged: description: Credits charged for this call (the method's fixed price). type: number data: description: Method output (typed per method). op: description: Method name. type: string op_version: description: Method version that served the call. type: integer provider: description: Provider that actually served the call. type: string raw: description: Upstream payload, only with include_raw=true. Not a stable contract. raw_truncated: type: boolean request_id: description: Correlation id; quote it in support requests. type: string took_ms: type: integer unsupported_fields: description: >- Output paths this provider structurally does not supply; such fields are null for a different reason than 'missing on this record'. items: type: string type: array required: - op - op_version - provider - request_id - credits_charged - took_ms - attempts - unsupported_fields - data type: object WebPage: additionalProperties: false description: >- One fetched web page reduced to readable text, normalized across scrapers. properties: content_type: description: >- MIME type of the fetched document (text/html, application/pdf) when the scraper reports it. type: - string - 'null' description: description: Meta description / summary line when the page has one. type: - string - 'null' final_url: description: >- URL after redirects as reported by the scraper; null when the scraper does not report it. type: - string - 'null' format: description: Format of `text` as delivered by the scraper. enum: - markdown - text - html type: string lang: description: BCP 47 language tag of the page when the scraper reports one. type: - string - 'null' published_at: description: >- Publish time of the page when the scraper extracts one (article meta tags), RFC 3339 UTC. format: date-time type: - string - 'null' status_code: description: >- HTTP status the target site answered with, when the scraper reports it. type: - integer - 'null' text: description: >- Main content of the page in the requested format (markdown or plain text). Boilerplate (navigation, footers) is removed where the scraper supports it. type: string title: description: Page title (document title or og:title). type: - string - 'null' url: description: The URL that was requested (echoed from the input). type: string required: - url - final_url - title - description - text - format - lang - published_at - status_code - content_type type: object ErrorEnvelope: properties: attempts: items: $ref: '#/components/schemas/Attempt' type: array code: type: integer error: description: Human-readable message. type: string error_type: description: >- validation | not_found | rate_limit | timeout | insufficient_credits | upstream_unauthorized | upstream_unavailable | provider_error type: string op: description: Method name. type: string request_id: description: Correlation id. type: string required: - error - code - error_type type: object Attempt: description: >- One upstream try. Present on success and failure so a failover is never invisible. properties: error_type: description: >- validation | not_found | rate_limit | timeout | upstream_unauthorized | upstream_unavailable | provider_error type: string provider: description: Provider slug. type: string refunded: description: true when the reservation for this attempt was refunded. type: boolean status: description: HTTP status AgentKey mapped this attempt to (200 on success). type: integer took_ms: type: integer tool: description: Registry tool name (Provider/operation) that was called. type: string upstream_status: description: The provider's real HTTP status; absent when nothing was received. type: integer required: - provider - tool - status - took_ms type: object responses: ValidationError: content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Validation error (unknown field, bad cursor, bad routing) InsufficientCredits: content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Insufficient credits NotFound: content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Not found (method, or upstream object) RateLimited: content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Rate limited upstream UpstreamFailed: content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: All providers failed Timeout: content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' description: Timed out securitySchemes: ApiKeyAuth: description: AgentKey API key (ak_…). scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.