---
title: "capture_competitor_inventory"
method: POST
path: "/v1/competitor-inventories"
---

# capture_competitor_inventory

`POST /v1/competitor-inventories`

## Request

- Base URL: `https://app.agentlinkops.com`
- URL: `https://app.agentlinkops.com/v1/competitor-inventories`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Remaining arguments go in a JSON object body.

## Headers

- `X-Workspace-ID` string

## Request body

- object
  - `runId` string, required: run ID from create/list.

## Response `201`

Remaining arguments go in a JSON object body.

- object
  - `v` number, required
  - `id` string, required: Resource identifier returned by the operation.
  - `workspace_id` string, required: Workspace that owns this record.
  - `project_id` string, required: Project that owns this record.
  - `set_id` string, required
  - `set_revision` number, required
  - `set_hash` string, required
  - `member_id` string, required
  - `member_role` string, required
  - `target_scope_id` string, required
  - `captured_at` string, required
  - `provider_retrieved_from` string, nullable, required
  - `provider_retrieved_to` string, nullable, required
  - `run` object, required
    - `v` 1, required
    - `id` string, required: Resource identifier returned by the operation.
    - `workspace_id` string, required: Workspace that owns this record.
    - `project_id` string, required: Project that owns this record.
    - `provider` 'linktrail_corpus' | 'dataforseo' | 'imported', required
    - `data_mode` 'synthetic' | 'owned_corpus' | 'provider_index' | 'imported', required
    - `query` object, required
      - `target_kind` 'domain' | 'exact_url', required
      - `target` string, required
      - `include_subdomains` boolean, required
      - `backlinks_status_type` 'live' | 'lost' | 'all', required
      - `exclude_internal_backlinks` boolean, required
      - `mode` 'as_is', required
      - `filters` unknown, required
      - `rank_scale` 'one_thousand', nullable, required
      - `page_limit` integer, required
      - `row_limit` integer, required
    - `status` 'queued' | 'running' | 'succeeded' | 'partial' | 'failed' | 'reconciliation_required', required: Resource lifecycle status.
    - `created_at` string, date-time, required: UTC timestamp when the record was created.
    - `started_at` string, date-time, nullable, required
    - `finished_at` string, date-time, nullable, required
    - `coverage` 'pending' | 'complete_for_query' | 'capped' | 'partial' | 'unknown', required: Dataset scope and completeness, including limits on what these results establish.
    - `coverage_reason` string, nullable, required
    - `provider_total_count` integer, nullable, required
    - `usage` object, required
      - `unit` 'discovery', required
      - `currency` 'USD', required
      - `quote_id` string, required
      - `max_cost_microusd` integer, required
      - `reserved_cost_microusd` integer, required
      - `provider_reported_cost_microusd` integer, nullable, required
      - `request_count` integer, required
      - `returned_rows` integer, required
      - `accepted_candidates` integer, required
      - `rejected_rows` integer, required
      - `duplicate_rows` integer, required
    - `operation` 'backlinks', required
    - `coverage_scope` 'customer_import' | 'corpus_subset' | 'provider_query', required
    - `whole_web_coverage` false, required: False: these results do not measure the whole web.
    - `replayed` boolean: True when the response reuses an earlier request with the same idempotency value.
  - `content_hash` string, required
  - `absence_claim` 'not_supported', required: not_supported: missing dataset rows cannot prove link absence.
  - `verification_view` 'captured_at_snapshot', required
  - `replayed` boolean: True when the response reuses an earlier request with the same idempotency value.

## Other responses

- `429`: Request-rate or usage refusal. Inspect error.code and recovery details before retrying.
- `default`: Error envelope. Non-configuration 5xx messages are masked and details omitted; allowlisted configuration errors retain static operator recovery.

---

[API](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api.md) · [All operations](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api/llms.txt) · [OpenAPI document](https://skmtc.dev/agentlinkops/apis/agentlinkops-http-api/revisions/2a712a1dcfa7?raw)