> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agentlinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create internal-link inventory

> Save up to 100 supplied owned-site URLs as a dated internal-link inventory.

`create_internal_link_snapshot`

Save up to 100 supplied owned-site URLs as a dated internal-link inventory. Inventory completeness is user-declared; no pages are fetched until processing. Reuse requestId for retries.

<Note>This command name is absent from deployment evidence dated 2026-09-20. Hosted availability for this current definition is unverified; inspect your connected catalog before invoking it. Verify the command and its input schema in the selected environment.</Note>

| 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](/guides/connect-mcp), [CLI](/guides/connect-cli), or [HTTP](/guides/connect-http). Replace example identifiers with records from your workspace.

<CodeGroup>
  ```json MCP theme={null}
  {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
      "name": "create_internal_link_snapshot",
      "arguments": {
        "projectId": "prj_example",
        "requestId": "inventory-2026-10-14",
        "inventory": [
          {
            "url": "https://example.com/",
            "source": "url_list"
          }
        ],
        "seeds": [
          "https://example.com/"
        ],
        "inventoryComplete": false
      }
    }
  }
  ```

  ```bash CLI theme={null}
  agentlinkops call create_internal_link_snapshot --args '{"projectId":"prj_example","requestId":"inventory-2026-10-14","inventory":[{"url":"https://example.com/","source":"url_list"}],"seeds":["https://example.com/"],"inventoryComplete":false}'
  ```

  ```bash HTTP theme={null}
  curl --fail-with-body https://app.agentlinkops.com/v1/commands/create_internal_link_snapshot \
    -H "Authorization: Bearer $AGENTLINKOPS_TOKEN" \
    -H 'Content-Type: application/json' \
    --data '{"projectId":"prj_example","requestId":"inventory-2026-10-14","inventory":[{"url":"https://example.com/","source":"url_list"}],"seeds":["https://example.com/"],"inventoryComplete":false}'
  ```
</CodeGroup>

## 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.

<Accordion title="Full response example">
  ```json theme={null}
  {
    "snapshot": {
      "id": "ils_example",
      "projectId": "prj_example",
      "createdAt": "2026-10-14T12:00:00.000Z",
      "expiresAt": "2026-11-13T12:00:00.000Z",
      "completedAt": null,
      "state": "pending",
      "inventoryCount": 1,
      "processedCount": 0,
      "completeCount": 0,
      "unknownCount": 0,
      "pendingCount": 1,
      "edgeCount": 0,
      "revision": 0,
      "busy": false,
      "retryAfterSeconds": 0,
      "scope": {
        "domain": "example.com",
        "hostPolicy": "exact_hostname",
        "seeds": [
          "https://example.com/"
        ]
      },
      "coverage": {
        "inventory": "partial",
        "representation": "raw_html",
        "completeSiteCensus": false,
        "allInventoryPagesComplete": false,
        "renderedVisibility": false,
        "iframes": false,
        "shadowRoots": false,
        "canonicalAliasesMerged": false
      },
      "version": "internal-links-v1"
    },
    "limits": {
      "inventoryPages": 100,
      "pagesPerRequest": 3,
      "pageBytes": 2097152,
      "pageTimeoutMs": 20000,
      "requestTimeoutMs": 65000,
      "edgesPerPage": 200,
      "evidenceBytesPerPage": 131072,
      "workspacePagesPerDay": 300,
      "retainedSnapshotsPerProject": 20,
      "retentionDays": 30,
      "pageSize": 100,
      "leaseMs": 90000
    }
  }
  ```
</Accordion>

## 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 | request ID from create/list. minLength: `1`; maxLength: `128` |
| `inventory` | array | Required | inventory; see schema. minItems: `1`; maxItems: `100` |
| `inventory[].url` | string | Required | format: `"uri"`; maxLength: `4096` |
| `inventory[].source` | string | Optional | values: `"url_list"`, `"sitemap_export"`, `"cms_export"`, `"repository_export"`, `"search_export"` |
| `inventory[].important` | boolean | Optional | |
| `inventory[].excluded` | boolean | Optional | |
| `seeds` | array | Optional | seeds; see schema. maxItems: `10`; default: `[]` |
| `inventoryComplete` | boolean | Optional | inventory complete; see schema. default: `false` |

### Validation and omitted values

Requires watches:read and watches:write. Supply 1-100 unique inventory URLs on the exact project hostname. Each omitted source becomes url\_list; omitted important and excluded flags become false. URL fragments do not identify separate pages.

Supply at most ten seed URLs, all in the inventory, to measure observed depth. inventoryComplete is a customer declaration; it does not establish a complete site census.

requestId is the caller-supplied retry identity. Reuse it with the same normalized inventory, seeds and completeness declaration after an uncertain response. Different input under the same requestId conflicts. Do not add an idempotencyKey field.

Creating saves an inventory without fetching pages. Retention is 30 days, with at most 20 retained snapshots per project. Call process\_internal\_link\_snapshot explicitly to capture pages.

### Defaults when omitted

| Field | Default |
| - | - |
| `seeds` | `[]` |
| `inventoryComplete` | `false` |

## Output fields

Fields inside optional or nullable parents apply only when that parent exists. [Common schema conventions](/reference/schemas) explain evidence states, empty lists and extensions.

* **`snapshot`** (object, required): additional fields rejected
* **`limits`** (object, required): additional fields rejected
* **`retryAt`** (string / null, optional).

<Accordion title="All fields and nested objects">
  | Field | Type | Presence | Meaning and constraints |
  | - | - | - | - |
  | `snapshot` | object | Required | additional fields rejected |
  | `snapshot.id` | string | Required | Resource identifier returned by the operation. minLength: `1`; maxLength: `200` |
  | `snapshot.projectId` | string | Required | Identifier returned by the related operation. minLength: `1`; maxLength: `200` |
  | `snapshot.createdAt` | string | Required | |
  | `snapshot.expiresAt` | string | Required | |
  | `snapshot.completedAt` | string / null | Required | |
  | `snapshot.state` | string | Required | Saved lifecycle or evidence state, as enumerated for this record. values: `"pending"`, `"running"`, `"complete"` |
  | `snapshot.inventoryCount` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `snapshot.processedCount` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `snapshot.completeCount` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `snapshot.unknownCount` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `snapshot.pendingCount` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `snapshot.edgeCount` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `snapshot.revision` | integer | Required | Optimistic concurrency revision; supply it as expectedRevision on the next write. minimum: `0`; maximum: `9007199254740991` |
  | `snapshot.busy` | boolean | Required | |
  | `snapshot.retryAfterSeconds` | integer | Required | minimum: `0`; maximum: `9007199254740991` |
  | `snapshot.scope` | object | Required | additional fields rejected |
  | `snapshot.scope.domain` | string | Required | |
  | `snapshot.scope.hostPolicy` | string | Required | must equal `"exact_hostname"` |
  | `snapshot.scope.seeds` | array | Required | |
  | `snapshot.coverage` | object | Required | Dataset scope and completeness, including limits on what these results establish. additional fields rejected |
  | `snapshot.coverage.inventory` | string | Required | values: `"declared_complete"`, `"partial"` |
  | `snapshot.coverage.representation` | string | Required | must equal `"raw_html"` |
  | `snapshot.coverage.completeSiteCensus` | boolean | Required | must equal `false` |
  | `snapshot.coverage.allInventoryPagesComplete` | boolean | Required | |
  | `snapshot.coverage.renderedVisibility` | boolean | Required | must equal `false` |
  | `snapshot.coverage.iframes` | boolean | Required | must equal `false` |
  | `snapshot.coverage.shadowRoots` | boolean | Required | must equal `false` |
  | `snapshot.coverage.canonicalAliasesMerged` | boolean | Required | must equal `false` |
  | `snapshot.version` | string | Required | must equal `"internal-links-v1"` |
  | `limits` | object | Required | additional fields rejected |
  | `limits.inventoryPages` | number | Required | must equal `100` |
  | `limits.pagesPerRequest` | number | Required | must equal `3` |
  | `limits.pageBytes` | number | Required | must equal `2097152` |
  | `limits.pageTimeoutMs` | number | Required | must equal `20000` |
  | `limits.requestTimeoutMs` | number | Required | must equal `65000` |
  | `limits.edgesPerPage` | number | Required | must equal `200` |
  | `limits.evidenceBytesPerPage` | number | Required | must equal `131072` |
  | `limits.workspacePagesPerDay` | number | Required | must equal `300` |
  | `limits.retainedSnapshotsPerProject` | number | Required | must equal `20` |
  | `limits.retentionDays` | number | Required | must equal `30` |
  | `limits.pageSize` | number | Required | must equal `100` |
  | `limits.leaseMs` | number | Required | must equal `90000` |
  | `retryAt` | string / null | Optional | |
</Accordion>

[Download input schema](/schemas/create_internal_link_snapshot.input.json) · [Download output schema](/schemas/create_internal_link_snapshot.output.json)

## Errors and retries

In the same workspace and project, retry with the original requestId and the same arguments, including inventory order. Preserve originally omitted optional fields. After an uncertain response, retry that request and inspect its result before using a new requestId. Different normalized input for an existing requestId returns IDEMPOTENCY\_CONFLICT. Operation-specific errors include `INVALID_INPUT`, `PROJECT_ACCESS_DENIED`, `INTERNAL_LINK_SCOPE_MISMATCH`, `INTERNAL_LINK_DUPLICATE_URL`, `IDEMPOTENCY_CONFLICT`, `INTERNAL_LINK_RETENTION_LIMIT`, `INTERNAL_LINK_SCOPE_DELETING`, `INTERNAL_LINK_SNAPSHOT_EXPIRED`.

See [error recovery](/reference/errors) 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](/reference/http/routes).

| Method and route | Success | Details |
| - | - | - |
| `POST /v1/internal-links/snapshots` | 201 | Supply all inputs in the JSON body, including projectId and requestId. requestId is the retry identity; this route does not read an Idempotency-Key header. HTTP 201 returns a saved inventory and limits, with no page capture. Requires watches:read and watches:write. |

## Continue

[process\_internal\_link\_snapshot](/reference/commands/process_internal_link_snapshot) · [get\_internal\_link\_snapshot](/reference/commands/get_internal_link_snapshot) · [list\_internal\_link\_snapshots](/reference/commands/list_internal_link_snapshots)

Follow the [related workflow](/guides/internal-links), inspect [capability status](/capability-status), or return to the [command index](/reference/index).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.