Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Telnyx API key

Body

application/json
urls
string<uri>[]
required

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

Required array length: 1 - 20 elements
Example:
formats
enum<string>[]

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.

Maximum array length: 3
Available options:
html,
markdown,
metadata
Example:
crawl_timeout
integer

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

Required range: 1 <= x <= 60
Example:

10

max_age
integer | null

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

Required range: x >= 0
Example:

null

Response

Successful content retrieval response.

data
object