Start a background website scan

start_internal_link_scan Start a bounded website scan that continues in the background. Reads the homepage and sitemaps, then follows eligible internal links. Reuse requestId after an uncertain response. No recurring monitoring or paid provider request.

This command name appears in deployment evidence dated 2026-10-16. This page describes current source; read your connected catalog for deployed inputs and access. Workspace scopes and enabled providers still apply.

Access	Behavior
`watches:write`, `watches:read`	Writes or admits work

This operation changes saved state. Review its inputs and retry behavior before calling.

Example request

Connect through MCP, CLI, or HTTP. Replace example identifiers with records from your workspace.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "start_internal_link_scan",
    "arguments": {
      "projectId": "prj_example",
      "requestId": "scan-example"
    }
  }
}

agentlinkops call start_internal_link_scan --args '{"projectId":"prj_example","requestId":"scan-example"}'

curl --fail-with-body https://app.agentlinkops.com/v1/commands/start_internal_link_scan \
  -H "Authorization: Bearer $AGENTLINKOPS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"projectId":"prj_example","requestId":"scan-example"}'

Returned result

Illustrative data validated against the documented response schema. IDs and dates are examples, not a live account capture. MCP returns this data in structuredContent and in a text content block; generic HTTP and CLI return the JSON result directly.

Full response example

{
  "scan": {
    "version": "internal-link-scan-v1",
    "id": "ilr_example",
    "projectId": "prj_example",
    "domain": "example.com",
    "homepage": "https://example.com/",
    "state": "queued",
    "reason": null,
    "createdAt": "2026-10-15T12:00:00.000Z",
    "updatedAt": "2026-10-15T12:00:00.000Z",
    "expiresAt": "2026-11-14T12:00:00.000Z",
    "completedAt": null,
    "revision": 0,
    "controlRevision": 0,
    "discoveredCount": 1,
    "completeCount": 0,
    "unknownCount": 0,
    "pendingCount": 1,
    "admittedCount": 0,
    "edgeCount": 0,
    "excludedReferences": 0,
    "exclusions": {},
    "nextEligibleAt": "2026-10-15T12:00:00.000Z",
    "discovery": {
      "state": "pending"
    },
    "coverage": {
      "inventory": "partial",
      "completeSiteCensus": false,
      "representation": "raw_html",
      "frontierTruncated": false,
      "renderedVisibility": false,
      "canonicalAliasesMerged": false
    },
    "usage": {
      "unit": "admitted_page",
      "period": "2026-10-15",
      "limit": 300,
      "used": 0,
      "resetsAt": "2026-10-16T00:00:00.000Z"
    }
  },
  "limits": {
    "pagesPerRun": 300,
    "workspacePagesPerDay": 300,
    "retainedRunsAndSnapshotsPerProject": 20,
    "retentionDays": 30,
    "pageBytes": 2097152,
    "pageTimeoutMs": 20000,
    "leaseMs": 90000,
    "maxAttempts": 3,
    "edgesPerPage": 200,
    "pageSize": 100
  }
}

Input fields

Omit optional fields when you do not want to supply them. Null is accepted only where listed. Unknown input properties are rejected.

Field	Type	Presence	Meaning and constraints
`projectId`	string	Required	project ID from create/list. minLength: `1`; maxLength: `200`
`requestId`	string	Required	Caller-generated retry key. Reuse the same key and website scope after an uncertain response. minLength: `1`; maxLength: `128`

Validation and omitted values

Saves an idempotent background intent for the selected website. Same requestId and website scope return the existing scan. Follows at most 300 eligible pages; the workspace allowance is 300 admitted pages per UTC day shared with supplied snapshots. Retries retain their original page admission. No recurring monitoring, paid supplier request or model assessment is created. Website coverage remains partial.

Output fields

Fields inside optional or nullable parents apply only when that parent exists. Common schema conventions explain evidence states, empty lists and extensions.

scan (object, required): additional fields rejected
limits (object, required): additional fields rejected

All fields and nested objects

Field	Type	Presence	Meaning and constraints
`scan`	object	Required	additional fields rejected
`scan.version`	string	Required	must equal `"internal-link-scan-v1"`
`scan.id`	string	Required	Resource identifier returned by the operation. minLength: `1`; maxLength: `200`
`scan.projectId`	string	Required	Identifier returned by the related operation. minLength: `1`; maxLength: `200`
`scan.domain`	string	Required
`scan.homepage`	string	Required
`scan.state`	string	Required	Saved lifecycle or evidence state, as enumerated for this record. values: `"queued"`, `"running"`, `"paused"`, `"cancelled"`, `"complete"`, `"limit_reached"`, `"failed"`
`scan.reason`	string / null	Required	Recorded explanation; null when no explanation applies.
`scan.createdAt`	string	Required
`scan.updatedAt`	string	Required
`scan.expiresAt`	string	Required
`scan.completedAt`	string / null	Required
`scan.revision`	integer	Required	Optimistic concurrency revision; supply it as expectedRevision on the next write. minimum: `0`; maximum: `9007199254740991`
`scan.controlRevision`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`scan.discoveredCount`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`scan.completeCount`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`scan.unknownCount`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`scan.pendingCount`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`scan.admittedCount`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`scan.edgeCount`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`scan.excludedReferences`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`scan.exclusions`	object	Required
`scan.nextEligibleAt`	string	Required
`scan.discovery`	object	Required	additional fields rejected
`scan.discovery.state`	string	Required	Saved lifecycle or evidence state, as enumerated for this record. values: `"pending"`, `"complete"`
`scan.discovery.coverage`	object	Optional	Dataset scope and completeness, including limits on what these results establish. additional fields rejected
`scan.discovery.coverage.completeSiteCensus`	boolean	Required	must equal `false`
`scan.discovery.coverage.truncated`	boolean	Required
`scan.discovery.coverage.reasons`	array	Required
`scan.discovery.documents`	array	Optional	maxItems: `13`
`scan.discovery.documents[].requestedUrl`	string	Required
`scan.discovery.documents[].finalUrl`	string / null	Required
`scan.discovery.documents[].checkedAt`	string	Required
`scan.discovery.documents[].sha256`	string / null	Required
`scan.discovery.documents[].status`	integer / null	Required	Resource lifecycle status.
`scan.discovery.documents[].reason`	string / null	Required	Recorded explanation; null when no explanation applies.
`scan.discovery.documents[].kind`	string	Required	values: `"robots"`, `"index"`, `"urlset"`, `"unknown"`
`scan.coverage`	object	Required	Dataset scope and completeness, including limits on what these results establish. additional fields rejected
`scan.coverage.inventory`	string	Required	must equal `"partial"`
`scan.coverage.completeSiteCensus`	boolean	Required	must equal `false`
`scan.coverage.representation`	string	Required	must equal `"raw_html"`
`scan.coverage.frontierTruncated`	boolean	Required
`scan.coverage.renderedVisibility`	boolean	Required	must equal `false`
`scan.coverage.canonicalAliasesMerged`	boolean	Required	must equal `false`
`scan.usage`	object	Required	additional fields rejected
`scan.usage.unit`	string	Required	must equal `"admitted_page"`
`scan.usage.period`	string	Required
`scan.usage.limit`	number	Required	must equal `300`
`scan.usage.used`	integer	Required	minimum: `0`; maximum: `9007199254740991`
`scan.usage.resetsAt`	string	Required
`limits`	object	Required	additional fields rejected
`limits.pagesPerRun`	number	Required	must equal `300`
`limits.workspacePagesPerDay`	number	Required	must equal `300`
`limits.retainedRunsAndSnapshotsPerProject`	number	Required	must equal `20`
`limits.retentionDays`	number	Required	must equal `30`
`limits.pageBytes`	number	Required	must equal `2097152`
`limits.pageTimeoutMs`	number	Required	must equal `20000`
`limits.leaseMs`	number	Required	must equal `90000`
`limits.maxAttempts`	number	Required	must equal `3`
`limits.edgesPerPage`	number	Required	must equal `200`
`limits.pageSize`	number	Required	must equal `100`

Download input schema · Download output schema

Errors and retries

Retry start_internal_link_scan with the original requestId in the same workspace and project. Inspect the returned scan before starting a new operation. Reusing that requestId after the website hostname changes returns IDEMPOTENCY_CONFLICT. Operation-specific errors include INTERNAL_LINK_SCANS_UNAVAILABLE, INTERNAL_LINK_SCAN_EXPIRED, SCAN_CONTROL_CONFLICT, SCAN_FINISHED, SCAN_PAGE_LIMIT, INTERNAL_LINK_DAILY_LIMIT, INVALID_CURSOR. See error recovery for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.

HTTP resource routes

These existing resource routes share the operation’s domain behavior. Their parameter placement, status and response envelope can differ from generic invocation. See HTTP route details.

Method and route	Success	Details
`POST /v1/internal-links/scans`	202	Supply projectId and requestId in the JSON body. HTTP202 returns saved background intent; requestId is the retry identity.

Continue

get_internal_link_scan · query_internal_link_scan Follow the related workflow, inspect capability status, or return to the command index.

Overview

MCP, CLI and API commands

CLI client

HTTP and events

Optional local workflows

Start a background website scan

Example request

Returned result

Input fields

Validation and omitted values

Output fields

Errors and retries

HTTP resource routes

Continue

​Example request

​Returned result

​Input fields

​Validation and omitted values

​Output fields

​Errors and retries

​HTTP resource routes

​Continue

Example request

Returned result

Input fields

Validation and omitted values

Output fields

Errors and retries

HTTP resource routes

Continue