Agentic Platform
Documentation API reference Tools Skills

Tools

SpeedWorkers Page Snapshot

speedworkers_page_snapshot MCP Url data

Get the HTML SpeedWorkers stored for a URL during a past indexation.

Get what Botify SpeedWorkers stored during one past indexation of a page: the HTML received (and rendered) from the origin, the URL fetched, the HTTP status code and headers returned by the origin, the canonical URL, a summary of the JavaScript rendering, and the indexation job (cache behavior, rendering config, inventory sources and page properties). The indexation event is identified by the `event_id` returned by `speedworkers_page_history`. Old events may no longer be available. Use `speedworkers_page_preview` for the page currently delivered to bots. Header values that may hold credentials (cookies, authorization...) and credentials in URLs are masked. With `save_to_tmp_storage`, the HTML is saved to temporary storage and its URL is returned instead. The project must have SpeedWorkers enabled.

Playground

POST
item
event_id required

The `event_id` of an indexation event, as returned by the `speedworkers_page_history` tool.

config
save_to_tmp_storage

Save the HTML to Botify temporary storage and return the temporary URL instead of the HTML. Use this to save output tokens. The returned URL can be passed to other HTML-processing tools. Headers and details are still returned.

Credits

Fixed cost per indexation event requested. This tool reads the page SpeedWorkers already stored for your project and calls no outside service, so nothing is added to the per-call price.

These usage SKUs can be charged on a call.

SKU Credits Description
Tool call 1 per request Charged once per successful item.

Schemas

item is what you send, config how the tool behaves, and the response is what you get back.

Item

object
Properties
event_id string required

The `event_id` of an indexation event, as returned by the `speedworkers_page_history` tool.

Example
{
  "event_id": "string"
}

Configuration

object
Properties
save_to_tmp_storage boolean

Save the HTML to Botify temporary storage and return the temporary URL instead of the HTML. Use this to save output tokens. The returned URL can be passed to other HTML-processing tools. Headers and details are still returned.

Default: false

Example
{
  "save_to_tmp_storage": false
}

Response

object
Properties
html string | null

HTML of the page as stored by SpeedWorkers during this indexation. Omitted when `save_to_tmp_storage` is True; see `html_tmp_storage_url` instead.

Default: null

html_tmp_storage_url string | null

Temporary storage URL of the HTML page. Returned instead of `html` when `save_to_tmp_storage` is True. Can be passed to other HTML-processing tools.

Default: null

url string | null

URL fetched by SpeedWorkers from the origin

Default: null

indexed_at string (date-time) required

When the indexation happened

status_code integer | null

HTTP status code returned by the origin

Default: null

headers object | null

HTTP headers returned by the origin; values that may hold credentials (cookies, authorization...) are masked with `**`

Default: null

canonical SpeedWorkersCanonical

Canonical URL found in the page

Type: SpeedWorkersCanonical

Default: null

js_rendering SpeedWorkersJsRendering

Summary of the JavaScript rendering

Type: SpeedWorkersJsRendering

Default: null

job SpeedWorkersIndexationJob

Indexation job: cache behavior, rendering config, inventory sources and page properties

Type: SpeedWorkersIndexationJob

Default: null

reason string | null

Why no HTML was returned, if any

Default: null

Example
{
  "html": null,
  "html_tmp_storage_url": null,
  "url": null,
  "indexed_at": "string",
  "status_code": null,
  "headers": null,
  "canonical": null,
  "js_rendering": null,
  "job": null,
  "reason": null
}

Type Definitions

4 types

These are the available sub-object types that can be used in the properties above.

SpeedWorkersCanonical object
#
has_canonical boolean | null

Whether the page declares a canonical URL

Default: null

canonical_url string | null

Canonical URL declared by the page

Default: null

canonical_equal boolean | null

Whether the canonical URL is the page URL

Default: null

SpeedWorkersIndexationJob object
#
section_id string | null

ID of the matching cache behavior (section)

Default: null

config_id string | null

ID of the rendering config used

Default: null

config_type string | null

Type of the rendering config (device)

Default: null

input_ids array

IDs of the inventory sources of the page

Default: []

page_properties array

Page properties at the time of the indexation

Items: SpeedWorkersPageProperty

Default: []

status_code integer | null

Status code of the page known before the job

Default: null

previous_status_code integer | null

Previous status code of the page

Default: null

batch_date string | null

Date of the indexation batch

Default: null

SpeedWorkersJsRendering object
#
device string | null

Rendering device

Default: null

rendered boolean | null

Whether the page was rendered with JavaScript

Default: null

status string | null

Rendering status

Default: null

redirect_url string | null

Redirect target found during the rendering

Default: null

version_code string | null

Version of the rendering engine

Default: null

rendering_time_ms integer | null

Rendering time, in ms

Default: null

nb_resources integer | null

Number of resources requested by the page

Default: null

nb_resources_error integer | null

Number of resources that failed to load

Default: null

SpeedWorkersPageProperty object
#
input string | null

ID of the inventory source of the property

Default: null

name string | null

Property name

Default: null

value string | null

Property value

Default: null

Endpoints

POST http://agents.botify.com/{organization}/{project}/speedworkers_page_snapshot/process
POST http://agents.botify.com/{organization}/{project}/speedworkers_page_snapshot/batch_process
POST http://agents.botify.com/{organization}/{project}/speedworkers_page_snapshot/async_process
POST http://agents.botify.com/{organization}/{project}/speedworkers_page_snapshot/async_batch_process

See running a long job in the background for the polling flow.

cURL

curl -X POST "http://agents.botify.com/{organization}/{project}/speedworkers_page_snapshot/process" \
  -H "Authorization: Bearer $BOTIFY_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "item": {
    "event_id": "<event_id>"
  }
}'

Over MCP

This tool is exposed as the MCP tool speedworkers_page_snapshot. An MCP client passes organization, project and item as tool arguments. Set up MCP →

Raw metadata