Website reads

Read a website

POST/v1/sites/read

Start reading a website for its look and for a brand name and three form ideas, which AI writes from the site's text. The look covers the button color, text and background colors, corner radius and font. It returns a readId right away. Poll GET /v1/sites/reads/{readId} until themeStatus and suggestStatus are no longer reading or waiting. Private and local addresses fail with 400 import_failed, and more than 60 reads an hour that need new ideas fail with 429 rate_limited.

curl -X POST "$AYEFORM_API/v1/sites/read" \
  -H "Authorization: Bearer $AYEFORM_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://luigispizza.com"
  }'

200 Response

{
  "readId": "21p7403edgs4sgfemcv5rhxa9wab0p9c"
}

Body

JSON, with Content-Type: application/json.

urlstringrequired
A website address. A bare host such as example.com gets https:// added.
1–2000 chars
workspaceIdstring
Optional. Your API key already belongs to one workspace.

Response

readIdstringrequired
The read's id. The look is read afresh on every call. The brand name and ideas from a read of the same address in the last 7 days are reused, and suggestStatus is then ready right away. If a read of the same address is still in progress, you get that read.

Errors answer with a status and the error shape.