Preview create site

POST/v1/api/sites/preview

Step 1 of 2. The response carries a one-use confirmation_token for the next step. Create site →

Preview a new site before you create it. The response carries the one-use confirmation_token that Create site needs.

Scope: sites:write
Token: OAuth access token only
Role: Editor, owner or admin
MCP tool: preview_create_site · preview: MCP write tools are in preview; What scopes, tokens and roles mean →

Request

curl -X POST "https://api.crawle.io/v1/api/sites/preview" \
  -H "Authorization: Bearer $CRAWLE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain":"example.com"}'

const response = await fetch("https://api.crawle.io/v1/api/sites/preview", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CRAWLE_ACCESS_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "domain": "example.com"
  }),
});
const data = await response.json();

import os

import requests

response = requests.request(
    "POST",
    "https://api.crawle.io/v1/api/sites/preview",
    headers={
        "Authorization": f"Bearer {os.environ['CRAWLE_ACCESS_TOKEN']}",
    },
    json={
      "domain": "example.com"
    },
)
data = response.json()

$CRAWLE_ACCESS_TOKEN: is an OAuth access token from your integration's sign-in.

Response 200: a JSON object. Its fields are not described in the API contract yet, so no example is shown.

Request body

domainstringrequired: 3–255 characters
client_group_idstring (uuid) or null
crawl_regionstring or null
custom_headersobject or null
custom_robots_txtstring or null
custom_user_agentstring or null
project_namestring or null: up to 255 characters
robots_policystring or null
scope_modestring or null
sitemap_urlstring or null: up to 2048 characters
tag_idsarray of string (uuid) or null
url_budgetinteger: 0–500000 · default 0
user_agentstring or null

Response 200

Returns a JSON object. Its fields are not described in the API contract yet.

Errors

401
When
Missing, invalid, or expired token.
403
When
The token has none of the accepted scopes (sites:write).
403
When
Called with an API key. This endpoint needs an OAuth access token.
403
When
The person's workspace role is below editor.
422
When
The request did not match the schema. detail lists each problem.
429
When
Rate limited. Wait for Retry-After seconds.

Preview create site: errors
Status	When
401	Missing, invalid, or expired token.
403	The token has none of the accepted scopes (`sites:write`).
403	Called with an API key. This endpoint needs an OAuth access token.
403	The person's workspace role is below editor.
422	The request did not match the schema. `detail` lists each problem.
429	Rate limited. Wait for `Retry-After` seconds.

All errors and what to do →

Generated from the API contract at 7e7039b0b, synced October 30, 2026.