---
title: "Start Scan"
method: POST
path: "/chat/workspace-scans"
tags: ["workspace scans"]
---

# Start Scan

`POST /chat/workspace-scans`

## Request body

- StartWorkspaceScanRequest
  - `integration_id` string, uuid, required

## Response `200`

Successful Response

- WorkspaceScanResponse
  - `scan` APIApiSchemaChatWorkspaceScansChatWorkspaceScan, required
    - `id` string, uuid, required
    - `organization_id` string, uuid, required
    - `integration_id` string, uuid, required
    - `started_by_user_id` string, uuid, required
    - `status` 'pending' | 'running' | 'partial' | 'completed' | 'failed', required
    - `stage` 'resolving_integration' | 'preparing_inventory' | 'selecting_candidates' | 'analyzing' | 'finalizing' | 'ready', required
    - `deadline_at` string, date-time, required
    - `inventory_refreshed_at` string, date-time, nullable, required
    - `progress` WorkspaceScanProgress, required
      - `schema_version` integer, required
      - `channels_discovered` integer, required
      - `channels_eligible` integer, required
      - `channels_enriched` integer, required
    - `error_code` string, nullable, required
    - `error_message` string, nullable, required
    - `revision` integer, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `completed_at` string, date-time, nullable, required
  - `channel_recommendations` ChannelRecommendation[], required
    - `channel_id` string, uuid, required
    - `decision` 'recommend' | 'consider', required
    - `reason` string, required
    - `evidence` string[], required
    - `activity_coverage` 'complete' | 'sampled' | 'stored_only' | 'unavailable' | 'inaccessible' | 'unsupported' | 'rate_limited' | 'failed', required
    - `position` integer, required
  - `pattern_recommendations` PatternRecommendation[], required
    - `conditions` ChannelNameCondition[], required
      - `field` 'channel_name', required
      - `operator` 'contains' | 'starts_with' | 'ends_with' | 'equals' | 'not_equals' | 'does_not_contain', required
      - `value` string, required
    - `decision` 'recommend' | 'consider', required
    - `reason` string, required
    - `evidence` string[], required
    - `mode` 'incident' | 'alerts', required — The kind of channel the agent lives in — its standing mission. Drives the swappable mode block in the system prompt (and, later, the toolset). ``incident`` and ``alerts`` have mode blocks today; ``escalation`` and others land as localized drop-ins (their standing block + tooling) when that work begins.
    - `custom_instruction` string, nullable, required
    - `example_channel_names` string[], required
    - `matching_channel_count` integer, required
    - `position` integer, required
  - `warnings` ScanWarning[], required
    - `code` 'stale_inventory' | 'partial_inventory' | 'missing_authorization' | 'rate_limited', required
    - `message` string, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/traversal/apis/fastapi.md) · [All operations](https://skmtc.dev/traversal/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/traversal/fastapi/revisions/01ca496f3b4f/schema)