Import

Inspect a website before importing it

Fetches a few sample pages of the source site and recommends a capture mode for each part of it. It changes nothing and does not need {slug} to exist yet. Run it before an import when you are not sure whether the site builds its content with JavaScript.

post/api/v1/sites/{slug}/import/url/preflight

Request

Base URL: https://api.dotsy.ai
URL: https://api.dotsy.ai/api/v1/sites/{slug}/import/url/preflight
Auth: HTTP bearer

Path parameters

slugstring required

Example:acme-studio

Site slug or site id (UUID). An old slug answers 301/308 and a site id 307 to the canonical slug path.

Request body

sourceUrlstring uri required

The website you plan to import.

samplePathsstring[]

Paths to sample. Default: the home page and the first path segment of sourceUrl.

mode'auto' | 'mirror' | 'render'

The capture mode you intend to use. Default auto.

Example request

{
  "sourceUrl": "https://example.com",
  "samplePaths": [
    "/",
    "/blog/"
  ]
}

Response

The recommendation.

sourceUrlstring required

mode'auto' | 'mirror' | 'render' required

warningsstring[] required

Pages that could not be fetched (preflight_404:/path), automatic switches to render, and framework hints.

Changes

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