start_competitor_analysis

Supply input in the JSON body, including idempotencyKey and consent. This route does not read an Idempotency-Key header. HTTP202 returns saved background intent; supplier admission is required.

post/v1/competitor-analyses

Request

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

Headers

X-Workspace-IDstring

Required when using a Clerk human session. With an API key, omit this header or supply its bound workspace.

Request body

projectIdstring required

project ID from create/list.

setIdstring required

set ID from create/list.

revisioninteger required

Revision of the approved competitor set bound to this offer or run. Pass the current set revision as revision when preparing an offer.

memberIdstring required

member ID from create/list.

idempotencyKeystring required

Caller-generated key reused only for retries of the same operation and arguments in this workspace.

consenttrue required

consent; see schema.

Response

Supply input in the JSON body, including idempotencyKey and consent. This route does not read an Idempotency-Key header. HTTP202 returns saved background intent; supplier admission is required.

schema_version1 required
idstring required

Resource identifier returned by the operation.

workspace_idstring required

Workspace that owns this record.

project_idstring required

Project that owns this record.

state'pending' | 'running' | 'completed' | 'partial' | 'failed' | 'stopped' required

Saved lifecycle or evidence state, as enumerated for this record.

baseline_run_idstring nullable required
inventory_idstring nullable required
created_atstring date-time required

UTC timestamp when the record was created.

updated_atstring date-time required

UTC timestamp of the last record update.

last_activity_atstring date-time required
next_eligible_atstring date-time required
retrieval_deadlinestring date-time required
attempt_countinteger required
retry_countinteger required
last_error_codestring nullable required
recurring_monitoring_createdfalse required

Whether this operation enrolled recurring monitoring.

replayedboolean

True when the response reuses an earlier request with the same idempotency value.

Changes

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