Skip to main content
POST
/
api
/
knowledge-bases
/
{id}
/
crawl-jobs
/
{jobId}
/
pause
Error
A valid request URL is required to generate request examples
{
  "_id": "<string>",
  "accountId": "<string>",
  "knowledgeBaseId": "<string>",
  "status": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "sitemapUrl": "<string>",
  "urlsFound": 123,
  "urlList": [
    "<string>"
  ],
  "maxPages": 123,
  "useLlmDistill": true,
  "pagesProcessed": 123,
  "pagesFailed": 123
}

Authorizations

Authorization
string
header
required

Bearer token using an API key (format nl_live_* or nl_test_*)

Path Parameters

id
string
required

Knowledge base ID

jobId
string
required

Crawl job ID

Response

Paused crawl job

_id
string
required

Unique identifier

accountId
string
required

Owning account ID

knowledgeBaseId
string
required

Parent knowledge base ID

status
string
required

Current job status

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
sitemapUrl
string

Sitemap URL being crawled

urlsFound
integer

Number of URLs discovered from the sitemap

urlList
string[]

Explicit list of URLs to crawl

maxPages
integer

Maximum pages to crawl

useLlmDistill
boolean

Whether LLM distillation is enabled

pagesProcessed
integer

Number of pages successfully processed

pagesFailed
integer

Number of pages that failed processing