Skip to navigation
API ReferenceServerless processing

Queue an internet crawl job

Authentication

AuthorizationBearer

Use a tq_live_ API key as a Bearer token.

Path parameters

index_idstringRequired

Headers

x-talqora-organization-idstring or nullOptional

Request

This endpoint expects an object.
urlstringRequired8-2048 characters
page_limitintegerOptional1-100000Defaults to 10
max_depthintegerOptional1-100000Defaults to 1

Response

Successful Response
idstring
urlstring
page_limitinteger
max_depthinteger
statusenum
Allowed values:
created_atdatetime
provider_job_idstring or nullOptional
pages_foundintegerOptionalDefaults to 0
errorstring or nullOptional
started_atdatetime or nullOptional
completed_atdatetime or nullOptional

Errors

422
Unprocessable Entity Error