Read a client's current website

Reads the home page of an existing website and the pages its menu links to (up to 12) and lists what an import would bring in: pages with their headings, paragraph and picture counts, pages that couldn't be read and why, and the phone, email and logo found. Makes nothing and charges nothing. Public addresses only (http/https, standard ports); 20 reads an hour per key creator.

GET/api/v1/site-imports/preview

Authentication

An API key as Authorization: Bearer or x-api-key. It needs the sites:create scope — make new sites (each adds the wholesale fee to your bill).

sites:createRead onlyMCP tool: read_old_website

Parameters

Named placeholders go in the path; the rest in the query string.

addressstringQuery · required: The site's address, e.g. theirbusiness.com.3 to 500 characters

Response

200 with JSON on success (schema on the right). Errors use the standard envelope.

curl

curl -X GET 'https://websites.workflowcorp.com/api/v1/site-imports/preview?address=oriontire.com' \
  -H "Authorization: Bearer $WEBSITEBUDDY_API_KEY"

Example arguments

{
  "address": "oriontire.com"
}

Response schema

{
  "type": "object",
  "properties": {
    "source": {
      "type": "string"
    },
    "site_title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "found": {
      "type": "object",
      "properties": {
        "phone": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "email": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "logo": {
          "type": "boolean"
        },
        "contact_form": {
          "type": "boolean"
        }
      },
      "required": [
        "phone",
        "email",
        "logo"
      ],
      "additionalProperties": false
    },
    "pages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "source_url": {
            "type": "string"
          },
          "headings": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "paragraphs": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "pictures": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "title",
          "slug",
          "source_url",
          "headings",
          "paragraphs",
          "pictures"
        ],
        "additionalProperties": false
      }
    },
    "picture_count": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    },
    "skipped_pages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "url": {
            "type": "string"
          },
          "reason": {
            "type": "string"
          }
        },
        "required": [
          "url",
          "reason"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "source",
    "site_title",
    "description",
    "found",
    "pages",
    "picture_count",
    "skipped_pages"
  ],
  "additionalProperties": false
}