Contents

Retrieve page contents

Changed on

Retrieves clean HTML or Markdown content from a list of URLs. Supports up to 20 URLs per request (public API limit). Specify which formats to return: html, markdown, metadata.

post/web_search/contents

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/web_search/contents
  • Auth: HTTP bearer

Request body

urlsstring[] required

List of URLs to retrieve content from (max 20 for public API).

formatsstring[]

Content formats to return. If omitted, html and metadata are returned by default. Retrieval is best-effort per URL: a format field appears only when that content could be produced, and a freshly crawled page may also include html even when not requested.

crawl_timeoutinteger

Timeout for crawling each URL, in seconds (1-60).

max_ageinteger nullable

Maximum age of cached content in seconds. null means no limit.

Example request

{
  "urls": [
    "https://en.wikipedia.org/wiki/Artificial_intelligence"
  ],
  "formats": [
    "markdown",
    "metadata"
  ],
  "crawl_timeout": 10
}

Response

Successful content retrieval response.

Changes