PostHog API — visual_review

naftiko: 1.0.0-alpha2
info:
  label: PostHog API — visual_review
  description: 'PostHog API — visual_review. 50 operations. Lead operation: visual_review. Self-contained Naftiko capability
    covering one Posthog business surface.'
  tags:
  - Posthog
  - visual_review
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    POSTHOG_API_KEY: POSTHOG_API_KEY
capability:
  consumes:
  - type: http
    namespace: posthog-visual-review
    baseUri: ''
    description: PostHog API — visual_review business capability. Self-contained, no shared references.
    resources:
    - name: api-projects-project_id-visual_review-repos
      path: /api/projects/{project_id}/visual_review/repos/
      operations:
      - name: visualreviewreposlist
        method: GET
        description: List all projects for the team.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
      - name: visualreviewreposlist
        method: GET
        description: List all projects for the team.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
      - name: visualreviewreposcreate
        method: POST
        description: Create a new repo.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: visualreviewreposcreate
        method: POST
        description: Create a new repo.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-visual_review-repos-id
      path: /api/projects/{project_id}/visual_review/repos/{id}/
      operations:
      - name: visualreviewreposretrieve
        method: GET
        description: Get a repo by ID.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: visualreviewreposretrieve
        method: GET
        description: Get a repo by ID.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: visualreviewrepospartialupdate
        method: PATCH
        description: Update a repo's settings.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: visualreviewrepospartialupdate
        method: PATCH
        description: Update a repo's settings.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-projects-project_id-visual_review-repos-id-baselines
      path: /api/projects/{project_id}/visual_review/repos/{id}/baselines/
      operations:
      - name: visualreviewreposbaselinesretrieve
        method: GET
        description: 'Snapshots overview for a repo: every identifier with a current baseline (latest non-superseded master/main
          run per run_type), plus tolerate counts, active quarantine state, and a 30-day stability sparkline. Capped at 5000
          entries — sets `tr'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: visualreviewreposbaselinesretrieve
        method: GET
        description: 'Snapshots overview for a repo: every identifier with a current baseline (latest non-superseded master/main
          run per run_type), plus tolerate counts, active quarantine state, and a 30-day stability sparkline. Capped at 5000
          entries — sets `tr'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: api-projects-project_id-visual_review-repos-id-quarantine
      path: /api/projects/{project_id}/visual_review/repos/{id}/quarantine/
      operations:
      - name: visualreviewreposquarantinelist
        method: GET
        description: 'List quarantined identifiers. Without filter: active only. With identifier: full history.'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: identifier
          in: query
          type: string
          description: Filter by identifier (returns full history)
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: run_type
          in: query
          type: string
          description: Filter by run type
      - name: visualreviewreposquarantinelist
        method: GET
        description: 'List quarantined identifiers. Without filter: active only. With identifier: full history.'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: identifier
          in: query
          type: string
          description: Filter by identifier (returns full history)
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: run_type
          in: query
          type: string
          description: Filter by run type
    - name: api-projects-project_id-visual_review-repos-id-quarantine-run_type
      path: /api/projects/{project_id}/visual_review/repos/{id}/quarantine/{run_type}/
      operations:
      - name: visualreviewreposquarantinecreate
        method: POST
        description: Quarantine a snapshot identifier for a specific run type.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: run_type
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: visualreviewreposquarantinecreate
        method: POST
        description: Quarantine a snapshot identifier for a specific run type.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: run_type
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-visual_review-repos-id-quarantine-run_type-expire
      path: /api/projects/{project_id}/visual_review/repos/{id}/quarantine/{run_type}/expire/
      operations:
      - name: visualreviewreposquarantineexpirecreate
        method: POST
        description: Expire all active quarantine entries for an identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: run_type
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: visualreviewreposquarantineexpirecreate
        method: POST
        description: Expire all active quarantine entries for an identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: run_type
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-visual_review-repos-id-thumbnails-identifier
      path: /api/projects/{project_id}/visual_review/repos/{id}/thumbnails/{identifier}/
      operations:
      - name: visualreviewreposthumbnailsretrieve
        method: GET
        description: Serve a snapshot thumbnail by identifier. Returns WebP with ETag caching.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: identifier
          in: path
          type: string
          required: true
      - name: visualreviewreposthumbnailsretrieve
        method: GET
        description: Serve a snapshot thumbnail by identifier. Returns WebP with ETag caching.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: identifier
          in: path
          type: string
          required: true
    - name: api-projects-project_id-visual_review-repos-repo_id-runs
      path: /api/projects/{project_id}/visual_review/repos/{repo_id}/runs/
      operations:
      - name: visualreviewreposrunslist
        method: GET
        description: List runs in this repo, optionally filtered by review state.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: repo_id
          in: path
          type: string
          required: true
        - name: review_state
          in: query
          type: string
          description: Filter by review state
      - name: visualreviewreposrunslist
        method: GET
        description: List runs in this repo, optionally filtered by review state.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: repo_id
          in: path
          type: string
          required: true
        - name: review_state
          in: query
          type: string
          description: Filter by review state
    - name: api-projects-project_id-visual_review-repos-repo_id-runs-counts
      path: /api/projects/{project_id}/visual_review/repos/{repo_id}/runs/counts/
      operations:
      - name: visualreviewreposrunscountsretrieve
        method: GET
        description: Review state counts for runs in this repo.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: repo_id
          in: path
          type: string
          required: true
      - name: visualreviewreposrunscountsretrieve
        method: GET
        description: Review state counts for runs in this repo.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: repo_id
          in: path
          type: string
          required: true
    - name: api-projects-project_id-visual_review-repos-repo_id-snapshots-run_type-identifie
      path: /api/projects/{project_id}/visual_review/repos/{repo_id}/snapshots/{run_type}/{identifier}/
      operations:
      - name: visualreviewrepossnapshotslist
        method: GET
        description: Deduped baseline timeline for a snapshot identity. Newest first.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: identifier
          in: path
          type: string
          description: Snapshot identifier; clients must percent-encode before sending
          required: true
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: repo_id
          in: path
          type: string
          required: true
        - name: run_type
          in: path
          type: string
          description: Run type (storybook, playwright)
          required: true
      - name: visualreviewrepossnapshotslist
        method: GET
        description: Deduped baseline timeline for a snapshot identity. Newest first.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: identifier
          in: path
          type: string
          description: Snapshot identifier; clients must percent-encode before sending
          required: true
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: repo_id
          in: path
          type: string
          required: true
        - name: run_type
          in: path
          type: string
          description: Run type (storybook, playwright)
          required: true
    - name: api-projects-project_id-visual_review-runs
      path: /api/projects/{project_id}/visual_review/runs/
      operations:
      - name: visualreviewrunslist
        method: GET
        description: List runs for the team, optionally filtered by review state, PR number, commit SHA, or branch.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: branch
          in: query
          type: string
          description: Filter by branch name
        - name: commit_sha
          in: query
          type: string
          description: Filter by full commit SHA
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: pr_number
          in: query
          type: integer
          description: Filter by GitHub PR number
        - name: review_state
          in: query
          type: string
          description: Filter by review state
      - name: visualreviewrunslist
        method: GET
        description: List runs for the team, optionally filtered by review state, PR number, commit SHA, or branch.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: branch
          in: query
          type: string
          description: Filter by branch name
        - name: commit_sha
          in: query
          type: string
          description: Filter by full commit SHA
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
        - name: pr_number
          in: query
          type: integer
          description: Filter by GitHub PR number
        - name: review_state
          in: query
          type: string
          description: Filter by review state
      - name: visualreviewrunscreate
        method: POST
        description: Create a new run from a CI manifest.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: visualreviewrunscreate
        method: POST
        description: Create a new run from a CI manifest.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-visual_review-runs-counts
      path: /api/projects/{project_id}/visual_review/runs/counts/
      operations:
      - name: visualreviewrunscountsretrieve
        method: GET
        description: Review state counts for the runs list.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: visualreviewrunscountsretrieve
        method: GET
        description: Review state counts for the runs list.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-projects-project_id-visual_review-runs-id
      path: /api/projects/{project_id}/visual_review/runs/{id}/
      operations:
      - name: visualreviewrunsretrieve
        method: GET
        description: Get run status and summary.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: visualreviewrunsretrieve
        method: GET
        description: Get run status and summary.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: api-projects-project_id-visual_review-runs-id-add-snapshots
      path: /api/projects/{project_id}/visual_review/runs/{id}/add-snapshots/
      operations:
      - name: visualreviewrunsaddsnapshotscreate
        method: POST
        description: Add a batch of snapshots to a pending run (shard-based flow).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: visualreviewrunsaddsnapshotscreate
        method: POST
        description: Add a batch of snapshots to a pending run (shard-based flow).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-visual_review-runs-id-approve
      path: /api/projects/{project_id}/visual_review/runs/{id}/approve/
      operations:
      - name: visualreviewrunsapprovecreate
        method: POST
        description: Approve visual changes for snapshots in this run.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: visualreviewrunsapprovecreate
        method: POST
        description: Approve visual changes for snapshots in this run.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-projects-project_id-visual_review-runs-id-auto-approve
      path: /api/projects/{project_id}/visual_review/runs/{id}/auto-approve/
      operations:
      - name: visualreviewrunsautoapprovecreate
        method: POST
        description: 'CLI auto-approve: approve all and return baseline YAML for local write.'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: visualreviewrunsautoapprovecreate
        method: POST
        description: 'CLI auto-approve: approve all and return baseline YAML for local write.'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: api-projects-project_id-visual_review-runs-id-complete
      path: /api/projects/{project_id}/visual_review/runs/{id}/complete/
      operations:
      - name: visualreviewrunscompletecreate
        method: POST
        description: 'Complete a run: detect removals, verify uploads, trigger diff processing.'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: visualreviewrunscompletecreate
        method: POST
        description: 'Complete a run: detect removals, verify uploads, trigger diff processing.'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: api-projects-project_id-visual_review-runs-id-recompute
      path: /api/projects/{project_id}/visual_review/runs/{id}/recompute/
      operations:
      - name: visualreviewrunsrecomputecreate
        method: POST
        description: Re-evaluate quarantine and counts, update commit status, and optionally rerun the CI job.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: visualreviewrunsrecomputecreate
        method: POST
        description: Re-evaluate quarantine and counts, update commit status, and optionally rerun the CI job.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: api-projects-project_id-visual_review-runs-id-snapshot-history
      path: /api/projects/{project_id}/visual_review/runs/{id}/snapshot-history/
      operations:
      - name: visualreviewrunssnapshothistorylist
        method: GET
        description: Recent change history for a snapshot identifier across runs.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: identifier
          in: query
          type: string
          description: Snapshot identifier
          required: true
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
      - name: visualreviewrunssnapshothistorylist
        method: GET
        description: Recent change history for a snapshot identifier across runs.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: identifier
          in: query
          type: string
          description: Snapshot identifier
          required: true
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
    - name: api-projects-project_id-visual_review-runs-id-snapshots
      path: /api/projects/{project_id}/visual_review/runs/{id}/snapshots/
      operations:
      - name: visualreviewrunssnapshotslist
        method: GET
        description: Get all snapshots for a run with diff results.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
      - name: visualreviewrunssnapshotslist
        method: GET
        description: Get all snapshots for a run with diff results.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
    - name: api-projects-project_id-visual_review-runs-id-tolerate
      path: /api/projects/{project_id}/visual_review/runs/{id}/tolerate/
      operations:
      - name: visualreviewrunstoleratecreate
        method: POST
        description: Mark a changed snapshot as a known tolerated alternate.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: visualreviewrunstoleratecreate
        method: POST
        description: Mark a changed snapshot as a known tolerated alternate.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-projects-project_id-visual_review-runs-id-tolerated-hashes
      path: /api/projects/{project_id}/visual_review/runs/{id}/tolerated-hashes/
      operations:
      - name: visualreviewrunstoleratedhasheslist
        method: GET
        description: List known tolerated hashes for a snapshot identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: identifier
          in: query
          type: string
          description: Snapshot identifier
          required: true
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
      - name: visualreviewrunstoleratedhasheslist
        method: GET
        description: List known tolerated hashes for a snapshot identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: identifier
          in: query
          type: string
          description: Snapshot identifier
          required: true
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page.
        - name: offset
          in: query
          type: integer
          description: The initial index from which to return the results.
    authentication:
      type: bearer
      token: '{{env.POSTHOG_API_KEY}}'
  exposes:
  - type: rest
    namespace: posthog-visual-review-rest
    port: 8080
    description: REST adapter for PostHog API — visual_review. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/projects/{project-id}/visual-review/repos
      name: api-projects-project-id-visual-review-repos
      descript

# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/posthog/refs/heads/main/capabilities/posthog-visual-review.yaml