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

# Start a website links run

> Starts a link suggestions run over the seller's own pages: it finds them (the pages declared here or last time, the Discovery page's checked pages, sitemaps on every content host, the usual blog places, a bounded crawl), reads up to 60, articles first, and proposes at most one exact edit per page linking it to the seller's agent storefront. One run at a time per seller, ten minutes between starts and six a day: a refused start answers 429 with Retry-After. `pages` declares up to ten pages that are always read; a run without them reuses the last run's.



## OpenAPI

````yaml https://api.zeroclick.io/openapi.json post /v1/sellers/{sellerId}/links/runs
openapi: 3.0.0
info:
  title: ZeroClick API
  description: >-
    REST API for managing ZeroClick sellers, services, pricing, usage, and
    analytics. Authenticate with an API key from the ZeroClick dashboard.
  version: 1.0.0
servers:
  - url: https://api.zeroclick.io
security:
  - bearerAuth: []
tags:
  - name: API keys
  - name: Sellers
  - name: Services
  - name: Meters
  - name: Plans
  - name: Plan meter prices
  - name: Usage
  - name: Analytics
  - name: Agentify
  - name: Stripe Connect
  - name: Sandbox
  - name: Organizations
  - name: Users
paths:
  /v1/sellers/{sellerId}/links/runs:
    post:
      tags:
        - Sellers
      summary: Start a website links run
      description: >-
        Starts a link suggestions run over the seller's own pages: it finds them
        (the pages declared here or last time, the Discovery page's checked
        pages, sitemaps on every content host, the usual blog places, a bounded
        crawl), reads up to 60, articles first, and proposes at most one exact
        edit per page linking it to the seller's agent storefront. One run at a
        time per seller, ten minutes between starts and six a day: a refused
        start answers 429 with Retry-After. `pages` declares up to ten pages
        that are always read; a run without them reuses the last run's.
      parameters:
        - schema:
            type: string
            minLength: 1
          in: path
          name: sellerId
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                pages:
                  maxItems: 10
                  type: array
                  items:
                    type: string
                    format: uri
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  run:
                    type: object
                    properties:
                      id:
                        type: string
                      status:
                        type: string
                        enum:
                          - queued
                          - running
                          - done
                          - failed
                          - cancelled
                      createdAt:
                        type: string
                      startedAt:
                        nullable: true
                        type: string
                      finishedAt:
                        nullable: true
                        type: string
                      coreVersion:
                        type: string
                      judgeModel:
                        type: string
                      writerModel:
                        nullable: true
                        type: string
                      seeds:
                        type: array
                        items:
                          type: string
                      stats:
                        nullable: true
                        type: object
                        properties:
                          discovered:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          selected:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          read:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          proposed:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          alreadyLinked:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          linkStorefront:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          noDestination:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          noPlacement:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          duplicates:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          skipped:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          failed:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          carried:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          applied:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          kinds:
                            type: object
                            properties:
                              article:
                                type: object
                                properties:
                                  found:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  read:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                required:
                                  - found
                                  - read
                                additionalProperties: false
                              docs:
                                type: object
                                properties:
                                  found:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  read:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                required:
                                  - found
                                  - read
                                additionalProperties: false
                              marketing:
                                type: object
                                properties:
                                  found:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  read:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                required:
                                  - found
                                  - read
                                additionalProperties: false
                              never:
                                type: object
                                properties:
                                  found:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  read:
                                    type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                required:
                                  - found
                                  - read
                                additionalProperties: false
                            required:
                              - article
                              - docs
                              - marketing
                              - never
                            additionalProperties: false
                          sources:
                            type: object
                            properties:
                              declared:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              sitemaps:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              probes:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              crawl:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                            required:
                              - declared
                              - sitemaps
                              - probes
                              - crawl
                            additionalProperties: false
                          judgeCalls:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          writerCalls:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          inputTokens:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          outputTokens:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          edits:
                            type: object
                            properties:
                              linkPhrase:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              addSentence:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                              fixed:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                            required:
                              - linkPhrase
                              - addSentence
                              - fixed
                            additionalProperties: false
                          firstResultMs:
                            nullable: true
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          ms:
                            type: integer
                            minimum: -9007199254740991
                            maximum: 9007199254740991
                          timedOut:
                            type: boolean
                        required:
                          - discovered
                          - selected
                          - read
                          - proposed
                          - alreadyLinked
                          - noDestination
                          - noPlacement
                          - duplicates
                          - skipped
                          - failed
                          - carried
                          - applied
                          - kinds
                          - sources
                          - judgeCalls
                          - writerCalls
                          - inputTokens
                          - outputTokens
                          - edits
                          - firstResultMs
                          - ms
                          - timedOut
                        additionalProperties: false
                      error:
                        nullable: true
                        type: string
                    required:
                      - id
                      - status
                      - createdAt
                      - startedAt
                      - finishedAt
                      - coreVersion
                      - judgeModel
                      - writerModel
                      - seeds
                      - stats
                      - error
                    additionalProperties: false
                required:
                  - run
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                  - error
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - organization_required
                      - feature_not_enabled
                      - seller_not_found
                      - run_not_found
                      - run_finished
                      - suggestion_not_found
                      - suggestion_applied
                      - ai_not_configured
                      - website_required
                  note:
                    type: string
                required:
                  - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - organization_required
                      - feature_not_enabled
                      - seller_not_found
                      - run_not_found
                      - run_finished
                      - suggestion_not_found
                      - suggestion_applied
                      - ai_not_configured
                      - website_required
                  note:
                    type: string
                required:
                  - error
                additionalProperties: false
        '409':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - organization_required
                      - feature_not_enabled
                      - seller_not_found
                      - run_not_found
                      - run_finished
                      - suggestion_not_found
                      - suggestion_applied
                      - ai_not_configured
                      - website_required
                  note:
                    type: string
                required:
                  - error
                additionalProperties: false
        '429':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - links_run_refused
                  reason:
                    type: string
                    enum:
                      - in_flight
                      - cooldown
                      - daily_cap
                  retryAfterSeconds:
                    type: number
                required:
                  - error
                  - reason
                  - retryAfterSeconds
                additionalProperties: false
        '503':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    enum:
                      - organization_required
                      - feature_not_enabled
                      - seller_not_found
                      - run_not_found
                      - run_finished
                      - suggestion_not_found
                      - suggestion_applied
                      - ai_not_configured
                      - website_required
                  note:
                    type: string
                required:
                  - error
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key created in the ZeroClick dashboard under Settings → API keys.
        Keys start with `zc_`. Send them as `Authorization: Bearer zc_...`.

````

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