Skip to main content
POST
TypeScript (SDK)

Authorizations

tql_api_key
string
header
required

Headers

Connect-Protocol-Version
enum<number>
default:1
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
appId
string

Response

Success

ready
boolean

true only when rendering succeeded, produced a screenshot, and logged no browser errors/warnings

screenshotUrl
string | null
consoleErrors
string[]
renderError
string | null

renderer/infrastructure failure; browser diagnostics stay in console_errors