Execution

post/v1/crawls

Request

  • Base URL: https://api.atlas-compiler.com
  • URL: https://api.atlas-compiler.com/v1/crawls
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Headers

idempotency-keystring

Optional idempotency key. When provided, deduplicates requests within a 24-hour window.

Request body

excludePathsstring[]
formatsstring[]
ignoreQueryParametersboolean
includePathsstring[]
includeSubdomainsboolean
maxDepthinteger
maxPagesinteger
metadataobject
projectIdstring
sitemap'include' | 'skip' | 'only'
urlstring uri required

Example request

{
  "excludePaths": [
    "/docs/**"
  ],
  "includePaths": [
    "/docs/**"
  ]
}

Response

Canonical job accepted.

artifactExpiresAtstring date-time nullable required
artifactState'not_applicable' | 'pending' | 'ingesting' | 'complete' | 'expired' | 'review' required
cancellationRequestedAtstring date-time nullable required
createdAtstring date-time required
executionTerminalAtstring date-time nullable required
idstring required
kind'compile' | 'crawl' | 'batch' required
projectIdstring nullable required
readyAtstring date-time nullable required
reviewReasonstring nullable required
status'queued' | 'running' | 'ingesting' | 'ready' | 'failed' | 'cancelled' required
targetUrlstring nullable
updatedAtstring date-time required
workspaceIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.