---
title: "Scan a website"
method: POST
path: "/v1/website-scans"
tags: ["Website-Scans"]
---

# Scan a website

`POST /v1/website-scans`

## Request

- Base URL: `https://www.postquick.ai/api`
- URL: `https://www.postquick.ai/api/v1/website-scans`
- Auth: HTTP bearer

Start brand or competitor research using the website-scanner service. Uses the saved website URL if none is supplied. Poll with getScanResult to review the research.

## Request body

- object
  - `contentGroupId` string, uuid
  - `websiteUrl` string
  - `jobType` 'brand_scan' | 'competitive_analysis' | 'full_scan'

## Response `202`

Successful response.

- object
  - `success` true, required
  - `data` object, required
    - `scanId` string, required
    - `status` 'pending', required

## Other responses

- `400`: Invalid input.
- `404`: Not found or not owned.
- `409`: Content changed or cannot be edited in its current state.

---

[API](https://skmtc.dev/postquick/apis/postquickai-api.md) · [All operations](https://skmtc.dev/postquick/apis/postquickai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/postquick/apis/postquickai-api/revisions/d9bc2bcf3042?raw)