Atlas APIKnowledge Base

Get URL extract job status

Polls the status of an asynchronous multi-page crawl started by POST /knowledgebase/knowledge-extract with crawl: true.

Authentication

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

Path parameters

jobIdstringRequired

The job identifier returned in the 202 response.

Response

Job status
jobIdstringOptional
Unique identifier for the crawl job.
statusenumOptional
Current job state. `pending` = queued, `indexing` = pages discovered and being processed, `complete` = done, `failed` = error occurred.
Allowed values:
urlstringOptionalformat: "uri"
The URL being crawled.
filenamestringOptional
Blob filename for the extracted knowledge file.
knowledgeIdstringOptional
Atlas file identifier. Present only when status is `complete`.
reasonstringOptional
Human-readable failure reason. Present only when status is `failed`.

Errors

404
Not Found Error
500
Internal Server Error