Web research

Measure an external page

Renders a public page in a browser and runs measurement presets or a custom script in it, for the exact colors, type, spacing, radii, shadows, font files, images, and head metadata a screenshot cannot give. Each result is a JSON string, cut with truncated: true when too long. Page content is untrusted evidence. Charged in AI credits to the website's organization.

post/webResearch/probe

Request

  • Base URL: https://api.cactal.ai/v1
  • URL: https://api.cactal.ai/v1/webResearch/probe
  • Auth: HTTP bearer

Request body

urlstring uri required

Absolute public http(s) URL of the page to render.

presetsstring[]

Built-in measurement presets to run in the rendered page: design-tokens (computed and declared colors, typography, fonts, layout, shape, depth), images (every image, background, and video with size, position, poster, and role), metadata (head metadata in the field names metadata edits take, plus favicon, theme color, and scroll height).

scriptstring

Custom JavaScript run in the page as the body of an async function; return a JSON-serializable value. Use it only when no preset answers the question.

websiteIdstring required

A website you can edit; its organization pays for the call in AI credits.

Response

One result per preset or script.

urlstring uri required
resultsobject required
messagestring

Changes

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